hpcflow.sdk.core.command_files.FileNameSpec#

class hpcflow.sdk.core.command_files.FileNameSpec(name, args=None, is_regex=False)#

The name of a file handled by a workflow, or a pattern that matches multiple files.

Parameters:

name (str) – The name or pattern.
args (list) – Positional arguments to use when formatting the name. Can be omitted if the name does not contain a Python formatting pattern.
is_regex (bool) – If true, the name is used as a regex to search for actual files.

Methods

`from_json_like`	Make an instance of this class from JSON (or YAML) data.
`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.
`value`	Get the template-resolved name of the file (or files matched if the name is a regex pattern).

Attributes

`ext`	The extension of the name or pattern.
`stem`	The stem of the name or pattern.
`name`	The name or pattern.
`args`	Positional arguments to use when formatting the name.
`is_regex`	Whether the name is used as a regex to search for actual files.

classmethod from_json_like(json_like, shared_data=None)#

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

Parameters:

json_like (Union[Dict, List]) – The data to deserialise.
shared_data (Optional[Dict[str, ObjectList]]) – Shared context data.

Return type:

The deserialised object.

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.

value(directory='.')#

Get the template-resolved name of the file (or files matched if the name is a regex pattern).

Parameters:: directory (str) – Where to resolve values with respect to.