File: toilAPIJobFunctions.rst

package info (click to toggle)
toil 9.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,908 kB
  • sloc: python: 58,029; makefile: 313; sh: 168
file content (42 lines) | stat: -rw-r--r-- 892 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.. _api-jobfunctions:

Toil Job API
************

Functions to wrap jobs and return values (promises).

FunctionWrappingJob
-------------------
The subclass of Job for wrapping user functions.

.. autoclass:: toil.job::FunctionWrappingJob
   :members:
   :noindex:

JobFunctionWrappingJob
----------------------
The subclass of FunctionWrappingJob for wrapping user job functions.

.. autoclass:: toil.job::JobFunctionWrappingJob
   :members:
   :noindex:

EncapsulatedJob
---------------
The subclass of Job for *encapsulating* a job, allowing a subgraph of jobs to be treated as a single job.

.. autoclass:: toil.job::EncapsulatedJob
   :members:
   :noindex:

Promise
-------
The class used to reference return values of jobs/services not yet run/started.

.. autoclass:: toil.job::Promise
   :members:
   :noindex:

.. autoclass:: toil.job::PromisedRequirement
   :members:
   :noindex: