hpcflow.sdk.core.json_like.BaseJSONLike#

class hpcflow.sdk.core.json_like.BaseJSONLike#

Bases: object

An object that has a serialization as JSON or YAML.

Parameters:

  • _class_namespace (namespace) – Namespace whose attributes include the class definitions that might be referenced (and so require instantiation) in child objects.

  • _shared_data_namespace (namespace) – Namespace whose attributes include the shared data that might be referenced in child objects.

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

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.