jobflow_remote.remote.host.base module

class jobflow_remote.remote.host.base.BaseHost(sanitize: bool = False)

Bases: MSONable

Base Host class.

Parameters:

sanitize – If True text a string will be prepended and appended to the output of the commands, to ease the parsing and avoid failures due to spurious text coming from the host shell.

abstractmethod close() → bool

abstractmethod connect()

abstractmethod copy(src, dst)

abstractmethod execute(command: str | list[str], workdir: str | Path | None = None, timeout: int | None = None) → tuple[str, str, int]

Execute the given command on the host.

Parameters:

• command (str or list of str) – Command to execute, as a str or list of str

• workdir (str or None) – path where the command will be executed.

• timeout – Timeout for the execution of the commands.

abstractmethod get(src, dst)

property interactive_login: bool

True if the host requires interactive actions upon login. False by default. Subclasses should override the method to customize the value.

abstract property is_connected: bool

abstractmethod listdir(path: str | Path) → list[str]

abstractmethod mkdir(directory: str | Path, recursive: bool = True, exist_ok: bool = True) → bool

Create directory on the host.

abstractmethod put(src, dst)

abstractmethod remove(path: str | Path)

abstractmethod rmtree(path: str | Path, raise_on_error: bool = False) → bool

Recursively delete a directory tree on a host.

This method must be implemented by subclasses of BaseHost. It is intended to remove an entire directory tree, including all files and subdirectories, on the host represented by the subclass.

Parameters:

• path (str or Path) – The path to the directory tree to be removed.

• raise_on_error (bool) – If set to False (default), errors will be ignored, and the method will attempt to continue removing remaining files and directories. Otherwise, any errors encountered during the removal process will raise an exception.

Returns:

True if the directory tree was successfully removed, False otherwise.

Return type:

bool

sanitize_command(cmd: str) → str

Sanitizes a command by adding a prefix and suffix to the command string if sanitization is enabled. The prefix and suffix are the same and are used to mark the parts of the output that should be sanitized. The prefix and suffix are defined by SANITIZE_KEY.

Parameters:

cmd – The command string to be sanitized

Returns:

The sanitized command string

Return type:

str

sanitize_output(output: str) → str

Sanitizes the output of a command by selecting the section between the SANITIZE_KEY strings. If the second instance of the key is not found, the part of the output after the key is returned. If the key is not present, the entire output is returned.

Parameters:

output – The output of the command to be sanitized

Returns:

The sanitized output

Return type:

str

property sanitize_regex: Pattern

Regular expression to sanitize sensitive info in command outputs.

abstractmethod shell(pre_cmd: str | None = None, shell: str = 'bash')

Open a connection to the host and starts the selected shell

Parameters:

• pre_cmd – Any command to be executed before starting the shell

• shell – The name of the shell to start

test() → str | None

abstractmethod write_text_file(filepath, content)

Write content to a file on the host.

exception jobflow_remote.remote.host.base.HostError

Bases: Exception