Skip to main content

Run-time type checker for Python

Project description

Build Status Code Coverage Documentation

This library provides run-time type checking for functions defined with PEP 484 argument (and return) type annotations, and any arbitrary objects. It can be used together with static type checkers as an additional layer of type safety, to catch type violations that could only be detected at run time.

Two principal ways to do type checking are provided:

  1. The check_type function:

    • like isinstance(), but supports arbitrary type annotations (within limits)

    • can be used as a cast() replacement, but with actual checking of the value

  2. Code instrumentation:

    • entire modules, or individual functions (via @typechecked) are recompiled, with type checking code injected into them

    • automatically checks function arguments, return values and assignments to annotated local variables

    • for generator functions (regular and async), checks yield and send values

    • requires the original source code of the instrumented module(s) to be accessible

Two options are provided for code instrumentation:

  1. the @typechecked function:

    • can be applied to functions individually

  2. the import hook (typeguard.install_import_hook()):

    • automatically instruments targeted modules on import

    • no manual code changes required in the target modules

    • requires the import hook to be installed before the targeted modules are imported

    • may clash with other import hooks

See the documentation for further information.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typeguard-4.4.0.tar.gz (74.4 kB view details)

Uploaded Source

Built Distribution

typeguard-4.4.0-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

Details for the file typeguard-4.4.0.tar.gz.

File metadata

  • Download URL: typeguard-4.4.0.tar.gz
  • Upload date:
  • Size: 74.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for typeguard-4.4.0.tar.gz
Algorithm Hash digest
SHA256 463bd8697a65a4aa576a63767c369b1ecfba8a5ba735edfe3223127b6ecfa28c
MD5 609f7e69f381dcbe600d971a3c43d4db
BLAKE2b-256 795a91b7c8cfc2e96962442abc9d65c650436dd831910b4d7878980d6596fb98

See more details on using hashes here.

File details

Details for the file typeguard-4.4.0-py3-none-any.whl.

File metadata

  • Download URL: typeguard-4.4.0-py3-none-any.whl
  • Upload date:
  • Size: 35.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for typeguard-4.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ca34c14043f53b2caae7040549ba431770869bcd6287cfa8239db7ecb882b4a
MD5 0742f67f64f9b94bb277f59189a1fa02
BLAKE2b-256 61a300203767544b597a9e3c57b29a84967b3230f00bdd9aa6a52a73187043b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page