Tools to convert Django ORM models to Pydantic models.
Documentation: https://xshapira.github.io/dantico/
The key features are:
-
Custom Field Support: Create Pydantic Schemas from Django Models with default field type validations out of the box.
-
Field Validator: Fields can be validated with Pydantic validator or root_validator.
- Python 3.7+
- Django 3.0+
- Pydantic 1.6+
pip install dantico
Assume we have the following user model definition:
# models.py
from django.db import models
class User(models.Model):
GENDER_MALE = "male"
GENDER_FEMALE = "female"
GENDER_OTHER = "other"
GENDER_CHOICES = (
(GENDER_MALE, "Male"),
(GENDER_FEMALE, "Female"),
(GENDER_OTHER, "Other"),
)
username = models.CharField(max_length=20)
age = models.IntegerField()
gender = models.CharField(
choices=GENDER_CHOICES,
max_length=10,
blank=True,
)
password = models.CharField(max_length=100)
company = models.ForeignKey(
Company,
on_delete=models.CASCADE,
)
languages = models.ManyToManyField(Language)
def __str__(self):
return self.nameUsing the ModelSchema class will automatically generate schemas from our User model.
# schemas.py
from dantico import ModelSchema
from users.models import User
class UserSchema(ModelSchema):
class Config:
model = User
json_output = json.dumps(UserSchema.schema(), indent=4)
print(json_output)
# Output:
{
"title": "UserSchema",
"type": "object",
"properties": {
"id": {
"title": "Id",
"extra": {},
"type": "integer"
},
"Username": {
"title": "Username",
"maxLength": 20,
"type": "string"
},
"age": {
"title": "Age",
"type": "integer"
},
"gender": {
"title": "Gender",
"allOf": [
{
"$ref": "#/definitions/GenderEnum"
}
]
},
"password": {
"title": "Password",
"maxLength": 100,
"type": "string"
},
"company_id": {
"title": "Company",
"type": "integer"
},
"languages": {
"title": "Languages",
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"Username",
"age",
"password",
"company_id",
"languages"
],
"definitions": {
"GenderEnum": {
"title": "GenderEnum",
"description": "An enumeration.",
"enum": [
"male",
"female",
"other"
]
}
}
}This project is licensed under the terms of the MIT license.