matflow.SchemaOutput#
- class matflow.SchemaOutput(parameter, propagation_mode=ParameterPropagationMode.IMPLICIT, multiplicity=None)#
Bases:
SchemaOutputA Parameter as outputted from particular task.
- Parameters:
parameter (Parameter | str) – The parameter supplied by this output.
propagation_mode (ParameterPropagationMode) – How this output propagates to downstream tasks.
multiplicity (int | str | None) – Positive integer number of sourceable members supplied by each producing element, or an input reference such as
"<<input:p1>>". An input reference is resolved for each producing element when workflow elements are built, and must identify an input set to None or a scalar positive integer. For every positive multiplicity, each output value must be a list, tuple, or NumPy array of exactly this length; the length is checked when a downstream member is read. The default, None, supplies the whole output value unchanged, even if that value is a sequence.
Methods
Make an instance of this class from JSON (or YAML) data.
Resolve and validate this output's fixed or input-driven member count.
Serialize this object as a dictionary.
Serialize this object as an object structure that can be trivially converted to JSON.
Attributes
Whether this is an input or output.
Number of sourceable output members per element, or None for the whole output.
Return the schema input named by a dynamic multiplicity, if any.
The type code of the parameter.
The basic parameter this supplies.
How this output propagates.
- classmethod from_json_like(json_like, shared_data=None)#
Make an instance of this class from JSON (or YAML) data.
- property input_or_output: Literal['output']#
Whether this is an input or output. Always
output.
- multiplicity: int | str | None = None#
Number of sourceable output members per element, or None for the whole output.
- property multiplicity_input: str | None#
Return the schema input named by a dynamic multiplicity, if any.
- propagation_mode: ParameterPropagationMode#
How this output propagates.
- resolve_multiplicity(input_value=NullDefault.NULL)#
Resolve and validate this output’s fixed or input-driven member count.
- to_json_like(dct=None, shared_data=None, exclude=(), 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.