pysnap package¶
PySnap package.
Subpackages¶
- pysnap.cli package
- pysnap.config package
- pysnap.core package
- Submodules
- pysnap.core.access module
- pysnap.core.appliance module
- pysnap.core.models module
- pysnap.core.service module
normalize_group_name()PySnapServicePySnapService.SNAPSHOT_NAMEPySnapService.DEFAULT_SERIAL_TCP_PORTPySnapService.DEFAULT_START_TIMEOUTPySnapService.DEFAULT_STOP_TIMEOUTPySnapService.DEFAULT_PAUSE_TIMEOUTPySnapService.DEFAULT_SSH_WAIT_TIMEOUTPySnapService.DEFAULT_INTEGRATION_STOP_TIMEOUTPySnapService.STOPPED_STATESPySnapService.STOPPING_STATESPySnapService.PAUSED_STATESPySnapService.ERROR_STATESPySnapService.import_image()PySnapService.run_integration_test()PySnapService.list_groups()PySnapService.list_monitored_vms()PySnapService.get_session_state_label()PySnapService.get_monitor_state_label()PySnapService.prepare_vm_connection()PySnapService.stop_runtime_vm()PySnapService.stop_all_runtime_vms()PySnapService.pause_runtime_vm()PySnapService.resume_runtime_vm()PySnapService.pause_all_runtime_vms()PySnapService.resume_all_runtime_vms()PySnapService.show_vm()PySnapService.plug_vm()PySnapService.set_vm_settings()PySnapService.ssh_target()PySnapService.prepare_ssh_terminal()PySnapService.setup_ssh_key()PySnapService.get_vm_access()PySnapService.clone_vm()PySnapService.register_proto_settings_vm()PySnapService.erase_vm()PySnapService.erase_group()PySnapService.erase_all()PySnapService.erase_clones()PySnapService.is_clone_vm()PySnapService.full_clean()
- pysnap.core.settings module
- pysnap.report package
- Submodules
- pysnap.report.archive module
- pysnap.report.checkfile module
- pysnap.report.compare module
CompareSignalPairResultCompareResultReportFingerprintReportFingerprint.pathReportFingerprint.file_sha256ReportFingerprint.output_sha256ReportFingerprint.macsReportFingerprint.startReportFingerprint.delay_windowsReportFingerprint.ping_timesReportFingerprint.tcpdump_timesReportFingerprint.error_commandsReportFingerprint.cpu_infoReportFingerprint.cpu_model
collect_report_paths()fingerprint_report()compare_pair()compare_fingerprints()compare_reports()
- pysnap.report.control module
- pysnap.report.extract module
- pysnap.report.highlight module
- pysnap.report.matcher module
- pysnap.report.models module
- pysnap.report.player module
- pysnap.report.recording module
- pysnap.report.render module
- pysnap.report.stats module
CommandStatsPasteEventMemberTimeCheckReportStatsReportStats.source_nameReportStats.file_taskReportStats.file_hostReportStats.prompt_identitiesReportStats.start_timeReportStats.end_timeReportStats.durationReportStats.exit_codeReportStats.ttyReportStats.termReportStats.columnsReportStats.linesReportStats.cpu_modelReportStats.hypervisorReportStats.commandsReportStats.unique_commandsReportStats.pause_minReportStats.pause_medianReportStats.pause_maxReportStats.longest_pause_commandReportStats.typing_speedReportStats.backspace_shareReportStats.pastesReportStats.ip_addressesReportStats.mac_addressesReportStats.member_timesReportStats.diagnosticsReportStats.warnings
compute_stats()split_keys()transcript_output_text()parse_cpu_info()
- pysnap.report.viewer module
- pysnap.runtime package
- pysnap.ssh package
- pysnap.terminal package
- Submodules
- pysnap.terminal.clipboard module
- pysnap.terminal.emulator module
- pysnap.terminal.keymap module
- pysnap.terminal.protocol module
- pysnap.terminal.session module
- pysnap.terminal.transport module
- pysnap.vbox package
- Submodules
- pysnap.vbox.client module
RunnerProtocolSubprocessRunnerVBoxManageClientVBoxManageClient.IMPORT_PROGRESS_PATTERNVBoxManageClient.DMI_SYSTEM_VENDOR_KEYVBoxManageClient.DMI_SYSTEM_SKU_KEYVBoxManageClient.LIST_COMMAND_TIMEOUTVBoxManageClient.COM_COUNTVBoxManageClient.DEFAULT_NIC_COUNTSVBoxManageClient.NIC_COUNT_PATTERNVBoxManageClient.COM_RESOURCESVBoxManageClient.list_vms()VBoxManageClient.list_running_vms()VBoxManageClient.get_vm_info()VBoxManageClient.add_ssh_forwarding()VBoxManageClient.get_ssh_forwarding()VBoxManageClient.remove_ssh_forwarding()VBoxManageClient.type_on_console()VBoxManageClient.delete_metadata()VBoxManageClient.get_vm_hardware()VBoxManageClient.apply_vm_hardware()VBoxManageClient.set_dmi_system_sku()VBoxManageClient.get_serial_port_configuration()VBoxManageClient.dry_run_import()VBoxManageClient.import_appliance()VBoxManageClient.get_current_snapshot_name()VBoxManageClient.take_snapshot()VBoxManageClient.clone_linked()VBoxManageClient.start_vm_headless()VBoxManageClient.stop_vm_acpi()VBoxManageClient.pause_vm()VBoxManageClient.resume_vm()VBoxManageClient.get_vm_state()VBoxManageClient.configure_serial_port()VBoxManageClient.configure_internal_networks()VBoxManageClient.set_metadata()VBoxManageClient.configure_dmi_system_information()VBoxManageClient.get_metadata()VBoxManageClient.delete_vm()
- pysnap.vbox.parsers module
Submodules¶
pysnap.docview module¶
Helpers for opening bundled HTML documentation.
- pysnap.docview.documentation_index_path()[source]¶
Return the bundled documentation index page path.
The installed wheel stores compiled HTML files inside
pysnap/docs. During development, PySnap also accepts the Sphinx build directory underdocs/_build/htmlas a fallback.- Returns:
Path to the
index.htmlentry point.- Raises:
PySnapError – If no compiled HTML documentation is available.
- Return type:
Path
- pysnap.docview.open_bundled_documentation(browser=None)[source]¶
Launch a browser that opens the bundled HTML documentation.
- Parameters:
browser (str | None) – Optional browser executable. When omitted,
firefoxis used.- Returns:
Path to the opened documentation index page.
- Raises:
PySnapError – If the documentation or browser executable is unavailable.
- Return type:
Path
pysnap.errors module¶
Custom exceptions used by PySnap.
- exception pysnap.errors.PySnapError[source]¶
Bases:
ExceptionBase exception for application-level failures.
- exception pysnap.errors.CommandExecutionError(command, stdout, stderr)[source]¶
Bases:
PySnapErrorRepresent a failed
VBoxManagecommand execution.- Parameters:
command (list[str])
stdout (str)
stderr (str)
- Return type:
None
- exception pysnap.errors.VMNotFoundError(vm_name)[source]¶
Bases:
PySnapErrorReport that a requested virtual machine does not exist.
- Parameters:
vm_name (str)
- Return type:
None
- exception pysnap.errors.VMDependencyError(subject, dependents)[source]¶
Bases:
PySnapErrorReport that a VM cannot be deleted because dependent clones exist.
- Parameters:
subject (str)
dependents (list[str])
- Return type:
None
- exception pysnap.errors.ReportFormatError[source]¶
Bases:
PySnapErrorReport that a file cannot be read as a
reportsession archive.