A simple library for runtime type-checking.
Project description
Typing-validation is a small library to perform runtime validation of Python objects using PEP 484 type hints.
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
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
Built Distribution
Hashes for typing-validation-1.0.0.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 306bdc4ea18daefac24c87320577eb36069b38e3b75526e8a8add5824045451e |
|
MD5 | f016ecf82b632ed9af1a613256f5c267 |
|
BLAKE2b-256 | 3dc007df80d25bd9bebe329f5089fd5f09de1367127f3cd005104c96ebc852a8 |
Hashes for typing_validation-1.0.0.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09be5da27fcbd100de8c56330be28b808adbf7c258a04e6bbc81b9bce656a08c |
|
MD5 | 078bf8f07250aeaa7564b5bfb462ec4a |
|
BLAKE2b-256 | df3a02175babe1fa3d0e59889fea4d407ad263644876db035da12915e64ecbca |