Skip to content

Beartype API: It Bears Bookmarking

Beartype isn't just the beartype.beartype decorator.

Beartype is a menagerie of public APIs for type-checking, introspecting, and manipulating type hints at runtime – all accessible under the beartype package installed when you installed beartype. But all beartype documentation begins with beartype.beartype, just like all rivers run to the sea.1

The Left-Paw Path

See the navigation sidebar for links to human-readable API documentation – including:

  • beartype, documenting the core beartype.beartype decorator API.
  • beartype.claw, documenting the beartype import hook API.
  • beartype.door, documenting the Decidedly Object-Oriented Runtime-checker (DOOR) API.
  • beartype.roar, documenting the beartype exception and warning API.
  • beartype.vale, documenting the beartype validator API.

  1. That's a lie, actually. Numerous river tributaries just pour out into deserts. Do endorheic basins mean nothing to you, beartype? Wikipedia: the more you click, the less you know. ↩