hpcflow.app.InputFile#
- class hpcflow.app.InputFile(file, path=None, contents=None, extension='', store_contents=True)#
Bases:
InputFile
An input file.
- Parameters:
file (Union[app.FileSpec, str]) – What file is this?
path (Path) – Where is the (original) file?
contents (str) – What is the contents of the file (if already known)?
extension (str) – What is the extension of the file?
store_contents (bool) – Are the file’s contents to be cached in the workflow persistent store?
Methods
Make an instance of this class from JSON (or YAML) data.
Save to a persistent workflow.
Get the actual contents of the file.
Serialize this object as a dictionary.
Serialize this object as an object structure that can be trivially converted to JSON.
Attributes
The contents of the file.
The extension of the file.
Standard name for the file within the workflow.
Full workflow value path to the file.
The path to the file.
Whether the file's contents are stored in the workflow's persistent store.
The owning workflow.
What file is this?
- app = BaseApp(name='hpcFlow', version='0.2.0a181')#
- property contents#
The contents of the file.
- property extension#
The extension of the file.
- file#
What file is this?
- 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.
- make_persistent(workflow, source)#
Save to a persistent workflow.
- property normalised_files_path#
Standard name for the file within the workflow.
- property normalised_path#
Full workflow value path to the file.
Note
This is not the same as the path in the filesystem.
- property path#
The path to the file.
- read_contents()#
Get the actual contents of the file.
- property store_contents#
Whether the file’s contents are stored in the workflow’s persistent store.
- 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.