PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Python object model built on JSON schema and JSON patch.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bcwaldon from gravatar.com bcwaldon Avatar for janw from gravatar.com janw Avatar for stephenfin from gravatar.com stephenfin

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache-2.0)
  • Author: Brian Waldon
  • Maintainer: Jan Willhaus
  • Tags JSON schema, JSON patch, model validation
  • Requires: Python >=3.7, <4.0
Classifiers
Report project as malware

Project description

Warlock 🧙‍♀️

Create self-validating Python objects using JSON schema.

PyPI PyPI - Python Version PyPI - Downloads

Build Status Coverage Status GitHub commits since latest release (branch)

Package management: poetry Code Style Black

Installation

Warlock is available on PyPI:

pip install warlock

Usage

  1. Create your schema

    >>> schema = {
    'name': 'Country',
    'properties': {
        'name': {'type': 'string'},
        'abbreviation': {'type': 'string'},
        'population': {'type': 'integer'},
    },
    'additionalProperties': False,
}

  2. Create a model

    >>> import warlock
>>> Country = warlock.model_factory(schema)

  3. Create an object using your model

    >>> sweden = Country(name='Sweden', abbreviation='SE')

  4. Let the object validate itself

    >>> sweden.name = 5
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "warlock/core.py", line 53, in __setattr__
    raise InvalidOperation(msg)
warlock.core.InvalidOperation: Unable to set 'name' to '5'

>>> sweden.overlord = 'Bears'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "warlock/core.py", line 53, in __setattr__
    raise InvalidOperation(msg)
warlock.core.InvalidOperation: Unable to set 'overlord' to 'Bears'

  5. Generate a JSON Patch document to track changes

    >>> sweden.population=9453000
>>> sweden.patch
'[{"path": "/population", "value": 9453000, "op": "add"}]'

Supported by

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