hpcflow.sdk.core.actions.Action

class hpcflow.sdk.core.actions.Action(environments=None, commands=None, script=None, script_data_in=None, script_data_out=None, script_exe=None, abortable=False, input_file_generators=None, output_file_parsers=None, input_files=None, output_files=None, rules=None)

Bases: JSONLike

Methods

expand
from_json_like
generate_data_index	Generate the data index for this action of an element iteration whose overall data index is passed.
get_command_input_file_labels	Get input files types from commands.
get_command_input_types	Get parameter types from commands.
get_command_output_types	Get parameter types from command stdout and stderr arguments.
get_commands_action_env
get_input_file_generator_action_env
get_input_file_labels
get_input_types	Get the input types that are consumed by commands and input file generators of this action.
get_output_file_labels
get_output_file_parser_action_env
get_output_types	Get the output types that are produced by command standard outputs and errors, and by output file parsers of this action.
get_param_dump_file_path_JSON
get_param_dump_file_stem
get_param_load_file_path_HDF5
get_param_load_file_path_JSON
get_param_load_file_stem
get_parameter_dependence	Find if/where a given parameter is used by the action.
get_possible_scopes	Get the action scopes that are inclusive of this action, ordered by decreasing specificity.
get_precise_scope
get_resolved_action_env
get_script_name	Return the script name.
get_snippet_script_path
get_snippet_script_str
is_input_type_required
is_snippet_script	Returns True if the provided script string represents a script snippets that is to be modified before execution (e.g.
test_rules	Test all rules against the specified element iteration.
to_dict
to_json_like

Attributes

task_schema

Parameters:

• environments (Optional[List[app.ActionEnvironment]]) –

• commands (Optional[List[app.Command]]) –

• script (Optional[str]) –

• script_data_in (Optional[str]) –

• script_data_out (Optional[str]) –

• script_exe (Optional[str]) –

• abortable (Optional[bool]) –

• input_file_generators (Optional[List[app.InputFileGenerator]]) –

• output_file_parsers (Optional[List[app.OutputFileParser]]) –

• input_files (Optional[List[app.FileSpec]]) –

• output_files (Optional[List[app.FileSpec]]) –

• rules (Optional[List[app.ActionRule]]) –

expand()

classmethod from_json_like(json_like, shared_data=None)

Parameters:

• json_like (Union[Dict, List]) –

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

generate_data_index(act_idx, EAR_ID, schema_data_idx, all_data_idx, workflow, param_source)

Generate the data index for this action of an element iteration whose overall data index is passed.

This mutates all_data_idx.

Return type:

List[int]

get_command_input_file_labels()

Get input files types from commands.

Return type:

Tuple[str]

get_command_input_types(sub_parameters=False)

Get parameter types from commands.

Parameters:

sub_parameters (bool) – If True, sub-parameters (i.e. dot-delimited parameter types) will be returned untouched. If False (default), only return the root parameter type and disregard the sub-parameter part.

Return type:

Tuple[str]

get_command_output_types()

Get parameter types from command stdout and stderr arguments.

Return type:

Tuple[str]

get_commands_action_env()

get_input_file_generator_action_env(input_file_generator)

Parameters:

input_file_generator (InputFileGenerator) –

get_input_file_labels()

get_input_types(sub_parameters=False)

Get the input types that are consumed by commands and input file generators of this action.

Parameters:

sub_parameters (bool) – If True, sub-parameters (i.e. dot-delimited parameter types) in command line inputs will be returned untouched. If False (default), only return the root parameter type and disregard the sub-parameter part.

Return type:

Tuple[str]

get_output_file_labels()

get_output_file_parser_action_env(output_file_parser)

Parameters:

output_file_parser (OutputFileParser) –

get_output_types()

Get the output types that are produced by command standard outputs and errors, and by output file parsers of this action.

Return type:

Tuple[str]

get_param_dump_file_path_JSON(js_idx, js_act_idx)

Parameters:

• js_idx (int) –

• js_act_idx (int) –

static get_param_dump_file_stem(js_idx, js_act_idx)

Parameters:

• js_idx (int) –

• js_act_idx (int) –

get_param_load_file_path_HDF5(js_idx, js_act_idx)

Parameters:

• js_idx (int) –

• js_act_idx (int) –

get_param_load_file_path_JSON(js_idx, js_act_idx)

Parameters:

• js_idx (int) –

• js_act_idx (int) –

static get_param_load_file_stem(js_idx, js_act_idx)

Parameters:

• js_idx (int) –

• js_act_idx (int) –

get_parameter_dependence(parameter)

Find if/where a given parameter is used by the action.

Parameters:

parameter (SchemaParameter) –

get_possible_scopes()

Get the action scopes that are inclusive of this action, ordered by decreasing specificity.

Return type:

Tuple[ActionScope]

get_precise_scope()

Return type:

ActionScope

get_resolved_action_env(relevant_scopes, input_file_generator=None, output_file_parser=None, commands=None)

Parameters:

• relevant_scopes (Tuple[ActionScopeType]) –

• input_file_generator (InputFileGenerator) –

• output_file_parser (OutputFileParser) –

• commands (List[Command]) –

classmethod get_script_name(script)

Return the script name.

Parameters:

script (str) –

Return type:

str

classmethod get_snippet_script_path(script_path)

Return type:

Path

classmethod get_snippet_script_str(script)

Return type:

str

is_input_type_required(typ, provided_files)

Parameters:

• typ (str) –

• provided_files (List[FileSpec]) –

Return type:

bool

static is_snippet_script(script)

Returns True if the provided script string represents a script snippets that is to be modified before execution (e.g. to receive and provide parameter data).

Parameters:

script (str) –

Return type:

bool

property task_schema

test_rules(element_iter)

Test all rules against the specified element iteration.

Return type:

List[bool]

to_dict()

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