matflow.ActionRule#

class matflow.ActionRule(rule=None, check_exists=None, check_missing=None, path=None, condition=None, cast=None, doc=None)#

Bases: ActionRule

Class to represent a rule/condition that must be True if an action is to be included.

Methods

check_exists

check_missing

from_json_like

test

to_dict

to_json_like

Attributes

app

Parameters:
  • rule (Optional[app.Rule]) –

  • check_exists (Optional[str]) –

  • check_missing (Optional[str]) –

  • path (Optional[str]) –

  • condition (Optional[Union[Dict, ConditionLike]]) –

  • cast (Optional[str]) –

  • doc (Optional[str]) –

app = App(name='MatFlow', version='0.3.0a129')#
classmethod check_exists(check_exists)#
classmethod check_missing(check_missing)#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:
  • json_like (Union[Dict, List]) –

  • shared_data (Optional[Dict[str, ObjectList]]) –

test(element_iteration)#
Parameters:

element_iteration (ElementIteration) –

Return type:

bool

to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#