Improved Django model inheritance with automatic downcasting
Go to file
Brian Kohan 27011eea07
Merge pull request #663 from bckohan/master
Fix release CI check
2025-08-26 14:36:32 -07:00
.github/workflows fix release CI check 2025-08-26 14:35:29 -07:00
docs update changelog 2025-08-26 14:33:37 -07:00
example [pre-commit.ci] auto fixes from pre-commit.com hooks 2024-03-12 20:23:19 +00:00
src/polymorphic refresh docs, add missing intersphinx references, update CONTRIBUTING 2025-08-26 14:24:17 -07:00
.gitignore add justfile interface for command package management tasks, lint docs, change precommit to use just interface and update lint GHA accordingly 2025-08-24 17:33:58 -07:00
.pre-commit-config.yaml add justfile interface for command package management tasks, lint docs, change precommit to use just interface and update lint GHA accordingly 2025-08-24 17:33:58 -07:00
.readthedocs.yaml fix rtd build 2025-08-24 21:37:30 -07:00
AUTHORS.md rename CI workflow to Lint, move all rst repo level doc files (like README) to markdown 2025-08-23 15:07:51 -07:00
CONTRIBUTING.md refresh docs, add missing intersphinx references, update CONTRIBUTING 2025-08-26 14:24:17 -07:00
justfile Add tests to all django supported RDBMS to CI, also add macos and windows tests. 2025-08-25 23:44:18 -07:00
LICENSE updated docs, and moved them to DOCS.rst and README.rst 2010-01-26 14:28:22 +01:00
manage.py Use py.test for testing 2023-12-18 14:54:02 +02:00
pyproject.toml refresh docs, add missing intersphinx references, update CONTRIBUTING 2025-08-26 14:24:17 -07:00
README.md fix CI badges 2025-08-23 15:13:10 -07:00
tox.ini Modernize build to use uv and hatchling as the build backend. 2025-08-22 21:48:37 -07:00
uv.lock refresh docs, add missing intersphinx references, update CONTRIBUTING 2025-08-26 14:24:17 -07:00

django-polymorphic

License: BSD Ruff PyPI version PyPI pyversions PyPI djversions PyPI status Documentation Status Code Cov Test Status Lint Status Published on Django Packages Jazzband

Polymorphic Models for Django

django-polymorphic simplifies using inherited models in Django projects. When a query is made at the base model, the inherited model classes are returned.

When we store models that inherit from a Project model...


    >>> Project.objects.create(topic="Department Party")
    >>> ArtProject.objects.create(topic="Painting with Tim", artist="T. Turner")
    >>> ResearchProject.objects.create(topic="Swallow Aerodynamics", supervisor="Dr. Winter")

...and want to retrieve all our projects, the subclassed models are returned!


    >>> Project.objects.all()
    [ <Project:         id 1, topic "Department Party">,
      <ArtProject:      id 2, topic "Painting with Tim", artist "T. Turner">,
      <ResearchProject: id 3, topic "Swallow Aerodynamics", supervisor "Dr. Winter"> ]

Using vanilla Django, we get the base class objects, which is rarely what we wanted:


    >>> Project.objects.all()
    [ <Project: id 1, topic "Department Party">,
      <Project: id 2, topic "Painting with Tim">,
      <Project: id 3, topic "Swallow Aerodynamics"> ]

This also works when the polymorphic model is accessed via ForeignKeys, ManyToManyFields or OneToOneFields.

Features

  • Full admin integration.

  • ORM integration:

    • support for ForeignKey, ManyToManyField, OneToOneField descriptors.
    • Filtering/ordering of inherited models (ArtProject___artist).
    • Filtering model types: instance_of(...) and not_instance_of(...)
    • Combining querysets of different models (qs3 = qs1 | qs2)
    • Support for custom user-defined managers.
  • Uses the minimum amount of queries needed to fetch the inherited models.

  • Disabling polymorphic behavior when needed.

Note: While django-polymorphic makes subclassed models easy to use in Django, we still encourage to use them with caution. Each subclassed model will require Django to perform an INNER JOIN to fetch the model fields from the database. While taking this in mind, there are valid reasons for using subclassed models. That's what this library is designed for!

The current release of django-polymorphic supports Django 2.2 - 5.2 on Python 3.9+.

For more information, see the documentation at Read the Docs.

Installation

    $ pip install django-polymorphic

License

django-polymorphic uses the same license as Django (BSD-like).