hpcflow.sdk.core.actions.ActionScope#

final 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 (ActionScopeType | str) –

classmethod any()#

Any scope.

Return type:: ActionScope

classmethod from_json_like(json_like, shared_data=None)#

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

Parameters:

json_like (str | Mapping[str, JSONed] | Sequence[Mapping[str, JSONed]] | None) – The data to deserialise.
shared_data (Mapping[str, ObjectList[JSONable]] | None) – Shared context data.

Return type:

The deserialised object.

classmethod input_file_generator(file=None)#

The scope of an input file generator.

Parameters:: file (str | None) –
Return type:: ActionScope

kwargs#: Any provided extra keyword arguments.

classmethod main()#

The main scope.

Return type:: ActionScope

classmethod output_file_parser(output=None)#

The scope of an output file parser.

Parameters:: output (Parameter | str | None) –
Return type:: ActionScope

classmethod processing()#

The processing scope.

Return type:: ActionScope

to_dict()#

Serialize this object as a dictionary.

Return type:: dict[str, Any]

to_json_like(dct=None, shared_data=None, exclude=(), 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.

Parameters:

dct (dict[str, JSONable] | None) –
shared_data (_JSONDeserState) –
exclude (Container[str | None]) –
path (list | None) –

Return type:

tuple[JSONDocument, _JSONDeserState]

to_string()#

Render this action scope as a string.

Return type:: str

typ#: Action scope type.