odys.optimization.constraints.constraints_group¶

class ConstraintGroup:
    """Base class for grouping related model constraints.

    Subclasses decorate constraint-producing methods with @constraint.
    These are collected at class definition time via __init_subclass__
    and invoked automatically by collect_constraints() / add_to_model().
    """

    _constraint_methods: ClassVar[tuple[str, ...]] = ()

    def __init_subclass__(cls, **kwargs: Any) -> None:  # noqa: ANN401
        """Register @constraint-decorated methods defined on this subclass."""
        super().__init_subclass__(**kwargs)
        cls._constraint_methods = tuple(
            name for name, attr in cls.__dict__.items() if isinstance(attr, Hashable) and attr in _constraint_registry
        )

    def collect_constraints(self) -> list[ModelConstraint]:
        """Collect all @constraint-decorated methods. Preserves definition order."""
        results: list[ModelConstraint] = []
        for name in self._constraint_methods:
            result = getattr(self, name)()
            if isinstance(result, list):
                results.extend(result)
            else:
                results.append(result)
        return results

    def add_to_model(self, linopy_model: linopy.Model) -> None:
        """Collect all constraints and add them to the linopy model."""
        for c in self.collect_constraints():
            linopy_model.add_constraints(c.constraint, name=c.name)