hpcflow.app.FileSpec#
- class hpcflow.app.FileSpec(label, name, _hash_value=None)#
Bases:
FileSpec
A specification of a file handled by a workflow.
Methods
Make an instance of this class from JSON (or YAML) data.
Serialize this object as a dictionary.
Serialize this object as an object structure that can be trivially converted to JSON.
The path to a file, optionally resolved with respect to a particular directory.
Attributes
The extension of the file name.
The stem of the file name.
Label for this file specification.
The name of the file.
- app = BaseApp(name='hpcFlow', version='0.2.0a181')#
- 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.
- 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.