hvl_ccb.utils package

Submodules

hvl_ccb.utils.enum module

class hvl_ccb.utils.enum.AutoNumberNameEnum(*args, **kwds)

Bases: hvl_ccb.utils.enum.StrEnumBase, aenum.AutoNumberEnum

Auto-numbered enum with names used as string representation, and with lookup and equality based on this representation.

class hvl_ccb.utils.enum.NameEnum(*args, **kwds)

Bases: hvl_ccb.utils.enum.StrEnumBase

Int enum with names used as string representation, and with lookup and equality based on this representation.

class hvl_ccb.utils.enum.StrEnumBase(*args, **kwds)

Bases: aenum.Enum

String representation-based equality and lookup.

class hvl_ccb.utils.enum.ValueEnum(*args, **kwds)

Bases: hvl_ccb.utils.enum.StrEnumBase

Enum with string representation of values used as string representation, and with lookup and equality based on this representation.

Attention: to avoid errors, best use together with unique enum decorator.

hvl_ccb.utils.typing module

Additional Python typing module utilities

hvl_ccb.utils.typing.check_generic_type(value, type_, name='instance')

Check if value is of a generic type type_. Raises TypeError if it’s not.

Parameters:

• name – name to report in case of an error
• value – value to check
• type – generic type to check against

hvl_ccb.utils.typing.is_generic(type_)

Check if class is a user-defined generic type, for example Union[int, float] but not List.

Parameters:type – type to check

hvl_ccb.utils.typing.is_type_hint(type_)

Check if class is a generic type, for example Union or List[int]

Parameters:type – type to check

Module contents