hpcflow.sdk.core.parameters.AbstractInputValue

class hpcflow.sdk.core.parameters.AbstractInputValue

Bases: JSONLike

Class to represent all sequence-able inputs to a task.

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
make_persistent	Save value to a persistent workflow.
to_dict	Serialize this object as a dictionary.
to_json_like	Serialize this object as an object structure that can be trivially converted to JSON.

Attributes

value	The value itself.
workflow	The workflow containing this input value.

classmethod from_json_like(json_like, shared_data=None)

Make an instance of this class from JSON (or YAML) data.

Parameters:

• json_like (Union[Dict, List]) – The data to deserialise.

• shared_data (Optional[Dict[str, ObjectList]]) – Shared context data.

Return type:

The deserialised object.

make_persistent(workflow, source)

Save value to a persistent workflow.

Returns:

• String is the data path for this task input and single item integer list

• contains the index of the parameter data Zarr group where the data is

• stored.

Parameters:

• workflow (Workflow) –

• source (Dict) –

Return type:

Tuple[str, List[int], bool]

to_dict()

Serialize this object as a dictionary.

to_json_like(dct=None, shared_data=None, exclude=None, path=None)

Serialize this object as an object structure that can be trivially converted to JSON. Note that YAML can also be produced from the result of this method; it just requires a different final serialization step.

property value

The value itself.

property workflow

The workflow containing this input value.