Skip to content

llmcompressor.sentinel

Sentinel

Unique sentinel values. Implements https://peps.python.org/pep-0661/ with dummy pydantic validation

Source code in llmcompressor/sentinel.py
class Sentinel:
    """
    Unique sentinel values. Implements https://peps.python.org/pep-0661/
    with dummy pydantic validation
    """

    def __new__(cls, name, module_name=None):
        name = str(name)

        if module_name is None:
            module_name = inspect.currentframe().f_globals.get("__file__")
            if module_name is None:
                module_name = __name__

        registry_key = f"{module_name}-{name}"

        sentinel = _registry.get(registry_key, None)
        if sentinel is not None:
            return sentinel

        sentinel = super().__new__(cls)
        sentinel._name = name
        sentinel._module_name = module_name

        return _registry.setdefault(registry_key, sentinel)

    def __repr__(self):
        return self._name

    def __reduce__(self):
        return (
            self.__class__,
            (
                self._name,
                self._module_name,
            ),
        )

    @classmethod
    def __get_pydantic_core_schema__(cls, _source_type, _handler):
        return core_schema.no_info_plain_validator_function(cls.validate)

    @classmethod
    def validate(cls, value: "Sentinel") -> "Sentinel":
        return value