Skip to main content

Pydantic interop for didactic — adapters for incremental migration.

Project description

didactic-pydantic

Bidirectional adapter between pydantic.BaseModel and dx.Model.

PyPI Python License CI Docs

Contributes didactic.pydantic to the namespace package.

Install

pip install didactic-pydantic

The package depends on didactic and pydantic>=2.10.

Quickstart

from_pydantic converts a pydantic.BaseModel subclass into a dx.Model subclass:

from pydantic import BaseModel, Field
from didactic.pydantic import from_pydantic


class PydUser(BaseModel):
    id: str
    email: str = Field(description="primary contact")


User = from_pydantic(PydUser)

Field annotations, defaults, factories, aliases, descriptions, examples, and the deprecated flag carry across. Annotated[T, ...] constraint metadata flows through unchanged, so annotated-types primitives (Ge, Le, ...) continue to produce axioms on the didactic side.

Custom Pydantic validators (@field_validator, @model_validator), @computed_field, and discriminated unions are not translated; the Pydantic interop guide lists the didactic-side replacements.

to_pydantic is the inverse direction:

import didactic.api as dx
from didactic.pydantic import to_pydantic


class User(dx.Model):
    id: str
    email: str = dx.field(description="primary contact")


PydUser = to_pydantic(User)

Use to_pydantic to expose a dx.Model to FastAPI, OpenAPI generators, or any other Pydantic-shaped tool. The conversion is cached, so repeated calls with the same input return the same Pydantic class.

Documentation

See Guides > Pydantic interop for the full feature matrix and round-trip behaviour.

License

Released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

didactic_pydantic-0.4.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

didactic_pydantic-0.4.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file didactic_pydantic-0.4.0.tar.gz.

File metadata

  • Download URL: didactic_pydantic-0.4.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for didactic_pydantic-0.4.0.tar.gz
Algorithm Hash digest
SHA256 9da25df1518e456b12f7e4f04b9c93e014df74c09a419cec932aefb2ac4a1a82
MD5 d7a9d561b72e58cf6bca4bd9213d6d5e
BLAKE2b-256 1f09533d4ad62c33a9287750fa3ccb25ce5744508b395f9b44ba13afa5cf7ebb

See more details on using hashes here.

Provenance

The following attestation bundles were made for didactic_pydantic-0.4.0.tar.gz:

Publisher: release.yml on panproto/didactic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file didactic_pydantic-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for didactic_pydantic-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8612dbc8ec898a34323d76ef17a3e96ed64a59a0da726cd6d82c975bc618cc4c
MD5 cd7e50d1dd6c0e4355a9d19d1d665a45
BLAKE2b-256 de086e15173eae12d5a1c61f0721dd1c15f535676b5f3a79efff439aa09cfb72

See more details on using hashes here.

Provenance

The following attestation bundles were made for didactic_pydantic-0.4.0-py3-none-any.whl:

Publisher: release.yml on panproto/didactic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page