mafw.models.processor_schema

Schemas describing a processor.

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

Classes

ProcessorSchema(parameters, filter[, ...])

Static metadata describing a processor.

class mafw.models.processor_schema.ProcessorSchema(parameters: list[ParameterSchema], filter: FilterSchema | None, description: str | None = None)

Bases: object

Static metadata describing a processor.

Parameters:

• parameters – List of parameter schemas.

• filter – Optional filter schema.

• description – First-line processor documentation for human-readable steering files.

Changed in version v2.4: Added the processor description used in steering file comments.

get_parameter(parameter_name: str) → ParameterSchema

Return the parameter schema for the given parameter name.

get_parameter_names() → list[str]

Return the list of parameter names.