Another Python API schema handling and JSON (de)serialization through typing annotation; light, simple, powerful.
Project description
Apischema
Makes your life easier when it comes to python API.
JSON (de)serialization + schema generation through python typing, with a spoonful of sugar.
Documentation
https://wyfo.github.io/apischema/
Install
pip install apischema
It requires only Python 3.6+ (and dataclasses official backport for version 3.6 only)
Why another library?
This library fulfill the following goals:
- stay as close as possible to the standard library (dataclasses, typing, etc.) to be as accessible as possible — as a consequence do not need plugins for editor/linter/etc.;
- be additive and tunable, be able to work with user own types as well as foreign libraries ones; do not need a PR for handling new types like
bson.ObjectId
; - avoid dynamic things like using string for attribute name.
No known alternative achieves that.
Example
from dataclasses import dataclass, field
from typing import List, Set
from uuid import UUID, uuid4
from pytest import raises
from apischema import ValidationError, deserialization_schema, deserialize, serialize
# Define a schema with standard dataclasses
@dataclass
class Resource:
id: UUID
name: str
tags: Set[str] = field(default_factory=set)
# Get some data
uuid = uuid4()
data = {"id": str(uuid), "name": "wyfo", "tags": ["some_tag"]}
# Deserialize data
resource = deserialize(Resource, data)
assert resource == Resource(uuid, "wyfo", {"some_tag"})
# Serialize objects
assert serialize(resource) == data
# Validate during deserialization
with raises(ValidationError) as err: # pytest check exception is raised
deserialize(Resource, {"id": "42", "name": "wyfo"})
assert serialize(err.value) == [ # ValidationError is serializable
{"loc": ["id"], "err": ["badly formed hexadecimal UUID string"]}
]
# Generate JSON Schema
assert deserialization_schema(Resource) == {
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"type": "object",
"properties": {
"id": {"type": "string", "format": "uuid"},
"name": {"type": "string"},
"tags": {"type": "array", "items": {"type": "string"}, "uniqueItems": True},
},
"required": ["id", "name"],
"additionalProperties": False,
}
Apischema works out of the box with your data model.
(This example and further ones are using pytest stuff because they are in fact run as tests in the library CI; that's very convenient)
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
Built Distribution
Hashes for apischema-0.7.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 111beedf26e5240c5364a43cb8177b3f4bc629188c1914d1a7e30e90f56fe35e |
|
MD5 | 294fe40480906693f2222043327d21e0 |
|
BLAKE2b-256 | a4c64dbae1a17c2ce1cc9a51ab6c1271ea67c6907bbb28be4f80f5f52a36366f |