Skip to main content

Run-time type checker for Python

Project description

Build Status Code Coverage https://readthedocs.org/projects/typeguard/badge/?version=latest

This library provides run-time type checking for functions defined with PEP 484 argument (and return) type annotations.

Three principal ways to do type checking are provided, each with its pros and cons:

  1. the check_argument_types() and check_return_type() functions:

    • debugger friendly (except when running with the pydev debugger with the C extension installed)

    • does not work reliably with dynamically defined type hints (e.g. in nested functions)

  2. the @typechecked decorator:

    • automatically type checks yields and sends of returned generators (regular and async)

    • adds an extra frame to the call stack for every call to a decorated function

  3. the stack profiler hook (with TypeChecker('packagename'):):

    • emits warnings instead of raising TypeError

    • requires very few modifications to the code

    • multiple TypeCheckers can be stacked/nested

    • does not work reliably with dynamically defined type hints (e.g. in nested functions)

    • may cause problems with badly behaving debuggers or profilers

    • cannot distinguish between an exception being raised and a None being returned

See the documentation for further instructions.

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-2.5.0.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typeguard-2.5.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: typeguard-2.5.0.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for typeguard-2.5.0.tar.gz
Algorithm Hash digest
SHA256 5b90905662970cb47029cd5800b17b81608162ea2fcab7e5fd19bcc04a7d0b42
MD5 1eaa072dc470cd9d260e3adfc878381f
BLAKE2b-256 b78d9bcb4301e55fe82584dac4be36443fc5120d6b68ab9d158427a892a3c77f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: typeguard-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for typeguard-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ecab47551c42a8090dcb914c550287a09caf599b4d47958445494f2822165aa
MD5 32596d26f33d220f56c988e14dcf8fc9
BLAKE2b-256 ffdacd3f8c8d30803f3f4850a8d47bed9269c92c022e9c792c18f911c9d0f278

See more details on using hashes here.

Supported by

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