hpcflow.sdk.core.parameters.SchemaOutput#

class hpcflow.sdk.core.parameters.SchemaOutput(parameter, propagation_mode=ParameterPropagationMode.IMPLICIT)#

Bases: SchemaParameter

A Parameter as outputted from particular task.

Methods

`from_json_like`	Make an instance of this class from JSON (or YAML) data.
`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

`input_or_output`	Whether this is an input or output.
`typ`	The type code of the parameter.
`parameter`	The basic parameter this supplies.
`propagation_mode`	How this output propagates.

Parameters:

parameter (Parameter | str) –
propagation_mode (ParameterPropagationMode) –

classmethod from_json_like(json_like, shared_data=None)#

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

Parameters:

json_like (str | Mapping[str, JSONed] | Sequence[Mapping[str, JSONed]] | None) – The data to deserialise.
shared_data (Mapping[str, ObjectList[JSONable]] | None) – Shared context data.

Return type:

The deserialised object.

property input_or_output: str#: Whether this is an input or output. Always output.

parameter: Parameter#: The basic parameter this supplies.

propagation_mode: ParameterPropagationMode#: How this output propagates.

to_dict()#

Serialize this object as a dictionary.

Return type:: dict[str, Any]

to_json_like(dct=None, shared_data=None, exclude=(), 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.

Parameters:

dct (dict[str, JSONable] | None) –
shared_data (_JSONDeserState) –
exclude (Container[str | None]) –
path (list | None) –

Return type:

tuple[JSONDocument, _JSONDeserState]

property typ: str#: The type code of the parameter.