hpcflow.app.InputValue#

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

Bases: InputValue

An input value to a task.

Parameters:
  • parameter (Parameter | SchemaInput | str) – Parameter whose value is to be specified.

  • label (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 (Any) – The input parameter value.

  • value_class_method (How to obtain the real value.) – A class method that can be invoked with the value attribute as keyword arguments.

  • path (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 an instance of this class from JSON (or YAML) data.

make_persistent

Save value to a persistent workflow.

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.

Attributes

app

is_sub_value

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

labelled_type

The labelled type of this input value.

normalised_inputs_path

The normalised input path without the inputs. prefix.

normalised_path

The full normalised input path.

value

The value itself.

workflow

The workflow containing this input value.

parameter

Parameter whose value is to be specified.

label

Identifier to be used where the associated SchemaInput accepts multiple parameters of the specified type.

path

Dot-delimited path within the parameter's nested data structure for which value should be set.

value_class_method

A class method that can be invoked with the value attribute as keyword arguments.

app = BaseApp(name='hpcFlow', version='0.2.0a181')#
classmethod from_json_like(json_like, shared_data=None)#

Make an instance of this class from JSON (or YAML) data.

Parameters:
  • json_like – The data to deserialise.

  • shared_data – Shared context data.

Return type:

The deserialised object.

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.

label#

Identifier to be used where the associated SchemaInput accepts multiple parameters of the specified type.

property labelled_type#

The labelled type of this input value.

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#

The normalised input path without the inputs. prefix.

property normalised_path#

The full normalised input path.

parameter#

Parameter whose value is to be specified.

path#

Dot-delimited path within the parameter’s nested data structure for which value should be set.

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.

property value#

The value itself.

value_class_method#

A class method that can be invoked with the value attribute as keyword arguments.

property workflow#

The workflow containing this input value.