Python object model built on JSON schema and JSON patch.
Project description
Warlock 🧙♀️
Create self-validating Python objects using JSON schema.
Installation
Warlock is available on PyPI:
pip install warlock
Usage
-
Create your schema
>>> schema = { 'name': 'Country', 'properties': { 'name': {'type': 'string'}, 'abbreviation': {'type': 'string'}, 'population': {'type': 'integer'}, }, 'additionalProperties': False, }
-
Create a model
>>> import warlock >>> Country = warlock.model_factory(schema)
-
Create an object using your model
>>> sweden = Country(name='Sweden', abbreviation='SE')
-
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'
-
Generate a JSON Patch document to track changes
>>> sweden.population=9453000 >>> sweden.patch '[{"path": "/population", "value": 9453000, "op": "add"}]'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
warlock-2.0.1.tar.gz
(8.3 kB
view hashes)