xqute.defaults

module

xqute.defaults

</>

Default settings and utilities for xqute

Attributes

• DEFAULT_JOB_CMD_WRAPPER_SHELL (str) — The default shell for job wrapper
• DEFAULT_JOB_CMD_WRAPPER_TEMPLATE (str) — The template for job cmd wrapping
• DEFAULT_JOB_ERROR_STRATEGY (str) — The default strategy when there iserror happened
• DEFAULT_JOB_METADIR (Path) — The default meta directory for jobs
• DEFAULT_JOB_NUM_RETRIES (int) — Default number of retries whenDEFAULT_JOB_ERROR_STRATEGY is retry
• DEFAULT_JOB_SUBMISSION_BATCH (int) — Default consumer workers
• DEFAULT_SCHEDULER_FORKS (int) — Default number of job forks for scheduler

Classes

• JobErrorStrategy — The strategy when error happen from jobs</>
• JobStatus — The status of a job</>

class

xqute.defaults.JobErrorStrategy()

</>

The strategy when error happen from jobs

Attributes

• HALT — halt the whole program
• IGNORE — ignore and run next jobs
• RETRY — retry the job

class

xqute.defaults.JobStatus()

</>

The status of a job

Life cycles: ........................queued in scheduler INIT -> QUEUED -> SUBMITTED -> RUNNING -> FINISHED (FAILED) INIT -> QUEUED -> SUBMITTED -> RUNNING -> KILLING -> FINISHED INIT -> QUEUED -> SUBMITTED -> KILLING -> FINISHED INIT -> QUEUED -> (CANELED)

Attributes

• FAILED — When a job is failed
• FINISHED — When a job is finished
• INIT — When a job is initialized
• KILLING — When a job is being killed
• QUEUED — When a job is queued
• RETRYING — When a job is to be retried
• RUNNING — When a job is running
• SUBMITTED — When a job is sumitted

Methods

• get_name(*statuses) (Union) — Get the name of the status</>

classmethod

get_name(*statuses)

</>

Get the name of the status

Parameters

• *statuses (int) — The status values

Returns (Union)

The name of the status if a single status is passed, otherwisea tuple of names