registry

registry

RegistryFunc = TypeVar('RegistryFunc') module-attribute

RegistrySign = TypeVar('RegistrySign') module-attribute

CompilationRuleNotFound

Bases: Exception

Source code in cirkit/backend/registry.py

class CompilationRuleNotFound(Exception):
    def __init__(self, signature: RegistrySign):
        super().__init__(f"Compilation rule for signature '{signature}' not found")

__init__(signature)

Source code in cirkit/backend/registry.py

def __init__(self, signature: RegistrySign):
    super().__init__(f"Compilation rule for signature '{signature}' not found")

CompilerRegistry

Bases: Generic[RegistrySign, RegistryFunc], ABC

Source code in cirkit/backend/registry.py

class CompilerRegistry(Generic[RegistrySign, RegistryFunc], ABC):
    def __init__(self, rules: dict[RegistrySign, RegistryFunc] | None = None):
        self._rules = {} if rules is None else rules

    @classmethod
    @abstractmethod
    def _validate_rule_function(cls, func: RegistryFunc) -> bool:
        ...

    @classmethod
    def _retrieve_signature(cls, func: RegistryFunc) -> RegistrySign:
        raise InvalidRuleSign(func.__annotations__)

    @property
    def signatures(self) -> list[RegistrySign]:
        return list(self._rules)

    def add_rule(self, func: RegistryFunc, *, signature: RegistrySign | None = None) -> None:
        if not self._validate_rule_function(func):
            raise InvalidRuleFunction(func.__annotations__)
        if signature is None:
            signature = self._retrieve_signature(func)
        self._rules[signature] = func

    def retrieve_rule(self, signature: RegistrySign) -> RegistryFunc:
        func = self._rules.get(signature, None)
        if func is not None:
            return func
        raise CompilationRuleNotFound(signature)

_rules = {} if rules is None else rules instance-attribute

signatures property

__init__(rules=None)

Source code in cirkit/backend/registry.py

def __init__(self, rules: dict[RegistrySign, RegistryFunc] | None = None):
    self._rules = {} if rules is None else rules

_retrieve_signature(func) classmethod

Source code in cirkit/backend/registry.py

@classmethod
def _retrieve_signature(cls, func: RegistryFunc) -> RegistrySign:
    raise InvalidRuleSign(func.__annotations__)

_validate_rule_function(func) abstractmethod classmethod

Source code in cirkit/backend/registry.py

@classmethod
@abstractmethod
def _validate_rule_function(cls, func: RegistryFunc) -> bool:
    ...

add_rule(func, *, signature=None)

Source code in cirkit/backend/registry.py

def add_rule(self, func: RegistryFunc, *, signature: RegistrySign | None = None) -> None:
    if not self._validate_rule_function(func):
        raise InvalidRuleFunction(func.__annotations__)
    if signature is None:
        signature = self._retrieve_signature(func)
    self._rules[signature] = func

retrieve_rule(signature)

Source code in cirkit/backend/registry.py

def retrieve_rule(self, signature: RegistrySign) -> RegistryFunc:
    func = self._rules.get(signature, None)
    if func is not None:
        return func
    raise CompilationRuleNotFound(signature)

InvalidRuleFunction

Bases: Exception

Source code in cirkit/backend/registry.py

class InvalidRuleFunction(Exception):
    def __init__(self, annotations: dict[str, type]):
        super().__init__(f"Invalid Compilation rule function with annotations '{annotations}'")

__init__(annotations)

Source code in cirkit/backend/registry.py

def __init__(self, annotations: dict[str, type]):
    super().__init__(f"Invalid Compilation rule function with annotations '{annotations}'")

InvalidRuleSign

Bases: Exception

Source code in cirkit/backend/registry.py

class InvalidRuleSign(Exception):
    def __init__(self, annotations: dict[str, type]):
        super().__init__(
            f"Cannot extract rule signature from function with annotations '{annotations}"
        )

__init__(annotations)

Source code in cirkit/backend/registry.py

def __init__(self, annotations: dict[str, type]):
    super().__init__(
        f"Cannot extract rule signature from function with annotations '{annotations}"
    )