Skip to content

Post Processing

post_processing

Configuration for the post-processing.

Classes

HookArguments

Bases: BaseModel

Arguments for the hook.

Attributes
model_config class-attribute instance-attribute
model_config = ConfigDict(extra='allow', arbitrary_types_allowed=True, validate_default=True)

Allow additional arguments.

HookConfiguration

Bases: BaseModel

Configuration for the hook.

Attributes
name class-attribute instance-attribute
name: str = Field(..., description='Name of the hook.')

Name of the hook.

arguments class-attribute instance-attribute
arguments: HookArguments = Field(default_factory=HookArguments, description='Arguments for the hook.')

Arguments for the hook.

PostProcessingConfiguration

Bases: BaseModel

Configuration for post-processing.

Attributes
hooks class-attribute instance-attribute
hooks: list[HookConfiguration] = Field(default_factory=list, description='A list of functions to run in post-processing.')

A list of functions to run in post-processing.

Functions
validate_hooks classmethod
validate_hooks(value: list[HookConfiguration]) -> list[HookConfiguration]

Validate the hooks input.

Parameters:

Name Type Description Default
value list[HookConfiguration]

Input list of hooks.

required

Returns:

Type Description
list[HookConfiguration]

A list of hook configuration.