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

Uploaded Source

Built Distribution

conformity-1.28.2-py27.py35.py36.py37.py38-none-any.whl (53.2 kB view details)

Uploaded Python 2.7 Python 3.5 Python 3.6 Python 3.7 Python 3.8

File details

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

File metadata

  • Download URL: conformity-1.28.2.tar.gz
  • Upload date:
  • Size: 43.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.1

File hashes

Hashes for conformity-1.28.2.tar.gz
Algorithm Hash digest
SHA256 4f47d84f83edfe0904bdaffb2eab21f215b8dc90c3fa5c9c85f523bbe39fe98d
MD5 00cba56716204ddc2ddd07f10ecfa3c0
BLAKE2b-256 e972aca3c4c7e9e12216a54bb093fae9f92d3938c0d9051bb9cd1d5f71da2f02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for conformity-1.28.2-py27.py35.py36.py37.py38-none-any.whl
Algorithm Hash digest
SHA256 e3dd522bdc3dac6982b3ce5b01a78afeb932c7a3dfb34ca7ce5b97de5190ab0c
MD5 adee3d3d0c77f1eeb6e054a46be4cf11
BLAKE2b-256 b861017489c1bec80b01bd13be8a254676f26addc4c437ec1092b3c61a14b4c3

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