Skip to main content

The missing polymorphic engine for Pydantic. disdantic simplifies registries and discriminated unions with automatic model discovery and auto-importing, helping you manage polymorphic data shapes with less boilerplate.

Project description

disdantic Logo

The missing polymorphic engine for Pydantic.

GitHub Release PyPI Release Supported Python Versions
CI Status
Open Issues License

Documentation | Roadmap | Issues | Discussions


Overview

disdantic is a lightweight Python toolkit designed to simplify Pydantic subclass registries, dynamic polymorphic unions, and automatic model discovery. By eliminating the manual boilerplate of maintaining union types and tracking child class imports, it allows you to build clean, extensible, and self-updating polymorphic domain models.

Why Use disdantic?

  • Decoupled Registries: Fully isolated subclass tracking namespaces prevent collisions between distinct model domains.
  • Dynamic Tagged Unions: Automatic core schema generation dynamically routes incoming JSON payload validation based on a customizable discriminator key.
  • Topological Schema Rebuilding: Dynamic subclass registrations trigger cascade schema reloading up the dependent parent MRO trees.
  • Automatic Discovery & Auto-Import: Traverses folders recursively to discover and import submodules, ensuring subclasses register themselves without manual imports.
  • Robust Object Introspection: Extracts slots, properties, and attributes into sanitized primitives, handling circular references and lazy loader proxies safely.
  • CLI Diagnostics Suite: Scans, lists, validates compilation integrity, and exports schemas.

Comparisons

Feature Pure Pydantic v2 Pydantic + disdantic
Union Type Definitions Manual list (e.g., Union[A, B, C]) Automatic tagged union via registry base class
New Subclass Adding Modify parent union type and import Register via decorator; schema cascades automatically
Dynamic Import Scanning Manual importlib boilerplate Declarative packages scan via AutoImporterMixin
Integrity Auditing Manual script validation Programmatic and CLI-based diagnostics
Schema Generation model_json_schema() on static types Command-line extraction via disdantic schema

Quick Start

Installation

pip install disdantic

For advanced features like YAML serialization, install the optional package extra:

pip install disdantic[yaml]

Core Usage Example

from typing import Literal
from disdantic import PydanticClassRegistryMixin
from pydantic import BaseModel

# 1. Define a polymorphic base registry class
class Message(PydanticClassRegistryMixin):
    schema_discriminator = "msg_type"  # Custom tag field name
    msg_type: str

# 2. Register subclass implementations dynamically
@Message.register("text")
class TextMessage(Message):
    msg_type: Literal["text"] = "text"
    content: str

@Message.register("image")
class ImageMessage(Message):
    msg_type: Literal["image"] = "image"
    url: str
    caption: str | None = None

# 3. Parents automatically rebuild to accommodate new subtypes
class ChatRoom(BaseModel):
    room_name: str
    messages: list[Message]  # Polymorphic union field

# 4. Incoming payloads validate dynamically to correct subclass types
payload = {
    "room_name": "General Chat",
    "messages": [
        {"msg_type": "text", "content": "Hello world!"},
        {"msg_type": "image", "url": "https://placehold.co/150.png", "caption": "Logo"}
    ]
}

room = ChatRoom.model_validate(payload)
assert isinstance(room.messages[0], TextMessage)
assert isinstance(room.messages[1], ImageMessage)

# 5. Full marshalling flow (serialization and deserialization)
room_data = room.model_dump()
# msg_type is automatically included in the serialized output!
assert room_data["messages"][0]["msg_type"] == "text"
assert room_data["messages"][1]["msg_type"] == "image"

restored_room = ChatRoom.model_validate(room_data)
assert isinstance(restored_room.messages[0], TextMessage)
assert isinstance(restored_room.messages[1], ImageMessage)

Component Architecture

  • src/disdantic/: Library package containing runtime implementations.
    • registry.py: Core RegistryMixin, PydanticClassRegistryMixin, and global RegistryManager.
    • model.py: Abstract ReloadableBaseModel enabling topological cascading rebuilds.
    • diagnose.py: Registry integrity check orchestrator and compile validation check.
    • introspection.py: Recursively maps complex objects to primitives via InfoMixin.
    • loading.py: Thread-safe deferred instantiation with LazyLoader and LazyProxy.
    • settings.py: Centralized Settings utilizing Pydantic Settings.
  • tests/: Multi-tiered testing suite (python/unit/, python/integration/, and e2e/).
  • docs/: Markdown files compiled using Zensical static site generator.
  • examples/: Self-contained runnable scripts demonstrating configurations.

Advanced Usage & Documentation

For detailed information on configuration settings, custom handlers, CLI commands, and operational guides, visit the Documentation Site.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines and DEVELOPING.md for development setup instructions.

Ensure you adhere to our Code of Conduct in all community interactions.

Support & Security

License

Licensed under the Apache License 2.0. See the LICENSE file for details.

Citations

If you use this repository or the resulting software in your research, please cite it using the following BibTeX entry:

@software{disdantic,
  author = {markurtz},
  title = {disdantic},
  year = 2026,
  url = {https://github.com/markurtz/disdantic}
}

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

disdantic-0.2.0a20260613.tar.gz (604.5 kB view details)

Uploaded Source

Built Distribution

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

disdantic-0.2.0a20260613-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

Details for the file disdantic-0.2.0a20260613.tar.gz.

File metadata

  • Download URL: disdantic-0.2.0a20260613.tar.gz
  • Upload date:
  • Size: 604.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for disdantic-0.2.0a20260613.tar.gz
Algorithm Hash digest
SHA256 4bf355f987deb84a17e5146ed8bb2b4ad209c71fba8576bd8d1b82b3b98be331
MD5 81a6d7997e9cbe13ed3fd5c9e02c16c5
BLAKE2b-256 811c0ea8c7911d0b735abb2bbf8fb249feff0af26bf25c38fbcf0d84f8277ff9

See more details on using hashes here.

Provenance

The following attestation bundles were made for disdantic-0.2.0a20260613.tar.gz:

Publisher: pipeline-nightly.yml on markurtz/disdantic

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

File details

Details for the file disdantic-0.2.0a20260613-py3-none-any.whl.

File metadata

File hashes

Hashes for disdantic-0.2.0a20260613-py3-none-any.whl
Algorithm Hash digest
SHA256 750ea3d349d2f8c31bc7e0e4c49e4631e8c9bc6e90c947289cc0fc55ee2bb6c3
MD5 fdc425a9f11e1a126e7d963958364088
BLAKE2b-256 aa35e3e01eace152b94785066e76b15b6c4b5032c7590fa9f10fc70acfee7c68

See more details on using hashes here.

Provenance

The following attestation bundles were made for disdantic-0.2.0a20260613-py3-none-any.whl:

Publisher: pipeline-nightly.yml on markurtz/disdantic

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