{"author":"hashberg","author_email":"sg495@users.noreply.github.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Typing :: Typed"],"description":"\r\ntyping-validation: Validation using Type Hints\r\n==============================================\r\n\r\n.. image:: https://img.shields.io/badge/python-3.7+-green.svg\r\n :target: https://docs.python.org/3.7/\r\n :alt: Python versions\r\n\r\n.. image:: https://img.shields.io/pypi/v/typing-validation.svg\r\n :target: https://pypi.python.org/pypi/typing-validation/\r\n :alt: PyPI version\r\n\r\n.. image:: https://img.shields.io/pypi/status/typing-validation.svg\r\n :target: https://pypi.python.org/pypi/typing-validation/\r\n :alt: PyPI status\r\n\r\n.. image:: http://www.mypy-lang.org/static/mypy_badge.svg\r\n :target: https://github.com/python/mypy\r\n :alt: Checked with Mypy\r\n\r\n.. image:: https://readthedocs.org/projects/typing-validation/badge/?version=latest\r\n :target: https://typing-validation.readthedocs.io/en/latest/?badge=latest\r\n :alt: Documentation Status\r\n\r\n.. image:: https://github.com/hashberg-io/typing-validation/actions/workflows/python-pytest.yml/badge.svg\r\n :target: https://github.com/hashberg-io/typing-validation/actions/workflows/python-pytest.yml\r\n :alt: Python package status\r\n\r\n.. image:: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square\r\n :target: https://github.com/RichardLitt/standard-readme\r\n :alt: standard-readme compliant\r\n\r\nTyping-validation is a small library to perform runtime validation of Python objects using `PEP 484 type hints `_.\r\n\r\n.. contents::\r\n\r\n\r\nInstall\r\n-------\r\n\r\nYou can install the latest release from `PyPI `_ as follows:\r\n\r\n.. code-block::\r\n\r\n pip install --upgrade typing-validation\r\n\r\n\r\nUsage\r\n-----\r\n\r\nThe core functionality of this library is provided by the `validate `_ function:\r\n\r\n\r\n>>> from typing_validation import validate\r\n\r\nThe `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:\r\n\r\n>>> validate(12, int)\r\nTrue # no error raised => 12 is a valid int\r\n\r\nIf the value is invalid for the given type, the `validate `_ function raises a `TypeError `_:\r\n\r\n>>> validate(12, str)\r\nTypeError: Runtime validation error raised by validate(val, t), details below.\r\nFor type , invalid value: 12\r\n\r\nFor nested types (e.g. parametric collection/mapping types), the full chain of validation failures is shown by the type error:\r\n\r\n>>> validate([0, 1, \"hi\"], list[int])\r\nTypeError: Runtime validation error raised by validate(val, t), details below.\r\nFor type list[int], invalid value at idx: 2\r\n For type , invalid value: 'hi'\r\n\r\n\r\nThe function `is_valid` is a variant of the `validate `_ function which returns `False` in case of validation failure, instead of raising `TypeError `_:\r\n\r\n>>> from typing_validation import is_valid\r\n>>> is_valid([0, 1, \"hi\"], list[int])\r\nFalse\r\n\r\nThe function `latest_validation_failure `_ can be used to access detailed information immediately after a failure:\r\n\r\n>>> from typing_validation import latest_validation_failure\r\n>>> is_valid([0, 1, \"hi\"], list[int])\r\nFalse\r\n>>> failure = latest_validation_failure()\r\n>>> print(failure)\r\nRuntime validation error raised by validate(val, t), details below.\r\nFor type list[int], invalid value at idx: 2\r\n For type , invalid value: 'hi'\r\n\r\nPlease note that `latest_validation_failure `_ clears the internal failure logs after returning the latest failure, so the latter must be manually stored if it needs to be accessed multiple times.\r\n\r\n\r\nAPI\r\n---\r\n\r\nFor the full API documentation, see https://typing-validation.readthedocs.io/\r\n\r\n\r\nContributing\r\n------------\r\n\r\nPlease see ``_.\r\n\r\n\r\nLicense\r\n-------\r\n\r\n`MIT © Hashberg Ltd. `_\r\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/hashberg-io/typing-validation","keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"typing-validation","package_url":"https://pypi.org/project/typing-validation/","platform":null,"project_url":"https://pypi.org/project/typing-validation/","project_urls":{"Bug Tracker":"https://github.com/hashberg-io/typing-validation/issues","Homepage":"https://github.com/hashberg-io/typing-validation"},"provides_extra":null,"release_url":"https://pypi.org/project/typing-validation/1.2.12/","requires_dist":["typing_extensions>=4.6.0; python_version < \"3.11\"","mypy; extra == \"dev\"","pylint; extra == \"dev\"","pytest; extra == \"dev\"","pytest-cov; extra == \"dev\"","rich; extra == \"dev\""],"requires_python":">=3.7","summary":"A simple library for runtime type-checking.","version":"1.2.12","yanked":false,"yanked_reason":null}

Dependency	Optional
typing_extensions	false
mypy	true
pylint	true
pytest	true
pytest-cov	true
rich	true

Package search

typing-validation

project_urls

Dependencies

All package metadata

Releases