hpcflow.app.Import

class hpcflow.app.Import(label, workflow, parameters=None)

Bases: Import

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
get_import_parameter_from_type	Return the child import parameter that provides the specified type.
get_parameters	Load parameters from the existing 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.

Parameters:

• label (str)

• workflow (int | str | Path | Workflow)

• parameters (list[ImportParameter] | None)

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.

get_import_parameter_from_type(input_type)

Return the child import parameter that provides the specified type.

Parameters:

input_type (str)

Return type:

ImportParameter

get_parameters(input_type)

Load parameters from the existing workflow.

Parameters:

input_type (str)

Return type:

list[Any]

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]