hpcflow.sdk.core.parameters.ParameterPath#

class hpcflow.sdk.core.parameters.ParameterPath(path, task=None)#

Bases: JSONLike

Path to a parameter.

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

task

The task in which to look up the parameter.

path

The path to the parameter.

Parameters:
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.

path: Sequence[str | int | float]#

The path to the parameter.

task: app.TaskTemplate | app.TaskSchema | None = None#

The task in which to look up the parameter.

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.