"Django JSON Field derivative which allows to specify Pydantic schema"
Project description
Django + Pydantic = 🖤
Django JSONField with Pydantic models as a Schema
Usage
import pydantic
from django.db import models
from django_pydantic_field import PydanticSchemaField
class Foo(pydantic.BaseModel):
count: int
size: float = 1.0
class Bar(pydantic.BaseModel):
slug: str = "foo_bar"
class MyModel(models.Model):
foo_field = PydanticSchemaField(schema=Foo)
bar_list = PydanticSchemaField(schema=list[Bar])
...
model = MyModel(foo_field={"count": "5"}, bar_list=[{}])
model.save()
assert model.foo_field == Foo(count=5, size=1.0)
assert model.bar_list == [Bar(slug="foo_bar")]
Django REST Framework support
from rest_framework import serializers
from django_pydantic_field.rest_framework import PydanticSchemaField
class MyModelSerializer(serializers.ModelSerializer):
foo_field = PydanticSchemaField(schema=Foo)
class Meta:
model = MyModel
fields = '__all__'
Global approach with typed parser
and renderer
classes
from rest_framework.decorators import api_view, parser_classes, renderer_classes
from django_pydantic_field.rest_framework import PydanticSchemaRenderer, PydanticSchemaParser
@api_view(["POST"])
@parser_classes([PydanticSchemaParser[Foo]]):
@renderer_classes([PydanticSchemaRenderer[list[Foo]]])
def foo_view(request):
assert isinstance(request.data, Foo)
count = request.data.count + 1
return Response([Foo(count=count)])
Acknowledgement
- Churkin Oleg for his Gist as a source of inspiration;
- Boutique Air Flight Operations platform as a test ground;
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
Close
Hashes for django-pydantic-field-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7701728a8b5d323576afc185f1e38de61f426740f58c3712136f347294d1261 |
|
MD5 | 193e33d70151f8f6f535da8988eb5a5d |
|
BLAKE2b-256 | 96b39512ce4e5b3bd15e248d5465db7f96db40ca414836e312bf7bc2bedef2f8 |
Close
Hashes for django_pydantic_field-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e38d0999968882598b765bbf2b07d98c0ab12d798d34ef92a20a29dc2d0e7e8 |
|
MD5 | a90a0c6bb2dd9e27246742201a581967 |
|
BLAKE2b-256 | 60daacaa0e766e8e8c37ee2a7f7f7750ebd9fc6af00946a3c11baeaa4900ac59 |