Import Hook (beartype.claw)¶

If you want package-wide instrumentation rather than decorating individual functions, use beartype.claw or shapix's thin wrapper around it.

Usage¶

Via shapixVia beartype directly

from shapix.claw import shapix_this_package
shapix_this_package()

from beartype.claw import beartype_this_package
beartype_this_package()

shapix_this_package() is a semantic wrapper around beartype.claw.beartype_this_package(). Runtime behavior is the same.

What it gives you¶

Once called in your_package.__init__, all subsequently imported submodules in that package are instrumented as if their annotated callables had been decorated with @beartype.

# your_package/__init__.py
from shapix.claw import shapix_this_package
shapix_this_package()

# your_package/model.py
from shapix import N, C
from shapix.numpy import F32

def forward(x: F32[N, C]) -> F32[N, C]:
  ...

Because shapix integrates through standard beartype validators, the usual cross-argument dimension semantics still apply.

Configuration¶

Pass a BeartypeConf to customize the checking behavior:

from beartype import BeartypeConf
from shapix.claw import shapix_this_package

shapix_this_package(conf=BeartypeConf(
  is_color=False,
))

When to use¶

Approach	Best for
`@beartype` per function	Fine-grained control, specific functions
`beartype.claw` / `shapix_this_package`	Entire packages, library-wide checking