djdantic 0.0.2

Utilities to use pydantic with the django orm

djdantic

A utility library to integrate and use pydantic with the django orm. This package includes optional sentry integration using sentry-tools.

🚧 This project is WIP and is subject to change at any time

This project is currently in the alpha state, even though it can be used in production with some caution. Make sure to fix the version in your requirements.txt and review changes frequently.

Installation

pip install djdantic

Features

pydantic to django Data Schema Conversion

• djdantic.utils.pydantic_django.DjangoORMBaseModel
  Provides from_orm method on pydantic schema
• djdantic.utils.pydantic_django.transfer_from_orm
• djdantic.utils.pydantic_django.transfer_to_orm

If automatic route generation is used, it is not neccessary to use the transfer_* methods manually.

Options for pydantic's Field

For mapping pydantic schemas to django models, it is required to add at least one of the following extra arguments to each field defined in a pydantic schema.

• orm_field: django.db.models.Field (required)
  Pointer (reference) to the corresponding model field, e. g. myapp.models.MyModel.id
• orm_method: Optional[Callable[[Self], Any] | Callable[[Self, Any], None]]
  Pointer to a orm model method, which is called when the object is loaded from the orm into a pydantic model or written into the orm from a pydantic model, e. g. myapp.models.MyModel.get_calculated_value
• scopes: Optional[List[str]]
  Limit access to specific fields based on jwt token scopes. For read operations, only scopes with the action read are taken into account, for write all other scopes are taken into account.
• is_critical: Optional[bool]
  Limit write access to the field based on the presence of the crt flag in the jwt token.
• sync_matching: Optional[List[Tuple[str, django.db.models.Field]]]
  Used for performing a transfer_to_orm with action TransferAction.SYNC for included sub-records (in a list), used when no id field is present on the object. Mapping from pydantic field (dot notation for nested fields can be used) to the corresponding django model field.

Example for Schemas

from pydantic import Field, BaseModel
from djdantic.utils.pydantic_django import DjangoORMBaseModel
from ... import models


class User(DjangoORMBaseModel):
    email: str = Field(orm_field=models.User.email)
    is_password_usable: bool = Field(orm_method=models.User.has_usable_password)
    is_superuser: bool = Field(scopes=['access.users.update.any'], is_critical=True, orm_field=models.User.is_superuser)


class UserUpdate(BaseModel):
    password: Optional[SecretStr] = Field(orm_method=models.User.set_password, is_critical=True)


class OrderUpdate(BaseModel):
    items: Optional[List['OrderItemUpdate']] = Field(
        orm_field=models.Order.items,
        sync_matching=[
            ('product', models.OrderItem.product),
        ],
    )