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.

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.26.0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

conformity-1.26.0-py27.py35.py36.py37-none-any.whl (50.6 kB view details)

Uploaded Python 2.7 Python 3.5 Python 3.6 Python 3.7

File details

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

File metadata

  • Download URL: conformity-1.26.0.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for conformity-1.26.0.tar.gz
Algorithm Hash digest
SHA256 5bcce682d74be0c82d9881ddb19faeb2244524cdcaff3aee351cfb1bbdf9e75d
MD5 1be4c8e7bb36fec7d66526d2442cbf9b
BLAKE2b-256 377095c069839bc48901268f47f6ee575f54c22b344f86a799c42d3e3aafee90

See more details on using hashes here.

File details

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

File metadata

  • Download URL: conformity-1.26.0-py27.py35.py36.py37-none-any.whl
  • Upload date:
  • Size: 50.6 kB
  • Tags: Python 2.7, Python 3.5, Python 3.6, Python 3.7
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

File hashes

Hashes for conformity-1.26.0-py27.py35.py36.py37-none-any.whl
Algorithm Hash digest
SHA256 39fe7142681d6a3cda1cd1cd6271860400a25f58ba92e1a623ad8b4f0737ef0f
MD5 74befdf4006b685884a9ee02343e1f15
BLAKE2b-256 4bc944fa200f1efbb7c8753c67f265de511225520d71962de5174802075a6f48

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