srunx.ssh package

Subpackages

• srunx.ssh.cli package
  • Submodules
  • srunx.ssh.cli.commands module
    • setup_logging()
    • send_slack_notification()
    • submit_job()
    • show_logs()
    • test_connection()
    • sync_mount()
    • ssh_main()
    • list_profiles()
    • add_profile()
    • remove_profile()
    • set_current_profile()
    • show_profile()
    • update_profile()
    • set_env_var()
    • unset_env_var()
    • list_env_vars()
    • mount_add()
    • mount_list()
    • mount_remove()
  • srunx.ssh.cli.main module
    • show_ssh_help()
    • run_from_argv()
  • srunx.ssh.cli.profile module
    • handle_profile_command()
    • cmd_add()
    • cmd_remove()
    • cmd_list()
    • cmd_set()
    • cmd_show()
    • cmd_update()
    • cmd_env()
    • cmd_env_set()
    • cmd_env_unset()
    • cmd_env_list()
  • srunx.ssh.cli.profile_impl module
    • list_profiles_impl()
    • add_profile_impl()
    • remove_profile_impl()
    • set_current_profile_impl()
    • show_profile_impl()
    • update_profile_impl()
    • set_env_var_impl()
    • unset_env_var_impl()
    • list_env_vars_impl()
    • add_mount_impl()
    • list_mounts_impl()
    • remove_mount_impl()
  • srunx.ssh.cli.submit module
    • send_slack_notification()
    • setup_logging()
    • run_from_argv()
  • srunx.ssh.cli.test module
    • handle_test_command()
  • Module contents
• srunx.ssh.core package
  • Submodules
  • srunx.ssh.core.client module
    • SlurmJob
      • SlurmJob.job_id
      • SlurmJob.name
      • SlurmJob.status
      • SlurmJob.output_file
      • SlurmJob.error_file
      • SlurmJob.script_path
      • SlurmJob.is_local_script
      • SlurmJob.__init__()
    • SSHSlurmClient
      • SSHSlurmClient.__init__()
      • SSHSlurmClient.connect()
      • SSHSlurmClient.disconnect()
      • SSHSlurmClient.test_connection()
      • SSHSlurmClient.execute_command()
      • SSHSlurmClient.upload_file()
      • SSHSlurmClient.cleanup_file()
      • SSHSlurmClient.file_exists()
      • SSHSlurmClient.validate_remote_script()
      • SSHSlurmClient.submit_sbatch_job()
      • SSHSlurmClient.submit_sbatch_file()
      • SSHSlurmClient.cleanup_job_files()
      • SSHSlurmClient.sync_project()
      • SSHSlurmClient.get_job_status()
      • SSHSlurmClient.get_job_output()
      • SSHSlurmClient.get_job_output_detailed()
      • SSHSlurmClient.monitor_job()
      • SSHSlurmClient.tail_log()
  • srunx.ssh.core.config module
    • MountConfig
      • MountConfig.name
      • MountConfig.local
      • MountConfig.remote
      • MountConfig.exclude_patterns
      • MountConfig.expand_and_validate_paths()
      • MountConfig.model_config
    • ServerProfile
      • ServerProfile.hostname
      • ServerProfile.username
      • ServerProfile.key_filename
      • ServerProfile.port
      • ServerProfile.description
      • ServerProfile.ssh_host
      • ServerProfile.proxy_jump
      • ServerProfile.env_vars
      • ServerProfile.mounts
      • ServerProfile.model_config
    • ConfigManager
      • ConfigManager.__init__()
      • ConfigManager.load_config()
      • ConfigManager.save_config()
      • ConfigManager.add_profile()
      • ConfigManager.remove_profile()
      • ConfigManager.get_profile()
      • ConfigManager.list_profiles()
      • ConfigManager.set_current_profile()
      • ConfigManager.get_current_profile()
      • ConfigManager.get_current_profile_name()
      • ConfigManager.update_profile()
      • ConfigManager.expand_path()
      • ConfigManager.set_profile_env_var()
      • ConfigManager.unset_profile_env_var()
      • ConfigManager.add_profile_mount()
      • ConfigManager.remove_profile_mount()
  • srunx.ssh.core.proxy_client module
    • ProxySSHClient
      • ProxySSHClient.__init__()
      • ProxySSHClient.create_proxy_connection()
      • ProxySSHClient.close_proxy()
      • ProxySSHClient.connect_through_proxy()
    • create_proxy_aware_connection()
  • srunx.ssh.core.ssh_config module
    • SSHHost
      • SSHHost.hostname
      • SSHHost.user
      • SSHHost.port
      • SSHHost.identity_file
      • SSHHost.proxy_command
      • SSHHost.proxy_jump
      • SSHHost.forward_agent
      • SSHHost.effective_identity_file()
      • SSHHost.model_config
    • SSHConfigParser
      • SSHConfigParser.__init__()
      • SSHConfigParser.get_host()
      • SSHConfigParser.list_hosts()
      • SSHConfigParser.find_identity_files()
    • get_ssh_config_host()
  • Module contents
• srunx.ssh.helpers package
  • Submodules
  • srunx.ssh.helpers.proxy_helper module
    • suggest_port_forwarding()
    • check_connectivity()
    • main()
  • Module contents

Submodules

srunx.ssh.example module

srunx.ssh.example.main()

Module contents

class srunx.ssh.SSHSlurmClient(hostname, username, password=None, key_filename=None, port=22, proxy_jump=None, ssh_config_path=None, env_vars=None, verbose=False)

Bases: object

__init__(hostname, username, password=None, key_filename=None, port=22, proxy_jump=None, ssh_config_path=None, env_vars=None, verbose=False)

cleanup_file(remote_path)

Remove a file from the server

Return type:

None

cleanup_job_files(job)

Cleanup temporary files for a job if it was a local script

Return type:

None

connect()

Return type:

bool

disconnect()

execute_command(command)

Return type:

tuple[str, str, int]

file_exists(remote_path)

Check if a file exists on the server

Return type:

bool

get_job_output(job_id, job_name=None, stdout_offset=0, stderr_offset=0)

Get job output from SLURM log files.

First tries scontrol show job to discover the actual StdOut/StdErr paths configured for the job. Falls back to pattern-based search if scontrol doesn’t return usable paths.

When stdout_offset / stderr_offset are non-zero, only the bytes after that position are returned (tail-like incremental reads).

Return type:

tuple[str, str, int, int]

Returns:

(stdout, stderr, new_stdout_offset, new_stderr_offset)

get_job_output_detailed(job_id, job_name=None)

Get detailed job output information including found log files

Return type:

dict[str, str | list[str] | None]

get_job_status(job_id)

Get job status using SLURM commands

Return type:

str

monitor_job(job, poll_interval=10, timeout=None)

Monitor a job until completion

Return type:

SlurmJob

submit_sbatch_file(script_path, job_name=None, cleanup=True)

Submit an sbatch job from a local or remote file

Return type:

SlurmJob | None

submit_sbatch_job(script_content, job_name=None, dependency=None)

Submit an sbatch job with script content

Return type:

SlurmJob | None

sync_project(local_path=None, remote_path=None, *, delete=True, dry_run=False, exclude_patterns=None)

Sync the local project directory to the remote workspace via rsync.

Parameters:

• local_path (str | None) – Local project root to sync. If None, uses git toplevel or cwd.

• remote_path (str | None) – Remote destination. If None, uses the default ~/.config/srunx/workspace/{repo_name}/.

• delete (bool) – Remove remote files not present locally (default True).

• dry_run (bool) – Preview what would be transferred without syncing.

• exclude_patterns (list[str] | None) – Additional exclude patterns for this sync.

Return type:

str

Returns:

The remote project path (for use with sbatch --chdir).

Raises:

RuntimeError – If rsync is not available or key-based auth is not configured.

tail_log(job_id, job_name=None, follow=False, last_n=None, poll_interval=1.0)

Display job logs with optional real-time streaming via SSH.

Parameters:

• job_id (str) – SLURM job ID

• job_name (str | None) – Job name for better log file detection

• follow (bool) – If True, continuously stream new log lines (like tail -f)

• last_n (int | None) – Show only the last N lines

• poll_interval (float) – Polling interval in seconds for follow mode

Returns:

• success: Whether log retrieval was successful

• log_content: Log content (empty in follow mode)

• tail_command: Command to execute for follow mode (None in static mode)

• status_message: Status or error message

• log_file: Path to the primary log file

Return type:

Dictionary with log information

test_connection()

Test SSH connection and SLURM availability.

Returns:

• ssh_connected: Whether SSH connection succeeded

• slurm_available: Whether SLURM commands are available

• hostname: Remote hostname

• user: Remote username

• slurm_version: SLURM version if available

• error: Error message if connection failed

Return type:

Dictionary with test results including

upload_file(local_path, remote_path=None)

Upload a local file to the server and return the remote path

Return type:

str

validate_remote_script(remote_path)

Validate a remote script file and return (is_valid, error_message)

Return type:

tuple[bool, str]

class srunx.ssh.SlurmJob(job_id, name, status='UNKNOWN', output_file=None, error_file=None, script_path=None, is_local_script=False, _cleanup=False)

Bases: object

__init__(job_id, name, status='UNKNOWN', output_file=None, error_file=None, script_path=None, is_local_script=False, _cleanup=False)

error_file: str | None = None

is_local_script: bool = False

output_file: str | None = None

script_path: str | None = None

status: str = 'UNKNOWN'

job_id: str

name: str