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"}]'
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.0.tar.gz
(8.3 kB
view details)
Built Distribution
File details
Details for the file warlock-2.0.0.tar.gz.
File metadata
- Download URL: warlock-2.0.0.tar.gz
- Upload date:
- Size: 8.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da0ba3f37a6a54ee6b4f6c976906ca87f6524511839d5e6d556d752f9366525f |
|
| MD5 | d56c4c98ca812af37987972e03d54ef7 |
|
| BLAKE2b-256 | 6eb61c522aa08497b1460a619af3d11110da51548013597a4745b3524520fa1a |
Provenance
File details
Details for the file warlock-2.0.0-py3-none-any.whl.
File metadata
- Download URL: warlock-2.0.0-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3037ab9356b29e4539d6333860bf18207c48d09735786188cb30e7684fc5e901 |
|
| MD5 | 246bcb389159422b04025746842a675f |
|
| BLAKE2b-256 | b04b404d128541d6bda8bab856372e6ffce8c02e60a70eff43e9c6745920b28d |
