This release is a pre-release and may not be stable for production use.
Python Data Structures for Humans™.
News
After a period of sparse activity, Schematics has again been under heavy development as of late.
It is recommended that new users get started with the latest development release instead of the stable release. To do this, add the --pre option when installing via pip:
pip install --pre schematics
About
Project documentation: http://schematics.readthedocs.org/en/latest/
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 DataError(e.messages)
schematics.exceptions.DataError: {'name': ['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
4 maintainers
Metadata
4 maintainers
Release files for schematics 2.0.0.dev2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| schematics-2.0.0.dev2.tar.gz | 77.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| schematics-2.0.0.dev2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 115.1 kB
Release files / schematics-2.0.0.dev2.tar.gz
| Download URL | schematics-2.0.0.dev2.tar.gz |
|---|---|
| Size | 77.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2f618222d40943c0c4163d1d8375d21f935cce735be4090018237134b8e169b2
|
|
BLAKE2b-256 checksum How to use checksums |
7246d7ce986b17bb63af10c20c1523cbc01cf77e3b792c2b3145bfb8367c19b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / schematics-2.0.0.dev2-py2.py3-none-any.whl
| Download URL | schematics-2.0.0.dev2-py2.py3-none-any.whl |
|---|---|
| Size | 37.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f0fa60ba4073e50588532c7ee0612d52172cd59708dacf30e74879cc16ba3acf
|
|
BLAKE2b-256 checksum How to use checksums |
7dad8f209a1116ac4a4db31eafdb5d1aa760ea3c22b62a0e8ba10d4ec3cfb1f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
