hpcflow.app.ParameterPath#
- class hpcflow.app.ParameterPath(path, task=None)#
Bases:
ParameterPath
Path to a parameter.
Methods
Make an instance of this class from JSON (or YAML) data.
Serialize this object as a dictionary.
Serialize this object as an object structure that can be trivially converted to JSON.
Attributes
The task in which to look up the parameter.
The path to the parameter.
- Parameters:
task (Optional[Union[app.TaskTemplate, app.TaskSchema]]) –
- app = BaseApp(name='hpcFlow', version='0.2.0a181')#
- 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.
- 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.