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

Uploaded Source

Built Distribution

conformity-1.26.2-py27.py35.py36.py37-none-any.whl (50.8 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.2.tar.gz.

File metadata

  • Download URL: conformity-1.26.2.tar.gz
  • Upload date:
  • Size: 40.1 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.2.tar.gz
Algorithm Hash digest
SHA256 a1b17aa27a78a3e94034e90ded229a3f9987bde5d5fe310ef8c23b60a65828b6
MD5 c0b250b153cca41872b2b77b78d3948f
BLAKE2b-256 3675037d2e74ab21e98715dc0e69c0474a4003c47b2ef5b80a47e40abe9dd5da

See more details on using hashes here.

File details

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

File metadata

  • Download URL: conformity-1.26.2-py27.py35.py36.py37-none-any.whl
  • Upload date:
  • Size: 50.8 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.2-py27.py35.py36.py37-none-any.whl
Algorithm Hash digest
SHA256 cd44444536a06d21c918948918a190819112a1d7741f2c6ad15ef5de27cddbd8
MD5 8fc5f847375352b2418a2a03ab5f0def
BLAKE2b-256 5fc3b1ef41eb1b5d1b7358812d6b4f016a6fd1b13f85db1a04fed7c061861d88

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