Skip to main content

typing-validation: Validation using Type Hints

Python versions PyPI version PyPI status Checked with Mypy Documentation Status Python package status standard-readme compliant

Typing-validation is a small library to perform runtime validation of Python objects using PEP 484 type hints.

This is a temporary fork of the original project to be used until the original project incorporates a bug fix to work with newer versions of the ‘typing_extensions’ dependency.

Bug: https://github.com/hashberg-io/typing-validation/issues/1

Install

You can install the latest release from PyPI as follows:

pip install --upgrade typing-validation

Usage

The core functionality of this library is provided by the validate function:

>>> from typing_validation import validate

The validate function is invoked with a value and a type as its arguments and it returns nothing when the given value is valid for the given type:

>>> validate(12, int)
# nothing is returned => 12 is a valid int

If the value is invalid for the given type, the validate function raises a TypeError:

>>> validate(12, str)
TypeError: For type <class 'str'>, invalid value: 12

For nested types (e.g. parametric collection/mapping types), the full chain of validation failures is shown by the type error:

>>> validate([0, 1, "hi"], list[int])
TypeError: For type list[int], invalid value: [0, 1, 'hi']
  For type <class 'int'>, invalid value: 'hi'

API

For the full API documentation, see https://typing-validation.readthedocs.io/

Contributing

Please see CONTRIBUTING.md.

License

MIT © Hashberg Ltd.

Metadata

Release files for typing-validation-fix 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for typing-validation-fix 1.0.4
File Size Uploaded
typing-validation-fix-1.0.4.tar.gz 30.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for typing-validation-fix 1.0.4
File Interpreter ABI Platform
typing_validation_fix-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 44.5 kB

Release files / typing-validation-fix-1.0.4.tar.gz

Download URL typing-validation-fix-1.0.4.tar.gz
Size 30.6 kB
Tags Source
SHA-256 checksum
How to use checksums
17c916bbfd5f2d085a30f871e2a5c0f53ba80c0d5aadbd40a8c6bd95c7910dfc
BLAKE2b-256 checksum
How to use checksums
4c3826f9743b0f5fa2fcd2b3357acc6a89cf03693aa04b66070c3b3482a3ecf3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.0

Release files / typing_validation_fix-1.0.4-py3-none-any.whl

Download URL typing_validation_fix-1.0.4-py3-none-any.whl
Size 13.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3549417f2a5656944e55721b4d28c00e0ddc4d64d789753fb59e2ece275121cc
BLAKE2b-256 checksum
How to use checksums
55c82b618683102e3cc269af998d6e57350bb804c71f1ba977da622b67978a08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.0

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page