Remote

Remote

Used to run commands over SSH asynchronously in subprocesses while sharing an SSH connection.

This doesn't work on Windows, as it assumes that the SSH client has SSH multiplexing support (ControlMaster, ControlPath and ControlPersist).

Returned by:

• Reference CLI
  • login
    • get_remote_without_2fa_prompt
    • login
  • sync
    • get_active_remotes
    • get_cluster_to_remote
    • sync

Used by:

• Reference
  • CLI
    • submit
      • get_submissions
      • submit_to_cluster
      • wait_for_first_running_job
      • wait_for_jobs_to_cancel
    • sync
      • clone_project
      • create_results_dir_with_symlink_to_scratch
      • expandvars
      • fetch_results
      • remote_test
      • sync_common_part
      • sync_per_cluster_part
  • Remote list_remote_run_dirs

connect

connect(hostname: str) -> Self

Async 'constructor'.

Using this once explicitly before running lots of commands in parallel can be useful, since otherwise the 2FA prompt might happen for each individual command.

TODO: cache this function's result using an async-compatible version of functools.cache maybe?

get_output

get_output(
    command: str,
    *,
    display: bool = False,
    warn: bool = False,
    hide: Hide = True,
) -> str

Runs the command asynchronously and returns the stripped output string.

list_remote_run_dirs

list_remote_run_dirs(
    remote: Remote, path: PurePosixPath
) -> list[tuple[str, datetime]]

Lists the immediate subdirectories of path on the remote, with their mtimes.

Returns an empty list if path doesn't exist on the remote (rather than raising).

run

run(
    program_and_args: tuple[str, ...],
    input: str | None = None,
    warn: bool = False,
    hide: Hide = False,
    _stacklevel: int = 2,
    _display: bool | str = False,
) -> CompletedProcess[str]

Runs the command asynchronously in a subprocess and returns the result.

Parameters

program_and_args: The program and arguments to pass to it. This is a tuple of strings, same as in subprocess.Popen. input: The optional 'input' argument to subprocess.Popen.communicate(). warn: When True and an exception occurs, warn instead of raising the exception. hide: Controls the printing of the subprocess' stdout and stderr.

Returns

A subprocess.CompletedProcess object with the result of the asyncio.Process.

Raises

subprocess.CalledProcessError If an error occurs when running the command and warn is False.

control_socket_is_running

control_socket_is_running(host: str) -> bool

Asynchronously checks whether the control socket at the given path is running.

get_ssh_options_for_host

get_ssh_options_for_host(hostname: str) -> dict[str, str]

Returns the dictionary of ssh options for a given host (taken from ssh -G <hostname>).