matflow.ElementActionRun#
- class matflow.ElementActionRun(id_, is_pending, element_action, index, data_idx, commands_idx, start_time, end_time, snapshot_start, snapshot_end, submission_idx, success, skip, exit_code, metadata, run_hostname)#
Bases:
ElementActionRun
Methods
- returns:
commands
Get EARs that this EAR depends on.
Get a list of run over all iterations that correspond to this run, optionally including this run.
Get downstream EARs that depend on this EAR.
Get information about locally defined input, sequence, and schema-default values that this EAR depends on.
Get a dict of (optionally a subset of) inputs values for this run.
Get a dict of input values that are to be passed directly to a Python script function.
Get parameter types associated with a given prefix.
Resolve specific resources for this EAR, considering all applicable scopes and template-level resources.
Attributes
Get the changes to the EAR working directory due to the execution of this EAR.
Run index.
Return the state of this EAR.
- Parameters:
id_ (int) –
is_pending (bool) –
index (int) –
data_idx (Dict) –
commands_idx (List[int]) –
start_time (Union[datetime, None]) –
end_time (Union[datetime, None]) –
snapshot_start (Union[Dict, None]) –
snapshot_end (Union[Dict, None]) –
submission_idx (Union[int, None]) –
success (Union[bool, None]) –
skip (bool) –
exit_code (Union[int, None]) –
metadata (Dict) –
run_hostname (Union[str, None]) –
- property action#
- app = App(name='MatFlow', version='0.3.0a129')#
- property commands_idx#
- compose_commands(jobscript, JS_action_idx)#
- property data_idx#
- property dir_diff: DirectorySnapshotDiff#
Get the changes to the EAR working directory due to the execution of this EAR.
- property element#
- property element_action#
- property element_iteration#
- property end_time#
- property exit_code#
- get(path=None, default=None, raise_on_missing=False, raise_on_unset=False)#
- get_EAR_dependencies(as_objects=False)#
Get EARs that this EAR depends on.
- get_all_previous_iteration_runs(include_self=True)#
Get a list of run over all iterations that correspond to this run, optionally including this run.
- Parameters:
include_self (bool) –
- get_dependent_EARs(as_objects=False)#
Get downstream EARs that depend on this EAR.
- Return type:
- get_environment()#
- Return type:
- get_input_dependencies()#
Get information about locally defined input, sequence, and schema-default values that this EAR depends on. Note this does not get values from this EAR’s task/schema, because the aim of this method is to help determine which upstream tasks this EAR depends on.
- get_input_values(inputs=None, label_dict=True)#
Get a dict of (optionally a subset of) inputs values for this run.
- Parameters:
inputs (List[str] | Dict[str, Dict] | None) – If specified, a list of input parameter types to include, or a dict whose keys are input parameter types to include. For schema inputs that have multiple=True, the input type should be labelled. If a dict is passed, and the key “all_iterations` is present and True, the return for that input will be structured to include values for all previous iterations.
label_dict (bool) – If True, arrange the values of schema inputs with multiple=True as a dict whose keys are the labels. If False, labels will be included in the top level keys.
- Return type:
- get_input_values_direct(label_dict=True)#
Get a dict of input values that are to be passed directly to a Python script function.
- Parameters:
label_dict (bool) –
- get_parameter_names(prefix)#
Get parameter types associated with a given prefix.
For inputs, labels are ignored. See Action.get_parameter_names for more information.
- get_parameter_sources(path=None, typ=None, as_strings=False, use_task_index=False)#
- get_resources()#
Resolve specific resources for this EAR, considering all applicable scopes and template-level resources.
- property index#
Run index.
- property input_files#
- property inputs#
- property metadata#
- property output_files#
- property outputs#
- property resources#
- property run_hostname#
- property skip#
- property snapshot_end#
- property snapshot_start#
- property start_time#
- property status#
Return the state of this EAR.
- property submission_idx#
- property success#
- property task#
- property workflow#