mafw.models.parameter_schema

Schemas describing processor parameters.

These light-weight dataclasses capture the static metadata that is declared through ActiveParameter definitions and can be consumed by tooling without instantiating the processor itself.

Classes

ParameterSchema(name, annotation, default, ...)

Static metadata describing a single processor parameter.
class mafw.models.parameter_schema.ParameterSchema(name: str, annotation: type | None, default: Any, help: str | None, is_list: bool, is_dict: bool)[source]

Bases: object

Static metadata describing a single processor parameter.

Parameters:

  • name – Symbolic name used in steering files.

  • annotation – Optional type hint supplied by the processor definition.

  • default – The default value declared on the descriptor.

  • help – Documentation text that should be surfaced to the user.

  • is_list – True if the parameter expects a list-like value.

  • is_dict – True if the parameter expects a dict-like value.