matflow.InputValue#

class matflow.InputValue(parameter, value=None, label=None, value_class_method=None, path=None, _InputValue__check_obj=True)#

Bases: InputValue

Parameters:

  • parameter (Union[app.Parameter, str]) – Parameter whose value is to be specified

  • label (Optional[str]) – Optional identifier to be used where the associated SchemaInput accepts multiple parameters of the specified type. This will be cast to a string.

  • value (Optional[Any]) – The input parameter value.

  • value_class_method (Optional[str]) – A class method that can be invoked with the value attribute as keyword arguments.

  • path (Optional[str]) – Dot-delimited path within the parameter’s nested data structure for which value should be set.

  • _InputValue__check_obj (Optional[bool]) –

Methods

from_json_like

make_persistent

Save value to a persistent workflow.

to_dict

to_json_like

Attributes

app

is_sub_value

True if the value is for a sub part of the parameter (i.e.

labelled_type

normalised_inputs_path

normalised_path

value

workflow

app = App(name='MatFlow', version='0.3.0a129')#
classmethod from_json_like(json_like, shared_data=None)#
property is_sub_value#

True if the value is for a sub part of the parameter (i.e. if path is set). Sub-values are not added to the base parameter data, but are interpreted as single-value sequences.

property labelled_type#
make_persistent(workflow, source)#

Save value to a persistent workflow.

Returns:

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

  • contains the index of the parameter data Zarr group where the data is

  • stored.

Parameters:

  • workflow (Any) –

  • source (Dict) –

Return type:

Tuple[str, List[int], bool]

property normalised_inputs_path#
property normalised_path#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
property value#
property workflow#