Skip to content

xqute.schedulers.ssh_scheduler.scheduler

module

xqute.schedulers.ssh_scheduler.scheduler

</>

The scheduler to run jobs on SSH

Classes
class

xqute.schedulers.ssh_scheduler.scheduler.SshJob(index, cmd, metadir=PosixPath('.xqute'), error_retry=None, num_retries=None)

</>
Bases
xqute.schedulers.local_scheduler.LocalJob xqute.job.Job

SSH job

Parameters
  • index (int) — The index of the job
  • cmd (str | List[str]) — The command of the job
  • metadir (PathLike, optional) — The meta directory of the Job
  • error_retry (Optional[bool], optional) — Whether we should retry if error happened
  • num_retries (Optional[int], optional) — Total number of retries
Attributes
  • CMD_WRAPPER_SHELL — The shell to run the wrapped script
  • CMD_WRAPPER_TEMPLATE — The template for job wrapping
  • _error_retry — Whether we should retry if error happened
  • _num_retries — Total number of retries
  • _rc — The return code of the job
  • _status — The status of the job
  • _wrapped_cmd — The wrapped cmd, used for job submission
  • cmd — The command
  • hook_done — Mark whether hooks have already been. Since we don't havea trigger for job finished/failed, so we do a polling on it. This is to avoid calling the hooks repeatedly
  • index — The index of the job
  • jid — The jid of the job in scheduler system
  • jid (int | str | none) — Get the jid of the job in scheduler system</>
  • jid_file (Path) — The jid file of the job</>
  • metadir — The metadir of the job
  • rc (int) — The return code of the job</>
  • rc_file (Path) — The rc file of the job</>
  • retry_dir (Path) — The retry directory of the job</>
  • status (int) — Query the status of the job
    If the job is submitted, try to query it from the status file Make sure the status is updated by trap in wrapped script </>
  • status_file (Path) — The status file of the job</>
  • stderr_file (Path) — The stderr file of the job</>
  • stdout_file (Path) — The stdout file of the job</>
  • strcmd (str) — Get the string representation of the command</>
  • trial_count — The count for re-tries
Methods
method

__repr__() → str

</>

repr of the job

method

shebang(scheduler) → str

</>

The shebang of the wrapped script

method

clean(retry=False)

</>

Clean up the meta files

Parameters
  • retry (optional) — Whether clean it for retrying
method

wrapped_script(scheduler)

</>

Get the wrapped script

Parameters
  • scheduler (Scheduler) — The scheduler
Returns (PathLike)

The path of the wrapped script

class

xqute.schedulers.ssh_scheduler.scheduler.SshScheduler(forks, prescript='', postscript='', **kwargs)

</>
Bases
xqute.scheduler.Scheduler

The ssh scheduler

Attributes
  • job_class — The job class
  • name — The name of the scheduler
Parameters
  • forks (int) — Max number of job forks
  • prescript (str, optional) — The script to run before the command
  • postscript (str, optional) — The script to run after the command
  • **kwargs — Other arguments for the scheduler
Classes
Methods
method

submit_job_and_update_status(job)

</>

Submit and update the status

  1. Check if the job is already submitted or running
  2. If not, run the hook
  3. If the hook is not cancelled, clean the job
  4. Submit the job, raising an exception if it fails
  5. If the job is submitted successfully, update the status
  6. If the job fails to submit, update the status and write stderr to the job file
Parameters
  • job (Job) — The job
method

retry_job(job)

</>

Retry a job

Parameters
  • job (Job) — The job
method

kill_job_and_update_status(job)

</>

Kill a job and update its status

Parameters
  • job (Job) — The job
method

polling_jobs(jobs, on, halt_on_error)

</>

Check if all jobs are done or new jobs can submit

Parameters
  • jobs (List) — The list of jobs
  • on (str) — query on status: can_submit or all_done
  • halt_on_error (bool) — Whether we should halt the whole pipeline on error
Returns (bool)

True if yes otherwise False.

method

kill_running_jobs(jobs)

</>

Try to kill all running jobs

Parameters
  • jobs (List) — The list of jobs
method

job_is_submitted_or_running(job)

</>

Check if a job is already submitted or running

Parameters
  • job (Job) — The job
Returns (bool)

True if yes otherwise False.

class

xqute.schedulers.ssh_scheduler.scheduler.SshJob(index, cmd, metadir=PosixPath('.xqute'), error_retry=None, num_retries=None)

</>
Bases
xqute.schedulers.local_scheduler.LocalJob xqute.job.Job

SSH job

Attributes
  • jid (int | str | none) — Get the jid of the job in scheduler system</>
  • jid_file (Path) — The jid file of the job</>
  • rc (int) — The return code of the job</>
  • rc_file (Path) — The rc file of the job</>
  • retry_dir (Path) — The retry directory of the job</>
  • status (int) — Query the status of the job
    If the job is submitted, try to query it from the status file Make sure the status is updated by trap in wrapped script </>
  • status_file (Path) — The status file of the job</>
  • stderr_file (Path) — The stderr file of the job</>
  • stdout_file (Path) — The stdout file of the job</>
  • strcmd (str) — Get the string representation of the command</>
Methods
method
__repr__() → str
</>

repr of the job

method
shebang(scheduler) → str
</>

The shebang of the wrapped script

method
clean(retry=False)
</>

Clean up the meta files

Parameters
  • retry (optional) — Whether clean it for retrying
method
wrapped_script(scheduler)
</>

Get the wrapped script

Parameters
  • scheduler (Scheduler) — The scheduler
Returns (PathLike)

The path of the wrapped script

method

submit_job(job)

</>

Submit a job to SSH

Parameters
  • job (Job) — The job
Returns (str)

The job id

method

kill_job(job)

</>

Kill a job on SSH

Parameters
  • job (Job) — The job
method

job_is_running(job)

</>

Tell if a job is really running, not only the job.jid_file

In case where the jid file is not cleaned when job is done.

Parameters
  • job (Job) — The job
Returns (bool)

True if it is, otherwise False