django2pydantic is the most complete Pydantic schemas based on Django models.

django2pydantic is a library that allows to define Pydantic schemas based on Django database models.

Similar libraries:

• Djantic
• Django Ninja Schema
• Ninja Schema

• Supports all Django model field types
• Supports @property decorated Django model methods
• Supports all Django model relation fields:
  • ForeignKey, OneToOneField, ManyToManyField
  • The reverse relations of the above (ManyToOneRel, OneToOneRel, ManyToManyRel)
• Supports defining nested relations
• Provides as complete OpenAPI schema details as possible
• Support for SchemaField

See the following usage examples:

• Basic usage example
• Overriding Django field properties by using InferExcept
• Making required Django fields optional in Pydantic schema

There are some nuances related to the use of blank and null in Django fields and how they impact the output pydantic types, but generally:

• If null=True the output type will be Optional (i.e. str | None).
• If blank=True the field will be optional (with exceptions). This is to be more in line with the Django admin/form validation behavior.
• Whether the field is required is determined by the default value (can be overridden).
  • If the default is PydanticUndefined, the field is always required.
  • If the default is None (or "" in case of string), the field is optional.
• If null=False and blank=True, the field typically requires implementing clean() on the model in order to programmatically supply any missing values. In our case, the required/default value can vary depending on field type in a way that user does not need to concern with implementing clean().

This covers the following Django field types:

• CharField
• SlugField
• EmailField
• URLField
• TextField

This covers the following Django field types:

• IntegerField
• SmallIntegerField
• IntegerField
• BigIntegerField
• PositiveSmallIntegerField
• PositiveIntegerField
• PositiveBigIntegerField
• FloatField
• DecimalField
• BinaryField
• BooleanField
• DateField
• DateTimeField
• DurationField
• FileField
• FilePathField
• GenericIPAddressField
• ImageField
• JSONField
• TimeField
• UUIDField

[FieldType] varies depending on the Django field type

This covers the following Django field types:

• ForeignKey
• OneToOneField
• ManyToManyField
• ManyToOneRel
• OneToOneRel
• ManyToManyRel

[PkType] varies depending on model's primary key type

null has no effect since there is no way to require a relationship at the database level. Ref: https://docs.djangoproject.com/en/5.1/ref/models/fields/#manytomanyfield

This field is created as a result of OneToOneField and is not directly configurable.

These fields are created as a result of ForeignKey, ManyToManyField and are not directly configurable.