xqute

package

xqute

</>

A job management system for python

module

xqute.utils

</>

Utilities for xqute

Classes

• DuplicateFilter — Filter instances are used to perform arbitrary filtering of LogRecords.</>

Functions

• a_mkdir(path, *args, **kwargs) — Make a directory asyncly</>
• a_read_text(path) (str) — Read the text from a file asyncly</>
• a_write_text(path, content) — Write the text to a file asyncly</>
• asyncify(func) (Callable) — Turn a sync function into a Coroutine, can be used as a decorator</>

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</>

module

xqute.scheduler

</>

The scheduler to schedule jobs

Classes

• Scheduler(forks, prescript, postscript, **kwargs) — The abstract class for scheduler</>

module

xqute.xqute

</>

The xqute module

Classes

• Xqute — The main class of the package</>

module

xqute.job

</>

Job to execute

Classes

• Job(index, cmd, metadir, error_retry, num_retries) — The abstract class for job</>

module

xqute.plugin

</>

Hook specifications for scheduler plugins

Functions

• on_init(xqute) — When xqute is initialized</>
• on_job_failed(scheduler, job) — When the job is failed</>
• on_job_init(scheduler, job) — When the job is initialized</>
• on_job_killed(scheduler, job) — When the job is killed</>
• on_job_killing(scheduler, job) — When the job is being killed</>
• on_job_polling(scheduler, job) — When the system is polling job status</>
• on_job_queued(scheduler, job) — When the job is queued</>
• on_job_started(scheduler, job) — When the job starts to run.</>
• on_job_submitted(scheduler, job) — When the job is submitted</>
• on_job_submitting(scheduler, job) — When the job is to be submitted</>
• on_job_succeeded(scheduler, job) — When the job is succeeded</>
• on_shutdown(xqute, sig) — When xqute is shutting down</>

package

xqute.schedulers

</>

Builtin schedulers

Functions

• get_scheduler(scheduler) (Type) — Get the scheduler class</>