Structured Data for Humans
Project description
Python Data Structures for Humans™.
For more information, please see our documentation: http://schematics.readthedocs.org/en/latest/
About
Schematics is a Python library to combine types into structures, validate them, and transform the shapes of your data based on simple descriptions.
The internals are similar to ORM type systems, but there is no database layer in Schematics. Instead, we believe that building a database layer is made significantly easier when Schematics handles everything but writing the query.
Further, it can be used for a range of tasks where having a database involved may not make sense.
Some common use cases:
Design and document specific data structures
Convert structures to and from different formats such as JSON or MsgPack
Validate API inputs
Remove fields based on access rights of some data’s recipient
Define message formats for communications protocols, like an RPC
Custom persistence layers
Example
This is a simple Model.
>>> from schematics.models import Model
>>> from schematics.types import StringType, URLType
>>> class Person(Model):
... name = StringType(required=True)
... website = URLType()
...
>>> person = Person({'name': u'Joe Strummer',
... 'website': 'http://soundcloud.com/joestrummer'})
>>> person.name
u'Joe Strummer'
Serializing the data to JSON.
>>> import json
>>> json.dumps(person.to_primitive())
{"name": "Joe Strummer", "website": "http://soundcloud.com/joestrummer"}
Let’s try validating without a name value, since it’s required.
>>> person = Person()
>>> person.website = 'http://www.amontobin.com/'
>>> person.validate()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "schematics/models.py", line 231, in validate
raise ModelValidationError(e.messages)
schematics.exceptions.ModelValidationError: {'name': [u'This field is required.']}
Add the field and validation passes:
>>> person = Person() >>> person.name = 'Amon Tobin' >>> person.website = 'http://www.amontobin.com/' >>> person.validate() >>>
Testing & Coverage support
Run coverage and check the missing statements.
$ `coverage run --source schematics -m py.test && coverage report`
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
File details
Details for the file schematics-1.1.2.tar.gz.
File metadata
- Download URL: schematics-1.1.2.tar.gz
- Upload date:
- Size: 62.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b9b73def56f9a4a0f44612cb06842069101a5e92fb2007361276806df0709221 |
|
| MD5 | 3f77f25d07b227096b2e1ee14064e916 |
|
| BLAKE2b-256 | 6ca2051c36190d07e9ec6f2e9fc0f3cce2fac2ea6824b561acfcb3557a4be089 |
