Skip to content

omnipy.data.helpers

Helper types and utilities shared across Omnipy's data layer internals.

CLASS DESCRIPTION
DoubleTypeVarStore

Sentinel generic used to expose one of two type variables to internal helpers.
FailedData

Marker payload for dataset items whose producing task failed.
MethodInfo

Metadata describing how a Python special method behaves for wrapped data classes.
PendingData

Marker payload for dataset items whose producing task has not completed yet.
ResetSolutionTuple

Result from internal reset handling during snapshot-aware operations.
TypeVarStore

Sentinel generic used to expose a single type variable in helper type plumbing.
TypeVarStore1

Distinct single-type-variable marker used when multiple stores are needed.
TypeVarStore2

Distinct single-type-variable marker used when multiple stores are needed.
TypeVarStore3

Distinct single-type-variable marker used when multiple stores are needed.
TypeVarStore4

Distinct single-type-variable marker used when multiple stores are needed.
YesNoMaybe

Tri-state answer used when Omnipy infers special-method behavior.
FUNCTION DESCRIPTION
build_own_module_and_global_namespace_for_forward_refs

Build own-module and global namespaces for fwd reference resolution
cleanup_name_qualname_and_module

Normalize generated class identity metadata for parametrized data classes.
ATTRIBUTE DESCRIPTION
SPECIAL_METHODS_INFO_DICT

TYPE: dict[str, MethodInfo]

SPECIAL_METHODS_INFO_DICT module-attribute 

SPECIAL_METHODS_INFO_DICT: dict[str, MethodInfo] = {
    "__len__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__length_hint__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__getitem__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__setitem__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__delitem__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__missing__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__iter__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__next__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__reversed__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__contains__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__add__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.YES),
    "__sub__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__mul__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__matmul__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__truediv__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__floordiv__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__mod__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__divmod__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__pow__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__lshift__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rshift__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__and__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__xor__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__or__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__radd__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.YES),
    "__rsub__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rmul__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rmatmul__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rtruediv__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rfloordiv__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rmod__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rdivmod__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rpow__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rlshift__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rrshift__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rand__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__rxor__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__ror__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__iadd__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.YES),
    "__isub__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__imul__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__imatmul__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__itruediv__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__ifloordiv__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__imod__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__ipow__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__ilshift__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__irshift__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__iand__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__ixor__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__ior__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.MAYBE),
    "__neg__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__pos__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__abs__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__invert__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__complex__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__int__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__float__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__str__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__bytes__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__index__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__round__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__trunc__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__floor__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__ceil__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.MAYBE),
    "__enter__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__exit__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__buffer__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__release_buffer__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__hash__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__await__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__aiter__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__anext__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__aenter__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__aexit__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
    "__copy__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.YES),
    "__deepcopy__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.YES),
    "__replace__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.YES),
    "__format__": MethodInfo(state_changing=False, returns_same_type=YesNoMaybe.NO),
    "__delattr__": MethodInfo(state_changing=True, returns_same_type=YesNoMaybe.NO),
}

validate_cls_counts module-attribute 

validate_cls_counts: defaultdict[str, int] = defaultdict(int)

DoubleTypeVarStore

Bases: Generic[_T, _U]


              flowchart BT
              omnipy.data.helpers.DoubleTypeVarStore[DoubleTypeVarStore]

              

              click omnipy.data.helpers.DoubleTypeVarStore href "" "omnipy.data.helpers.DoubleTypeVarStore"

Sentinel generic used to expose one of two type variables to internal helpers.

METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
49
50
51
52
class DoubleTypeVarStore(Generic[_T, _U]):
    """Sentinel generic used to expose one of two type variables to internal helpers."""
    def __init__(self, t: _T | _U) -> None:
        raise ValueError()

__init__ 

__init__(t: _T | _U) -> None
Source code in src/omnipy/data/helpers.py 
51
52
def __init__(self, t: _T | _U) -> None:
    raise ValueError()

FailedData dataclass

Marker payload for dataset items whose producing task failed.

ATTRIBUTE DESCRIPTION
job_name

Human-readable task name.

TYPE: str

job_unique_name

Optional unique task identifier when available.

TYPE: str

exception

The captured task failure.

TYPE: BaseException

METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
346
347
348
349
350
351
352
353
354
355
356
357
358
@dataclass(frozen=True, kw_only=True)
class FailedData:
    """Marker payload for dataset items whose producing task failed.

    Attributes:
        job_name: Human-readable task name.
        job_unique_name: Optional unique task identifier when available.
        exception: The captured task failure.
    """

    job_name: str
    job_unique_name: str = ''
    exception: BaseException

exception instance-attribute 

exception: BaseException

job_name instance-attribute 

job_name: str

job_unique_name class-attribute instance-attribute 

job_unique_name: str = ''

__init__ 

__init__(*, job_name: str, job_unique_name: str = '', exception: BaseException) -> None

MethodInfo

Bases: NamedTuple


              flowchart BT
              omnipy.data.helpers.MethodInfo[MethodInfo]

              

              click omnipy.data.helpers.MethodInfo href "" "omnipy.data.helpers.MethodInfo"

Metadata describing how a Python special method behaves for wrapped data classes.

ATTRIBUTE DESCRIPTION
state_changing

Whether calling the method mutates the wrapped object.

TYPE: bool

returns_same_type

Whether the method is expected to return the same data-class type.

TYPE: YesNoMaybe

Returned by: Used by:
Source code in src/omnipy/data/helpers.py 
 95
 96
 97
 98
 99
100
101
102
103
104
class MethodInfo(NamedTuple):
    """Metadata describing how a Python special method behaves for wrapped data classes.

    Attributes:
        state_changing: Whether calling the method mutates the wrapped object.
        returns_same_type: Whether the method is expected to return the same data-class type.
    """

    state_changing: bool
    returns_same_type: YesNoMaybe

returns_same_type instance-attribute 

returns_same_type: YesNoMaybe

state_changing instance-attribute 

state_changing: bool

PendingData dataclass

Marker payload for dataset items whose producing task has not completed yet.

ATTRIBUTE DESCRIPTION
job_name

Human-readable task name.

TYPE: str

job_unique_name

Optional unique task identifier when available.

TYPE: str

METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
333
334
335
336
337
338
339
340
341
342
343
@dataclass(frozen=True, kw_only=True)
class PendingData:
    """Marker payload for dataset items whose producing task has not completed yet.

    Attributes:
        job_name: Human-readable task name.
        job_unique_name: Optional unique task identifier when available.
    """

    job_name: str
    job_unique_name: str = ''

job_name instance-attribute 

job_name: str

job_unique_name class-attribute instance-attribute 

job_unique_name: str = ''

__init__ 

__init__(*, job_name: str, job_unique_name: str = '') -> None

ResetSolutionTuple

Bases: NamedTuple


              flowchart BT
              omnipy.data.helpers.ResetSolutionTuple[ResetSolutionTuple]

              

              click omnipy.data.helpers.ResetSolutionTuple href "" "omnipy.data.helpers.ResetSolutionTuple"

Result from internal reset handling during snapshot-aware operations.

ATTRIBUTE DESCRIPTION
reset_solution

Context manager that applies the chosen reset strategy.

TYPE: ContextManager[None]

snapshot_taken

Whether a fresh snapshot was captured before the operation.

TYPE: bool

Source code in src/omnipy/data/helpers.py 
221
222
223
224
225
226
227
228
229
230
class ResetSolutionTuple(NamedTuple):
    """Result from internal reset handling during snapshot-aware operations.

    Attributes:
        reset_solution: Context manager that applies the chosen reset strategy.
        snapshot_taken: Whether a fresh snapshot was captured before the operation.
    """

    reset_solution: ContextManager[None]
    snapshot_taken: bool

reset_solution instance-attribute 

reset_solution: ContextManager[None]

snapshot_taken instance-attribute 

snapshot_taken: bool

TypeVarStore

Bases: Generic[_T]


              flowchart BT
              omnipy.data.helpers.TypeVarStore[TypeVarStore]

              

              click omnipy.data.helpers.TypeVarStore href "" "omnipy.data.helpers.TypeVarStore"

Sentinel generic used to expose a single type variable in helper type plumbing.

Subclassed by:
METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
43
44
45
46
class TypeVarStore(Generic[_T]):
    """Sentinel generic used to expose a single type variable in helper type plumbing."""
    def __init__(self, t: _T) -> None:
        raise ValueError()

__init__ 

__init__(t: _T) -> None
Source code in src/omnipy/data/helpers.py 
45
46
def __init__(self, t: _T) -> None:
    raise ValueError()

TypeVarStore1

Bases: TypeVarStore[_T], Generic[_T]


              flowchart BT
              omnipy.data.helpers.TypeVarStore1[TypeVarStore1]
              omnipy.data.helpers.TypeVarStore[TypeVarStore]

                              omnipy.data.helpers.TypeVarStore --> omnipy.data.helpers.TypeVarStore1
                


              click omnipy.data.helpers.TypeVarStore1 href "" "omnipy.data.helpers.TypeVarStore1"
              click omnipy.data.helpers.TypeVarStore href "" "omnipy.data.helpers.TypeVarStore"

Distinct single-type-variable marker used when multiple stores are needed.

Subclassed by:
METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
55
56
57
58
59
60
class TypeVarStore1(TypeVarStore[_T], Generic[_T]):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{TYPEVAR_STORE_MARKER_SUMMARY}}
    """Distinct single-type-variable marker used when multiple stores are needed."""

    ...

__init__ 

__init__(t: _T) -> None
Source code in src/omnipy/data/helpers.py 
45
46
def __init__(self, t: _T) -> None:
    raise ValueError()

TypeVarStore2

Bases: TypeVarStore[_T], Generic[_T]


              flowchart BT
              omnipy.data.helpers.TypeVarStore2[TypeVarStore2]
              omnipy.data.helpers.TypeVarStore[TypeVarStore]

                              omnipy.data.helpers.TypeVarStore --> omnipy.data.helpers.TypeVarStore2
                


              click omnipy.data.helpers.TypeVarStore2 href "" "omnipy.data.helpers.TypeVarStore2"
              click omnipy.data.helpers.TypeVarStore href "" "omnipy.data.helpers.TypeVarStore"

Distinct single-type-variable marker used when multiple stores are needed.

Subclassed by:
METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
63
64
65
66
67
68
class TypeVarStore2(TypeVarStore[_T], Generic[_T]):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{TYPEVAR_STORE_MARKER_SUMMARY}}
    """Distinct single-type-variable marker used when multiple stores are needed."""

    ...

__init__ 

__init__(t: _T) -> None
Source code in src/omnipy/data/helpers.py 
45
46
def __init__(self, t: _T) -> None:
    raise ValueError()

TypeVarStore3

Bases: TypeVarStore[_T], Generic[_T]


              flowchart BT
              omnipy.data.helpers.TypeVarStore3[TypeVarStore3]
              omnipy.data.helpers.TypeVarStore[TypeVarStore]

                              omnipy.data.helpers.TypeVarStore --> omnipy.data.helpers.TypeVarStore3
                


              click omnipy.data.helpers.TypeVarStore3 href "" "omnipy.data.helpers.TypeVarStore3"
              click omnipy.data.helpers.TypeVarStore href "" "omnipy.data.helpers.TypeVarStore"

Distinct single-type-variable marker used when multiple stores are needed.

Subclassed by:
METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
71
72
73
74
75
76
class TypeVarStore3(TypeVarStore[_T], Generic[_T]):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{TYPEVAR_STORE_MARKER_SUMMARY}}
    """Distinct single-type-variable marker used when multiple stores are needed."""

    ...

__init__ 

__init__(t: _T) -> None
Source code in src/omnipy/data/helpers.py 
45
46
def __init__(self, t: _T) -> None:
    raise ValueError()

TypeVarStore4

Bases: TypeVarStore[_T], Generic[_T]


              flowchart BT
              omnipy.data.helpers.TypeVarStore4[TypeVarStore4]
              omnipy.data.helpers.TypeVarStore[TypeVarStore]

                              omnipy.data.helpers.TypeVarStore --> omnipy.data.helpers.TypeVarStore4
                


              click omnipy.data.helpers.TypeVarStore4 href "" "omnipy.data.helpers.TypeVarStore4"
              click omnipy.data.helpers.TypeVarStore href "" "omnipy.data.helpers.TypeVarStore"

Distinct single-type-variable marker used when multiple stores are needed.

Subclassed by:
METHOD DESCRIPTION
__init__
Source code in src/omnipy/data/helpers.py 
79
80
81
82
83
84
class TypeVarStore4(TypeVarStore[_T], Generic[_T]):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{TYPEVAR_STORE_MARKER_SUMMARY}}
    """Distinct single-type-variable marker used when multiple stores are needed."""

    ...

__init__ 

__init__(t: _T) -> None
Source code in src/omnipy/data/helpers.py 
45
46
def __init__(self, t: _T) -> None:
    raise ValueError()

YesNoMaybe

Bases: IntEnum


              flowchart BT
              omnipy.data.helpers.YesNoMaybe[YesNoMaybe]

              

              click omnipy.data.helpers.YesNoMaybe href "" "omnipy.data.helpers.YesNoMaybe"

Tri-state answer used when Omnipy infers special-method behavior.

Returned by: Used by:
ATTRIBUTE DESCRIPTION
MAYBE

NO

YES

Source code in src/omnipy/data/helpers.py 
87
88
89
90
91
92
class YesNoMaybe(IntEnum):
    """Tri-state answer used when Omnipy infers special-method behavior."""

    NO = 0
    YES = 1
    MAYBE = 2

MAYBE class-attribute instance-attribute 

MAYBE = 2
Used by:

NO class-attribute instance-attribute 

NO = 0
Used by:

YES class-attribute instance-attribute 

YES = 1
Used by:

build_own_module_and_global_namespace_for_forward_refs 

build_own_module_and_global_namespace_for_forward_refs(
    own_class: type, calling_module: str | None, **localns: Any
) -> tuple[dict[str, Any], dict[str, Any]]

Build own-module and global namespaces for fwd reference resolution

Build global namespaces for forward reference resolution by merging:

  1. The model's own defining module namespace — so forward refs declared inside the model (e.g. JsonScalar in tables/models.py) are always resolvable even when update_forward_refs is triggered from a different module.

  2. The calling module's namespace on top — so forward refs that point to types available at the call site (e.g. NestedDataset in datasets.py) are resolved correctly.

  3. Any explicitly passed localns with the highest priority.

RETURNS DESCRIPTION
tuple[dict[str, Any], dict[str, Any]]

A tuple of (own_module_namespace, global_namespace) to be used for forward reference resolution.
Source code in src/omnipy/data/helpers.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def build_own_module_and_global_namespace_for_forward_refs(
    own_class: type,
    calling_module: str | None,
    **localns: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Build own-module and global namespaces for fwd reference resolution

    Build global namespaces for forward reference resolution by merging:

    1. The model's own defining module namespace — so forward refs
       declared inside the model (e.g. JsonScalar in
       tables/models.py) are always resolvable even when
       update_forward_refs is triggered from a different module.

    2. The calling module's namespace on top — so forward refs
       that point to types available at the call site (e.g.
       NestedDataset in datasets.py) are resolved correctly.

    3. Any explicitly passed localns with the highest priority.

    Returns:
        A tuple of (own_module_namespace, global_namespace) to be used for
        forward reference resolution.
    """
    def _module_loaded(module_name: str | None) -> TypeIs[str]:
        return module_name is not None and module_name in sys.modules

    own_module = getattr(own_class, '__module__', None)
    own_module_ns = (sys.modules[own_module].__dict__ if _module_loaded(own_module) else {})

    calling_module_ns = (
        sys.modules[calling_module].__dict__ if _module_loaded(calling_module) else {})

    globalns: dict[str, Any] = {}
    globalns.update(own_module_ns)
    globalns.update(calling_module_ns)
    globalns.update(localns)

    return own_module_ns, globalns

cleanup_name_qualname_and_module 

cleanup_name_qualname_and_module(
    cls: type[DataClassBase], model_or_dataset: type[DataClassBase], orig_model: TypeForm
) -> None

Normalize generated class identity metadata for parametrized data classes.

Omnipy dynamically creates specialized model and dataset classes. This helper keeps the generated class name, qualified name, and module aligned with the originating class so those classes display predictably in errors, debugging output, and introspection tools.

PARAMETER DESCRIPTION
cls

The original generic data-class type being specialized.

TYPE: type[DataClassBase]

model_or_dataset

The generated specialized class whose metadata should be updated.

TYPE: type[DataClassBase]

orig_model

The type parameter representation used to build the specialized class name.

TYPE: TypeForm

Source code in src/omnipy/data/helpers.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def cleanup_name_qualname_and_module(
    cls: type[DataClassBase],
    model_or_dataset: type[DataClassBase],
    orig_model: TypeForm,
) -> None:
    """Normalize generated class identity metadata for parametrized data classes.

    Omnipy dynamically creates specialized model and dataset classes. This helper keeps the
    generated class name, qualified name, and module aligned with the originating class so those
    classes display predictably in errors, debugging output, and introspection tools.

    Args:
        cls: The original generic data-class type being specialized.
        model_or_dataset: The generated specialized class whose metadata should be updated.
        orig_model: The type parameter representation used to build the specialized class name.
    """
    def _display_as_type(model: TypeForm):
        if isinstance(model, str):  # ForwardRef
            return model
        elif isinstance(model, ForwardRef):
            return model.__forward_arg__
        elif isinstance(model, tuple):
            return ', '.join(_display_as_type(arg) for arg in model)
        elif is_union(model):
            return ' | '.join(_display_as_type(arg) for arg in get_args(model))
        elif len(get_args(model)) > 0:
            return (f'{_display_as_type(get_origin(model))}'
                    f"[{', '.join(_display_as_type(arg) for arg in get_args(model))}]")
        elif isinstance(model, TypeVar):
            return str(model)
        else:
            with suppress(AttributeError):
                return model.__name__  # type:ignore[union-attr]
            return str(model)

    params_str = _display_as_type(orig_model)

    model_or_dataset.__name__ = format_classname_with_params(cls.__name__, params_str)
    model_or_dataset.__qualname__ = format_classname_with_params(cls.__qualname__, params_str)
    model_or_dataset.__module__ = cls.__module__

debug_get_sorted_validate_counts 

debug_get_sorted_validate_counts() -> dict[str, int]

Return validation-call counts sorted from highest to lowest for debugging.

Source code in src/omnipy/data/helpers.py 
233
234
235
236
def debug_get_sorted_validate_counts() -> dict[str, int]:
    """Return validation-call counts sorted from highest to lowest for debugging."""

    return dict(reversed(sorted(validate_cls_counts.items(), key=lambda item: item[1])))

debug_get_total_validate_count 

debug_get_total_validate_count() -> int

Return the total number of tracked validation calls for debugging.

Source code in src/omnipy/data/helpers.py 
239
240
241
242
def debug_get_total_validate_count() -> int:
    """Return the total number of tracked validation calls for debugging."""

    return sum(val for key, val in validate_cls_counts.items())