matflow.ActionEnvironment#

class matflow.ActionEnvironment(environment, scope=None)#

Bases: ActionEnvironment

The environment that an action is enacted within.

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

app

scope

The scope.

environment

The environment document.
Parameters:
app = App(name='MatFlow', version='0.3.0a132')#
environment: str | Dict[str, Any]#

The environment document.

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.

scope: app.ActionScope | None = None#

The scope.

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.