define.alias

AliasDict

Bases: dict[K, V]

Dict subclass for storing aliases to keys alongside the actual key

Source code in /home/runner/work/arc/arc/arc/define/alias.py

class AliasDict(dict[K, V]):
    """Dict subclass for storing aliases to keys alongside the actual key"""

    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
        super().__init__(*args, **kwargs)

        self.aliases: dict[K, K] = {}
        """Maps aliases to the cannonical key"""

    @t.overload
    def get(self, key: K) -> V | None:
        ...

    @t.overload
    def get(self, key: K, default: V | t.Any) -> V | t.Any:
        ...

    def get(self, key: K, default: t.Any = None) -> V | t.Any:
        """Wraps `dict.get()` but also checks for aliases"""
        if super().__contains__(key):
            return self[key]
        if key in self.aliases:
            return self[self.aliases[key]]

        return default

    def __contains__(self, key: object) -> bool:
        return super().__contains__(key) or key in self.aliases

    def add_alias(self, key: K, alias: K) -> None:
        """Add an `alias` for `key`"""
        self.aliases[alias] = key

    def add_aliases(self, key: K, *aliases: K) -> None:
        """Add an several `aliass` for `key`"""
        for alias in aliases:
            self.add_alias(key, alias)

    def aliases_for(self, key: K) -> list[K]:
        return [alias for alias, val in self.aliases.items() if val == key]

aliases: dict[K, K] = {} instance-attribute

Maps aliases to the cannonical key

add_alias(key, alias)

Add an alias for key

Source code in /home/runner/work/arc/arc/arc/define/alias.py

def add_alias(self, key: K, alias: K) -> None:
    """Add an `alias` for `key`"""
    self.aliases[alias] = key

add_aliases(key, *aliases)

Add an several aliass for key

Source code in /home/runner/work/arc/arc/arc/define/alias.py

def add_aliases(self, key: K, *aliases: K) -> None:
    """Add an several `aliass` for `key`"""
    for alias in aliases:
        self.add_alias(key, alias)

get(key, default=None)

Wraps dict.get() but also checks for aliases

Source code in /home/runner/work/arc/arc/arc/define/alias.py

def get(self, key: K, default: t.Any = None) -> V | t.Any:
    """Wraps `dict.get()` but also checks for aliases"""
    if super().__contains__(key):
        return self[key]
    if key in self.aliases:
        return self[self.aliases[key]]

    return default