Module inkfill.registry

Name registry.

"""Name registry."""

from __future__ import annotations
from typing import Dict
from typing import Optional
from typing import Type
from typing import TypeVar
from typing import Union
from typing import cast

T = TypeVar("T", bound="Registrable")
"""Generic type variable."""

NAME_REGISTRY: Dict[str, Registrable] = {}
"""Name registry."""


class Registrable:
    """Object that can be registered in the name registry."""

    DEFAULT: Registrable
    """Default value of this type."""

    name: str
    """Name of this object."""

    def add(self: T, override: bool = False) -> T:
        """Add this name to the registry."""
        name = self.name
        if name in NAME_REGISTRY and not override:
            raise Exception(f"Name {name} is already registered.")
        NAME_REGISTRY[name] = self
        return self

    @classmethod
    def get(cls: Type[T], name: Union[str, T], default: Optional[T] = None) -> T:
        """Get the requested named object."""
        if isinstance(name, cls):
            return name
        result = NAME_REGISTRY.get(cast(str, name), default)
        return cast(T, result or cls.DEFAULT)

Global variables

var T

Generic type variable.

var NAME_REGISTRY : Dict[str, Registrable]

Name registry.

Classes

class Registrable

Object that can be registered in the name registry.

Expand source code

class Registrable:
    """Object that can be registered in the name registry."""

    DEFAULT: Registrable
    """Default value of this type."""

    name: str
    """Name of this object."""

    def add(self: T, override: bool = False) -> T:
        """Add this name to the registry."""
        name = self.name
        if name in NAME_REGISTRY and not override:
            raise Exception(f"Name {name} is already registered.")
        NAME_REGISTRY[name] = self
        return self

    @classmethod
    def get(cls: Type[T], name: Union[str, T], default: Optional[T] = None) -> T:
        """Get the requested named object."""
        if isinstance(name, cls):
            return name
        result = NAME_REGISTRY.get(cast(str, name), default)
        return cast(T, result or cls.DEFAULT)

Subclasses

• NumFormat
• Division
• RefFormat

Class variables

var DEFAULT : Registrable

Default value of this type.

var name : str

Name of this object.

Static methods

def get(name: Union[str, T], default: Optional[T] = None) ‑> ~T

Get the requested named object.

Expand source code

@classmethod
def get(cls: Type[T], name: Union[str, T], default: Optional[T] = None) -> T:
    """Get the requested named object."""
    if isinstance(name, cls):
        return name
    result = NAME_REGISTRY.get(cast(str, name), default)
    return cast(T, result or cls.DEFAULT)

Methods

def add(self: T, override: bool = False) ‑> ~T

Add this name to the registry.

Expand source code

def add(self: T, override: bool = False) -> T:
    """Add this name to the registry."""
    name = self.name
    if name in NAME_REGISTRY and not override:
        raise Exception(f"Name {name} is already registered.")
    NAME_REGISTRY[name] = self
    return self