dragon.workflows.batch.batch.Job

class Job[source]

Bases: Task

__init__(batch, process_templates: list [ProcessTemplate], reads: list | None = None, writes: list | None = None, name: str | None = None, timeout: float = 1000000000.0, pmi: PMIBackend = PMIBackend.CRAY) → None [source]

Creates a new job task. Arguments for a process passed using ProcessTemplate.args that are of type Task will create a dependency for this task on the output of the task specified by the argument. Further, the output of the specified task will be passed in place of the Task argument when the job executes.

Parameters:

  • batch (Batch) – The batch in which this function task will execute.

  • process_templates – List of pairs of the form (nprocs, process_template), where nprocs is the number

of processes to create using the specified template. :type process_templates: list :param reads: A list of Read objects created by calling Batch.read(). :type reads: Optional[list] :param writes: A list of Write objects created by calling Batch.write(). :type writes: Optional[list] :param name: A human-readable name for the task. :type name: Optional[str] :param pmi: The PMI backend to use for launching MPI jobs. Defaults to PMIBackend.CRAY.

Set to PMIBackend.PMIX for systems using PMIx, or None to disable PMI.

Returns:

Returns None.

Return type:

None

Methods

__init__(batch, process_templates[, reads, ...])

Creates a new job task.

cancel([timeout])

Best-effort cancellation request for this task.

get([block, timeout])

Wait for this Task to complete.

get_manager_idx([block, timeout])

Attributes

uid

Provides the unique ID for this task.

weight

Provides the HEFTY weight for this task.
__init__(batch, process_templates: list [ProcessTemplate], reads: list | None = None, writes: list | None = None, name: str | None = None, timeout: float = 1000000000.0, pmi: PMIBackend = PMIBackend.CRAY) → None [source]

Creates a new job task. Arguments for a process passed using ProcessTemplate.args that are of type Task will create a dependency for this task on the output of the task specified by the argument. Further, the output of the specified task will be passed in place of the Task argument when the job executes.

Parameters:

  • batch (Batch) – The batch in which this function task will execute.

  • process_templates – List of pairs of the form (nprocs, process_template), where nprocs is the number

of processes to create using the specified template. :type process_templates: list :param reads: A list of Read objects created by calling Batch.read(). :type reads: Optional[list] :param writes: A list of Write objects created by calling Batch.write(). :type writes: Optional[list] :param name: A human-readable name for the task. :type name: Optional[str] :param pmi: The PMI backend to use for launching MPI jobs. Defaults to PMIBackend.CRAY.

Set to PMIBackend.PMIX for systems using PMIx, or None to disable PMI.

Returns:

Returns None.

Return type:

None

cancel(timeout: float = 1000000000.0) → bool [source]

Best-effort cancellation request for this task.

Returns True when the scheduler accepted the cancellation and the task will complete with TaskCancelledError. Returns False when the task cannot be cancelled or already completed.

get(block: bool = True, timeout: float = 1000000000.0) → None [source]

Wait for this Task to complete. This function returns the task’s result and prints any stdout/stderr output.

Parameters:

  • block (bool ) – If True (the default), block until the result is available or timeout is exceeded. If False, return immediately if the result is available, otherwise raise TaskNotReadyError.

  • timeout (float ) – The timeout for waiting. Defaults to 1e9. Ignored when block is False.

Raises:

TimeoutError – If the specified timeout is exceeded.

:raises TaskNotReadyError: If block is False and the result is not yet available.

Returns:

Returns the result of the task.

Return type:

Any

get_manager_idx(block: bool = True, timeout: float = 1000000000.0) → int [source]
property uid

Provides the unique ID for this task.

property weight

Provides the HEFTY weight for this task.