hpcflow.sdk.core.imports.ImportParameter#

class hpcflow.sdk.core.imports.ImportParameter(parameter, as_=None, source=None)#

Bases: JSONLike

A parameter to import from another workflow.

Parameters:

  • parameter (Parameter) – The parameter to import from the other workflow.

  • as (str) – The parameter type that should be used to represent the imported parameter in the current workflow.

  • source (Inputsource) – From where in the workflow to retrieve the parameter to import.

  • as_ (Parameter | str | None)

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

import_

workflow

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 import_: Import | None#
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 workflow: Workflow#