hpcflow.app.FileSpec#

class hpcflow.app.FileSpec(label, name, doc='', _hash_value=None)#

Bases: FileSpec

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

`documentation`	Documentation for rendering via Jinja.
`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.
`doc`	Documentation for the file specification.

Parameters:

label (str) –
name (str | FileNameSpec) –
doc (str) –
_hash_value (str | None) –

doc: Final[str]#: Documentation for the file specification.

property documentation: str#: Documentation for rendering via Jinja.

property ext: FileNameExt#: 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 (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.

label: Final[str]#: Label for this file specification.

name: Final[FileNameSpec]#: The name of the file.

property stem: FileNameStem#: The stem of the file name.

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]

value(directory='.')#

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

Parameters:: directory (str) –
Return type:: str