matflow.InputFile#

class matflow.InputFile(file, path=None, contents=None, extension='', store_contents=True)#

Bases: InputFile

Methods

from_json_like

make_persistent

Save to a persistent workflow.

read_contents

to_dict

to_json_like

Attributes

app

contents

extension

normalised_files_path

normalised_path

path

store_contents

workflow

Parameters:

  • file (Union[app.FileSpec, str]) –

  • path (Optional[Union[Path, str]]) –

  • contents (Optional[str]) –

  • extension (Optional[str]) –

  • store_contents (Optional[bool]) –

app = App(name='MatFlow', version='0.3.0a129')#
property contents#
property extension#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:

  • json_like (Union[Dict, List]) –

  • shared_data (Optional[Dict[str, ObjectList]]) –

make_persistent(workflow, source)#

Save to a persistent workflow.

Returns:

  • String is the data path for this task input and integer list

  • contains the indices of the parameter data Zarr groups where the data is

  • stored.

Parameters:
Return type:

Tuple[str, List[int], bool]

property normalised_files_path#
property normalised_path#
property path#
read_contents()#
property store_contents#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
property workflow: Workflow#