omnipy.shared.typedefs

Shared type aliases and protocol-based callable definitions.

CLASS	DESCRIPTION
Method	Protocol for bound methods with preserved parameter and return types.

ATTRIBUTE	DESCRIPTION
GeneralDecorator
LocaleType	TYPE: TypeAlias
P
RetT
TypeForm	TYPE: TypeAlias

GeneralDecorator module-attribute

GeneralDecorator = Callable[[Callable], Callable]

LocaleType module-attribute

LocaleType: TypeAlias = str | tuple[str | None, str | None]

Returned by:

• Reference Code reference omnipy
  • config  root_log  RootLogConfig  locale
  • shared protocols  config  IsRootLogConfig  locale

Used by:

• Reference Code reference omnipy util  helpers  get_datetime_format

P module-attribute

P = ParamSpec('P')

Subclassed by:

• Reference Code reference omnipy shared  typedefs  Method

RetT module-attribute

RetT = TypeVar('RetT', covariant=True)

Subclassed by:

• Reference Code reference omnipy shared  typedefs  Method

TypeForm module-attribute

TypeForm: TypeAlias = (
    type
    | UnionType
    | None
    | _UnionGenericAlias
    | _AnnotatedAlias
    | GenericAlias
    | _LiteralGenericAlias
    | _SpecialForm
    | ForwardRef
    | TypeVar
)

Returned by:

• Reference Code reference
  •  omnipy  Model
    •  inner_type
    •  outer_type
  • omnipy
    • components general  models  HasOuterType  outer_type
    • data  model  Model
      •  inner_type
      •  outer_type
    • util  helpers
      •  evaluate_any_forward_refs_if_possible
      •  get_default_if_typevar
      •  split_to_union_variants

Used by:

• Reference Code reference
  •  omnipy
    •  Model  set_orig_model
    •  is_dataset_subclass
    •  is_model_subclass
  • omnipy
    • data
      •  dataset  is_dataset_subclass
      •  helpers  cleanup_name_qualname_and_module
      •  model
        •  Model  set_orig_model
        •  is_model_subclass
    • util  helpers
      •  ensure_plain_type
      •  evaluate_any_forward_refs_if_possible
      •  get_default_if_typevar
      •  split_to_union_variants

Method

Bases: Protocol, Generic[P, RetT]

              flowchart BT
              omnipy.shared.typedefs.Method[Method]

              

              click omnipy.shared.typedefs.Method href "" "omnipy.shared.typedefs.Method"
            

Protocol for bound methods with preserved parameter and return types.

Source code in src/omnipy/shared/typedefs.py

class Method(Protocol, Generic[P, RetT]):
    """Protocol for bound methods with preserved parameter and return types."""
    def __call__(self: Self, *args: P.args, **kwargs: P.kwargs) -> RetT:
        ...