hpcflow.sdk.core.command_files.FileSpec

class hpcflow.sdk.core.command_files.FileSpec(label, name, _hash_value=None)

Bases: JSONLike

A specification of a file handled by a workflow.

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	The path to a file, optionally resolved with respect to a particular directory.

Attributes

ext	The extension of the file name.
stem	The stem of the file name.
label	Label for this file specification.
name	The name of the file.

Parameters:

• label (str) –

• name (str) –

• _hash_value (str | None) –

property ext

The extension of the file name.

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.

label: str

Label for this file specification.

name: str

The name of the file.

property stem

The stem of the file name.

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.

value(directory='.')

The path to a file, optionally resolved with respect to a particular directory.