hpcflow.sdk.core.task.Parameters

class hpcflow.sdk.core.task.Parameters(task, path, return_element_parameters, raise_on_missing=False, raise_on_unset=False, default=None)

Bases: AppAware

The parameters of a (workflow-bound) task. Iterable.

Parameters:

• task (WorkflowTask) – The task these are the parameters of.

• path (str) – The path to the parameter or parameters.

• return_element_parameters (bool) – Whether to return element parameters.

• raise_on_missing (bool) – Whether to raise an exception on a missing parameter.

• raise_on_unset (bool) – Whether to raise an exception on an unset parameter.

• default (Any | None) – A default value to use when the parameter is absent.

Methods

Attributes

default	A default value to use when the parameter is absent.
raise_on_missing	Whether to raise an exception on a missing parameter.
raise_on_unset	Whether to raise an exception on an unset parameter.
task	The task these are the parameters of.
path	The path to the parameter or parameters.
return_element_parameters	Whether to return element parameters.

default: Any | None = None

A default value to use when the parameter is absent.

path: str

The path to the parameter or parameters.

raise_on_missing: bool = False

Whether to raise an exception on a missing parameter.

raise_on_unset: bool = False

Whether to raise an exception on an unset parameter.

return_element_parameters: bool

Whether to return element parameters.

task: WorkflowTask

The task these are the parameters of.