weaver.base

Definitions of base classes employed across multiple modules to avoid circular import errors.

Module Contents

type weaver.base.ConstantsType = 'Constants'

class weaver.base._Const

abstract get(key)

class weaver.base.Constants

Constants container that provides similar functionalities to ExtendedEnum without explicit Enum membership.

classmethod get(key_or_value: weaver.typedefs.AnyKey | EnumType | PropertyDataTypeT | None, default: Any | None = None) → PropertyDataTypeT

classmethod docs() → Dict[str, str | None]

Retrieves the documentation string applied on the attribute.

Employ classproperty to define the attributes.

classmethod names() → List[str]

Returns the member names assigned to corresponding enum elements.

classmethod values() → List[weaver.typedefs.AnyKey]

Returns the literal values assigned to corresponding enum elements.

class weaver.base.classproperty(fget: Callable[[object], PropertyDataTypeT] | None = None, fset: Callable[[object, PropertyDataTypeT], None] | None = None, fdel: Callable[[object], None] | None = None, doc: str = '')

Mimics property decorator, but applied onto classmethod in backward compatible way.

Note

This decorator purposely only supports getter attribute to define unmodifiable class properties.

See also

https://stackoverflow.com/a/5191224

Initialize self. See help(type(self)) for accurate signature.

class weaver.base._EnumMeta

Metaclass for Enum

abstract get(key)

class weaver.base.ExtendedEnum

Utility enum.Enum methods.

Create an extended enum with these utilities as follows.

class CustomEnum(ExtendedEnum):
    ItemA = "A"
    ItemB = "B"

Warning

Must not define any enum value here to allow inheritance by subclasses.

classmethod names() → List[str]

Returns the member names assigned to corresponding enum elements.

classmethod values() → List[weaver.typedefs.AnyKey]

Returns the literal values assigned to corresponding enum elements.

classmethod get(key_or_value: weaver.typedefs.AnyKey | EnumType, default: Any | None = None) → EnumType | None

Finds an enum entry by defined name or its value.

Returns the entry directly if it is already a valid enum.

classmethod titles() → List[str]

Returns the title representation of all enum elements.

property title: str

Returns the title representation of the enum element.

Title use the original enum element name with capitalization considering underscores for separate words.

weaver.base.EnumType