hpcflow.sdk.core.parameters.Parameter#
- class hpcflow.sdk.core.parameters.Parameter(typ, is_file=False, sub_parameters=<factory>, _value_class=None, _hash_value=None, _validation=None)#
Bases:
JSONLike
A general parameter to a workflow task.
- Parameters:
typ (str) – Type code. Used to look up the
ParameterValue
for this parameter, if any.is_file (bool) – Whether this parameter represents a file.
sub_parameters (list[SubParameter]) – Any parameters packed within this one.
_value_class (type[ParameterValue]) – Class that provides the implementation of this parameter’s values. Not normally directly user-managed.
_hash_value (str | None) – Hash of this class. Not normally user-managed.
_validation (valida.schema.Schema | None) – Validation schema.
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.
Attributes
Whether this parameter represents a file.
Representation of this parameter as part of a URL.
Type code.
Any parameters packed within this one.
- 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.
- sub_parameters: List[SubParameter]#
Any parameters packed within this one.
- 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.
- typ: str#
Type code. Used to look up the
ParameterValue
for this parameter, if any.