waft.system.clients.local_client.local_client module¶

class waft.system.clients.local_client.local_client.LocalClient(connection_details: ConnectionDetails)¶

LocalClient class is used for interacting with the local environment as if it were a remote server

exec_command(command: list, input: str | list[str] | None = None, retry_handler: RetryHandler | None = None, expected_exit_code: int | None = 0, auto_raise: bool = True, custom_exception: Type[Exception] | None = None, custom_exception_msg: str | None = None, **kwargs) → Result¶: Run a command on the local machine

get_file(remote_file_path: PurePath, local_file_path: Path) → None¶

Get a file. In local run mode this is the same as copying it.

Parameters:

remote_file_path – Presumably the remote file path is the source of the file
local_file_path – The local file path is the destination for the file

Returns: None

send_file(remote_file_path: PurePath, local_file_path: Path) → None¶

Send a file. In local run mode this is the same as copying it.

Parameters:

remote_file_path – Presumably the remote file path is the destination for the file
local_file_path – The local file path is the source of the file

Returns: None

WAFT