Cacheable schema description and validation
Project description
Conformity is a declarative schema validation library designed for use in libraries, services, application settings, and more.
Declare a schema:
from conformity.fields import Dictionary, Float, Integer, List, UnicodeString
person = Dictionary({
"name": UnicodeString(),
"height": Float(gte=0),
"event_ids": List(Integer(gt=0)),
})
Check to see if data is valid:
data = {"name": "Andrew", "height": 180.3, "event_ids": [1, "3"]}
errors = person.errors(data)
# Key event_ids: Index 1: Not an integer
And wrap functions to validate on the way in and out:
kwargs = Dictionary({
"name": UnicodeString(),
"score": Integer(),
}, optional_keys=["score"])
@validate_call(kwargs, UnicodeString())
def greet(name, score=0):
if score > 10:
return "So nice to meet you, {}!".format(name)
else:
return "Hello, {}.".format(name)
There’s support for basic string, numeric, geographic, temporal, networking, and other field types, with everything easily extensible (optionally via subclassing). Conformity also boasts support for full-blown application settings schema definition and validation complete with definable defaults, and includes Sphinx autodoc extensions to help you generate meaningful documentation for your code using Conformity.
License
Conformity is licensed under the Apache License, version 2.0.
Installation
Conformity is available in PyPi and can be installing directly via Pip or listed in setup.py, requirements.txt, or Pipfile:
pip install 'conformity~=1.26'
install_requires=[
...
'conformity~=1.26',
...
]
conformity~=1.26
conformity = {version="~=1.26"}
Documentation
The complete Conformity documentation is available on Read the Docs!
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 conformity-1.28.2-py27.py35.py36.py37.py38-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3dd522bdc3dac6982b3ce5b01a78afeb932c7a3dfb34ca7ce5b97de5190ab0c |
|
MD5 | adee3d3d0c77f1eeb6e054a46be4cf11 |
|
BLAKE2b-256 | b861017489c1bec80b01bd13be8a254676f26addc4c437ec1092b3c61a14b4c3 |