hpcflow.sdk.core.actions.ActionScope

class hpcflow.sdk.core.actions.ActionScope(typ, **kwargs)

Bases: JSONLike

Class to represent the identification of a subset of task schema actions by a filtering process.

Methods

any	Any scope.
from_json_like	Make an instance of this class from JSON (or YAML) data.
input_file_generator	The scope of an input file generator.
main	The main scope.
output_file_parser	The scope of an output file parser.
processing	The processing scope.
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.
to_string	Render this action scope as a string.

Attributes

typ	Action scope type.
kwargs	Any provided extra keyword arguments.

Parameters:

typ (Union[app.ActionScopeType, str]) –

classmethod any()

Any scope.

classmethod from_json_like(json_like, shared_data=None)

Make an instance of this class from JSON (or YAML) data.

Parameters:

• json_like – The data to deserialise.

• shared_data – Shared context data.

Return type:

The deserialised object.

classmethod input_file_generator(file=None)

The scope of an input file generator.

kwargs

Any provided extra keyword arguments.

classmethod main()

The main scope.

classmethod output_file_parser(output=None)

The scope of an output file parser.

classmethod processing()

The processing 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.

to_string()

Render this action scope as a string.

typ

Action scope type.