weaver.base

Module Contents

weaver.base.PropertyDataType

class weaver.base._Const

abstract get(cls, key)

class weaver.base.Constants

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

classmethod get(cls: Union[weaver.typedefs.AnyKey, EnumType, PropertyDataType], key_or_value: Optional[Any], default=None) → PropertyDataType

classmethod docs(cls) → Dict[str, Optional[str]]

Retrieves the documentation string applied on the attribute.

Employ classproperty to define the attributes.

classmethod names(cls) → List[str]

Returns the member names assigned to corresponding enum elements.

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

Returns the literal values assigned to corresponding enum elements.

class weaver.base.classproperty(fget: Optional[Callable[[object], PropertyDataType]] = None, fset: Optional[Callable[[object, PropertyDataType], None]] = None, fdel: Optional[Callable[[object], 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(cls, 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(cls) → List[str]

Returns the member names assigned to corresponding enum elements.

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

Returns the literal values assigned to corresponding enum elements.

classmethod get(cls: Union[weaver.typedefs.AnyKey, EnumType], key_or_value: Optional[Any], default=None) → Optional[EnumType]

Finds an enum entry by defined name or its value.

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

classmethod titles(cls) → List[str]

Returns the title representation of all enum elements.

property title(self) → 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