toil.worker
¶
Module Contents¶
Classes¶
Subclass of MagicExpando for type-checking purposes. |
Functions¶
|
Returns the next chainable job's JobDescription after the given predecessor |
|
Worker process script, runs a job. |
|
Parse command-line arguments to the worker. |
|
Unpickle and enter all the pickled, base64-encoded context managers in the |
|
Attributes¶
- toil.worker.logger¶
- class toil.worker.StatsDict(*args, **kwargs)[source]¶
Bases:
toil.lib.expando.MagicExpando
Subclass of MagicExpando for type-checking purposes.
- jobs: List[toil.lib.expando.MagicExpando]¶
- toil.worker.nextChainable(predecessor, jobStore, config)[source]¶
Returns the next chainable job’s JobDescription after the given predecessor JobDescription, if one exists, or None if the chain must terminate.
- Parameters:
predecessor (toil.job.JobDescription) – The job to chain from
jobStore (toil.jobStores.abstractJobStore.AbstractJobStore) – The JobStore to fetch JobDescriptions from.
config (toil.common.Config) – The configuration for the current run.
- Return type:
Optional[toil.job.JobDescription]
- toil.worker.workerScript(jobStore, config, jobName, jobStoreID, redirectOutputToLogFile=True)[source]¶
Worker process script, runs a job.
- Parameters:
jobStore (toil.jobStores.abstractJobStore.AbstractJobStore) – The JobStore to fetch JobDescriptions from.
config (toil.common.Config) – The configuration for the current run.
jobName (str) – The “job name” (a user friendly name) of the job to be run
jobStoreID (str) – The job store ID of the job to be run
redirectOutputToLogFile (bool) –
- Return int:
1 if a job failed, or 0 if all jobs succeeded
- Return type:
- toil.worker.parse_args(args)[source]¶
Parse command-line arguments to the worker.
- Parameters:
args (List[str]) –
- Return type:
Any