Presets¶

Parameter system presets.

Preset ¶

Preset(
    name: str,
    *,
    description: str | None = None,
    **values: Any,
)

A saved combination of parameter values, applied by name.

Instead of overriding multiple values for a common configuration, conveniently apply those values together using a preset.

Parameters:

name (str) –

Preset name.
description (str | None, default: None ) –

Optional human-readable description.
**values (Any, default: {} ) –

Parameter values to apply when this preset is selected.

Source code in bdbox/parameters/preset.py

def __init__(
    self, name: str, *, description: str | None = None, **values: Any
) -> None:
    self.name = name
    self.description = description
    self.values: dict[str, Any] = values