Skip to main content

Cacheable schema description and validation

Project description

https://readthedocs.org/projects/conformity/badge/ https://pepy.tech/badge/conformity https://img.shields.io/pypi/l/conformity.svg https://api.travis-ci.org/eventbrite/conformity.svg https://img.shields.io/pypi/v/conformity.svg https://img.shields.io/pypi/wheel/conformity.svg https://img.shields.io/pypi/pyversions/conformity.svg

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conformity-1.27.1.tar.gz (40.6 kB view details)

Uploaded Source

Built Distribution

conformity-1.27.1-py27.py35.py36.py37-none-any.whl (50.9 kB view details)

Uploaded Python 2.7 Python 3.5 Python 3.6 Python 3.7

File details

Details for the file conformity-1.27.1.tar.gz.

File metadata

  • Download URL: conformity-1.27.1.tar.gz
  • Upload date:
  • Size: 40.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.7

File hashes

Hashes for conformity-1.27.1.tar.gz
Algorithm Hash digest
SHA256 df10952355429bad62d853c3e9148e6639249b66c3d4afb0b12cd4e8c4b0f8af
MD5 def1b2f8fd5413df312da7f687cc27f1
BLAKE2b-256 4cba25f47abb2c798573918cec7d55bbe080eb21bfe350e95d954b0ff6fabf8e

See more details on using hashes here.

File details

Details for the file conformity-1.27.1-py27.py35.py36.py37-none-any.whl.

File metadata

  • Download URL: conformity-1.27.1-py27.py35.py36.py37-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 2.7, Python 3.5, Python 3.6, Python 3.7
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.7

File hashes

Hashes for conformity-1.27.1-py27.py35.py36.py37-none-any.whl
Algorithm Hash digest
SHA256 7d9cb08fb0b066fddec9f53b0752e3fefada8c5dd1306c77f4f22672438af4f0
MD5 785fe7859149b8429f2f1572060a724d
BLAKE2b-256 ac38acbbc4f1a139ed3b30883ff9d426c7d2a5195995173cec8effe70e14f30a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page