Typing-validation is a small library to perform runtime validation of Python objects using PEP 484 type hints.
Contents
You can install the latest release from PyPI as follows:
pip install --upgrade typing-validation
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'
For the full API documentation, see https://typing-validation.readthedocs.io/
Please see CONTRIBUTING.md.