waft.cli package

class waft.cli.OnExit

Bases: object

Class to manage CLI exit conditions.

last_exc: Exception | None = None

return_code = 0

show_traceback = False

class waft.cli.Systems

Bases: object

Interface to iterate multisystem WAFT connections and instances.

classmethod iterate_sftp() → Iterator[SFTPClient]

Iterate WAFT test system SFTP connections.

classmethod iterate_waft() → Iterator[Waft]

Iterate WAFT test system instances.

system_names: list[str]

waft_instances: list[Waft] = []

waft.cli.callback_systems_defaulted(systems: ~typing.Annotated[list[str], <typer.models.OptionInfo object at 0x7f78599f7e90>] = SystemsDefault.ALL, config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f785a2b2010>] = None)

Execute commands on the systems specified (all, by default).

waft.cli.callback_systems_required(systems: ~typing.Annotated[list[str], <typer.models.OptionInfo object at 0x7f78599f7e90>], config: ~typing.Annotated[~pathlib.Path | None, <typer.models.OptionInfo object at 0x7f785a2b2010>] = None)

Execute commands on the systems specified.

waft.cli.print_error(exc: Exception, preface: str = '')

Display exception as an error printed to the console.

Submodules

• waft.cli.annotations module
  • PlatformChoice
    • PlatformChoice.LINUX
    • PlatformChoice.MACOS
    • PlatformChoice.WINDOWS
  • SystemsDefault
    • SystemsDefault.ALL
    • SystemsDefault.LOCAL
    • SystemsDefault.NONE
  • validate_images()
• waft.cli.config module
  • add_proxy()
  • add_system()
  • create_group()
  • remove_group()
  • remove_proxy()
  • remove_system()
  • show_config()
  • where()
• waft.cli.download module
• waft.cli.download_warp module
  • ArchitectureEnum
    • ArchitectureEnum.arm
    • ArchitectureEnum.intel
  • PlatformEnum
    • PlatformEnum.almalinux
    • PlatformEnum.bookworm
    • PlatformEnum.bullseye
    • PlatformEnum.centos8
    • PlatformEnum.debian11
    • PlatformEnum.debian12
    • PlatformEnum.debian13
    • PlatformEnum.fedora34
    • PlatformEnum.fedora35
    • PlatformEnum.focal
    • PlatformEnum.jammy
    • PlatformEnum.macos
    • PlatformEnum.noble
    • PlatformEnum.rhel
    • PlatformEnum.trixie
    • PlatformEnum.ubuntu20
    • PlatformEnum.ubuntu22
    • PlatformEnum.ubuntu24
    • PlatformEnum.windows
  • ReleaseTrackEnum
    • ReleaseTrackEnum.beta
    • ReleaseTrackEnum.ga
    • ReleaseTrackEnum.nightly
  • client()
  • client_download_path()
  • client_downloads_catalog()
  • client_platform_id()
  • clients()
  • info()
• waft.cli.install module
  • package()
  • python()
  • waft()
  • waft_install_progress()
  • warp()
• waft.cli.keys module
  • WaftPublicKey
    • WaftPublicKey.deploy()
    • WaftPublicKey.disable()
    • WaftPublicKey.generate()
    • WaftPublicKey.load()
  • deploy()
  • disable()
  • generate()
• waft.cli.main module
  • callback()
  • install_completion_patch()
  • launch()
• waft.cli.run module
  • pytest()
• waft.cli.run_allure module
  • AllureReport
    • AllureReport.execute()
• waft.cli.run_pytest module
  • PytestRunner
    • PytestRunner.execute()
    • PytestRunner.failed_tasks
  • StatusBarColumn
    • StatusBarColumn.render()
• waft.cli.sftp module
  • FileTransfer
    • FileTransfer.update()
  • chmod()
  • chown()
  • get()
  • listdir()
  • lstat()
  • mkdir()
  • put()
  • pwd()
  • read()
  • remove()
  • rename()
  • rmdir()
  • stat()
  • symlink()
• waft.cli.show module
  • clients()
  • commands()
  • docs()
  • logs()
  • show()
• waft.cli.ssh module
  • callback()
• waft.cli.system module
  • check()
  • exec()
  • ip()
  • os()
  • restart()
• waft.cli.timing_processing module
  • TimingReport
    • TimingReport.execute()
• waft.cli.update module
  • callback()
• waft.cli.vm module
  • create()
  • delete()
  • destroy()
  • ephemeral_vms()
  • export()
  • images()
  • import_vm()
  • inspect()
  • redeploy()
• waft.cli.waft_sync module
  • run()
  • run_command()
• waft.cli.warp module
  • warp_cli()
  • warp_diag()
  • warp_ver()
• waft.cli.warp_mdm module
  • add()
  • get_configs()
  • names()
  • remove()
  • reset()
  • set()
  • set_config()
  • show()
  • unset()