dragon.workflows.batch.batch.Function

class Function[source]

Bases: Task

__init__(batch, target: Callable , args: tuple = (), kwargs: dict = {}, reads: list | None = None, writes: list | None = None, name: str | None = None, timeout: float = 1000000000.0) → None [source]

Creates a new function task. Arguments for the function 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 function executes.

Parameters:

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

  • func – The function to associate with the object.

  • *args –

    The arguments for the function.

  • reads (Optional[list ]) – A list of Read objects created by calling Batch.read().

  • writes (Optional[list ]) – A list of Write objects created by calling Batch.write().

  • name (Optional[str ]) – A human-readable name for the task.

Returns:

Returns None.

Return type:

None

Methods

__init__(batch, target[, args, kwargs, ...])

Creates a new function 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, target: Callable , args: tuple = (), kwargs: dict = {}, reads: list | None = None, writes: list | None = None, name: str | None = None, timeout: float = 1000000000.0) → None [source]

Creates a new function task. Arguments for the function 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 function executes.

Parameters:

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

  • func – The function to associate with the object.

  • *args –

    The arguments for the function.

  • reads (Optional[list ]) – A list of Read objects created by calling Batch.read().

  • writes (Optional[list ]) – A list of Write objects created by calling Batch.write().

  • name (Optional[str ]) – A human-readable name for the task.

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.