matflow.InputFileGenerator

class matflow.InputFileGenerator(input_file: 'app.FileSpec', inputs: 'List[app.Parameter]', script: 'str' = None, environment: 'app.Environment' = None, script_pass_env_spec: 'Optional[bool]' = False, abortable: 'Optional[bool]' = False, rules: 'Optional[List[app.ActionRule]]' = None)

Bases: InputFileGenerator

Methods

compose_source	Generate the file contents of this input file generator source.
from_json_like
get_action_rules	Get the rules that allow testing if this input file generator must be run or not for a given element.
to_dict
to_json_like
write_source

Attributes

abortable
app
environment
rules
script
script_pass_env_spec
input_file
inputs

Parameters:

• input_file (FileSpec) –

• inputs (List[Parameter]) –

• script (str) –

• environment (Environment) –

• script_pass_env_spec (bool | None) –

• abortable (bool | None) –

• rules (List[ActionRule] | None) –

abortable: bool | None = False

app = App(name='MatFlow', version='0.3.0a129')

compose_source(snip_path)

Generate the file contents of this input file generator source.

Return type:

str

environment: app.Environment = None

classmethod from_json_like(json_like, shared_data=None)

Parameters:

• json_like (Union[Dict, List]) –

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

get_action_rules()

Get the rules that allow testing if this input file generator must be run or not for a given element.

input_file: app.FileSpec

inputs: List[app.Parameter]

rules: List[app.ActionRule] | None = None

script: str = None

script_pass_env_spec: bool | None = False

to_dict()

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

write_source(action, env_spec)

Parameters:

env_spec (Dict[str, Any]) –