Skip to main content

Cacheable schema description and validation

Project description

https://api.travis-ci.org/eventbrite/conformity.svg https://img.shields.io/pypi/v/conformity.svg https://img.shields.io/pypi/l/conformity.svg

A low-level, declarative schema validation library.

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).

Errors are always instances of conformity.error:Error, and each error has a message, a code, and a pointer:

  • message is a plain-language (English) explanation of the problem.

  • code is a machine-readable code that, in most cases, is INVALID (using the constant conformity.error:ERROR_CODE_INVALID). In Dictionary, the error code is MISSING (ERROR_CODE_MISSING) for required keys that aren’t present and UNKNOWN for extra keys that aren’t allowed. In Constant, the error code is UNKNOWN for values that don’t match the allowed value or values. In Polymorph, the error code is UNKNOWN for unknown switch values when no __default__ is present.

  • pointer is None for errors in most field types. However, for data structure field types (List, Dictionary, SchemalessDictionary, Tuple), pointer is a string representing the dotted path to the offending value in the structure.

Interface

Anything can be a Conformity validator as long as it follows this interface:

  • An errors(value) method that returns a list of conformity.error:Error objects for each error or an empty list or None if the value is clean.

  • An introspect() method, that returns a dictionary describing the field. The format of this dictionary has to vary by field, but it should reflect the names of keyword arguments passed into the constructor, and provide enough information to entirely re-create the field as-is. Any sub-fields declared for structures should be represented using their own introspect() output. The dictionary must also contain a type key that contains the name of the type, but this should use lower case and underscores rather than the class name. It can also contain a description key which should be interpreted as the human-readable reason for the field.

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

Uploaded Source

Built Distribution

conformity-1.15.1-py2.py3-none-any.whl (20.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: conformity-1.15.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for conformity-1.15.1.tar.gz
Algorithm Hash digest
SHA256 30e0d8827ae9648e641b60a3628131e05d2ffd2cc4ec86af2a989aca056d42c5
MD5 482a7d84d343313ef99f4127bd301300
BLAKE2b-256 b6a593658c53520896f246c0830cf38e3a6e37fa11713ea63ec0a660da710fd5

See more details on using hashes here.

File details

Details for the file conformity-1.15.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for conformity-1.15.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c49a504b794c78b17721bd9a35918927bbdb7e75628464a9accc22cd557377bb
MD5 7af6f96cf759f68aa07f1498bceb2c20
BLAKE2b-256 2b5ab8ea6a4276b72f74c2dd9a6f836851d236624d8a4355c70659ab656a7d21

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