alhambra.classes

Module Contents

Classes

IdentMergeableItem	Base class for protocol classes.
UpdateListD	Abstract base class for generic types.
Serializable	Helper class that provides a standard way to create an ABC using

Attributes

T_NMI
T
TS

alhambra.classes.T_NMI

class alhambra.classes.IdentMergeableItem

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing), for example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

ident() → str

merge(other: T_NMI) → T_NMI

copy() → T_NMI

alhambra.classes.T

class alhambra.classes.UpdateListD(initial: Iterable[T_NMI] = tuple())

Bases: Generic[T_NMI]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

data: dict[str, T_NMI]

__slots__ = ('data',)

__setitem__(k: str, v: T_NMI)

__contains__(kv: str) → bool

__getitem__(k: str | SupportsIndex) → T_NMI

__getitem__(k: slice) → T

__delitem__(k: str)

__len__()

refreshnames()

add(v: T_NMI)

__iter__()

__str__() → str

Return str(self).

__repr__() → str

Return repr(self).

update(d: Iterable[T_NMI])

aslist() → list[T_NMI]

asdict() → dict[str, T_NMI]

copy() → T

__add__(other: Iterable[T_NMI]) → T

__iadd__(other: Iterable[T_NMI]) → T

__or__(other: Iterable[T_NMI]) → T

__ior__(other: Iterable[T_NMI]) → T

__sub__(other: Iterable[T_NMI]) → T

search(regex: str, match: Literal[False] = False) → T

search(regex: str, match: Literal[True]) → list[tuple[re.Match, T_NMI]]

alhambra.classes.TS

class alhambra.classes.Serializable

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract classmethod _deserialize(input: Any) → TS

abstract _serialize() → Any

classmethod from_yaml(*args, **kwargs) → TS

classmethod from_toml(*args, **kwargs) → TS

classmethod from_json(*args, **kwargs) → TS

to_yaml(*args, **kwargs)

to_json(*args, **kwargs)

to_toml(*args, **kwargs)