calypso.dispatchers.orchestrator.jobs module

class calypso.dispatchers.orchestrator.jobs.Job(name: str = <factory>, submit_batch: str = 'submit_batch', job_id: int | None = None, status: ~calypso.dispatchers.orchestrator.jobs.JobStatus | int | str = JobStatus.unsubmitted, local_work_dir: str = './', local_root: str = './', upload_files: list[str] = <factory>, upload_share_files: list[str] = <factory>, machine_id: str | None = None, machine_name: str | None = None, remote_root: str | None = None, remote_work_dir: str | None = None, download_files: list[str] = <factory>, remote_running_script: str = '', remote_log_file: str = '', command: str = '', retry: int = 0, max_retry: int = 5, comment: str = 'N')

Bases: object

A dataclass for storing job information.

Parameters:

  • name (str = field(default_factory=lambda: str(uuid.uuid1())))

  • running_id (str | None = None)

  • status (JobStatus = JobStatus.unsubmitted)

  • local_work_dir (str = ".")

  • local_root (str = ".")

  • forward_files (Optional[List[str]] = None)

  • forward_common_files (Optional[List[str]] = None)

  • machine_idx (Optional[int] = None)

  • remote_work_dir (Optional[str] = None)

  • remote_root (Optional[str] = None)

  • backward_files (Optional[List[str]] = None)

  • command (Optional[str] = None)

  • retry (int = 0)

  • max_retry (int = 5)

  • command

init_job_status(name=JobStatus.unsubmitted)
command: str = ''
comment: str = 'N'
download_files: list[str]
job_id: int | None = None
local_root: str = './'
local_work_dir: str = './'
machine_id: str | None = None
machine_name: str | None = None
max_retry: int = 5
name: str
remote_log_file: str = ''
remote_root: str | None = None
remote_running_script: str = ''
remote_work_dir: str | None = None
retry: int = 0
status: JobStatus | int | str = 2
submit_batch: str = 'submit_batch'
upload_files: list[str]
upload_share_files: list[str]
class calypso.dispatchers.orchestrator.jobs.JobStatus(*values)

Bases: Enum

error = 9
failed = 10
finished = 6
queueing = 3
resubmitted = 8
running = 4
stopping = 5
terminated = 1
unknown = 7
unsubmitted = 2