kaira.constraints.ConstraintRegistry

Inheritance diagram for ConstraintRegistry

class kaira.constraints.ConstraintRegistry

Bases: object

A registry for constraints in Kaira.

This class provides a centralized registry for all constraints, making it easier to instantiate them by name with appropriate parameters.

Methods

__init__
create	Create a constraint instance by name.
get	Get a constraint class by name.
list_constraints	List all available constraints in the registry.
register	Register a new constraint in the registry.
register_constraint	Decorator to register a constraint class in the registry.

classmethod register(name: str, constraint_class: Type[BaseConstraint]) → None

Register a new constraint in the registry.

Parameters:

• name (str) – The name to register the constraint under.

• constraint_class (Type[BaseConstraint]) – The constraint class to register.

classmethod register_constraint(name: str | None = None) → Callable

Decorator to register a constraint class in the registry.

Parameters:

name (Optional[str], optional) – The name to register the constraint under. If None, the class name will be used (converted to lowercase).

Returns:

A decorator function that registers the constraint class.

Return type:

callable

classmethod get(name: str) → Type[BaseConstraint]

Get a constraint class by name.

Parameters:

name (str) – The name of the constraint to get.

Returns:

The constraint class.

Return type:

Type[BaseConstraint]

Raises:

KeyError – If the constraint is not registered.

classmethod create(name: str, **kwargs) → BaseConstraint

Create a constraint instance by name.

Parameters:

• name (str) – The name of the constraint to create.

• **kwargs – Additional arguments to pass to the constraint constructor.

Returns:

The instantiated constraint.

Return type:

BaseConstraint

classmethod list_constraints() → list

List all available constraints in the registry.

Returns:

A list of constraint names.

Return type:

list

__init__()