Brian Kohan

Brian Kohan

On software, governance, nonprofits, building things and trying to live a good life.

django-polymorphic

1807 stars 10259930 downloads
Brian Kohan
Software
django open source python

I am the maintainer of django-polymorphic which is an installable Django application written in python. It allows database tables to behave polymorphically in the Object Oriented programming sense at your application level.

I am not the original author of django-polymorphic. The previous authors and maintainers are in order:

  1. Bert Constantin
  2. Chris Glass
  3. Diederik van der Boor
  4. Jerome Leclanche

django-polymorphic is part of the jazzband organization. I am actively seeking additional maintainers.

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

Postgres MySQL MariaDB SQLite Oracle

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!

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

Installation

    $ pip install django-polymorphic

INSTALLED_APPS = [
  ...
  "django.contrib.contenttypes",  # we rely on the contenttypes framework
  "polymorphic"
]

License

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

Stars and Downloads

Package Index
Changelog
Documentation
Download
Issues
Repository

Recent Software

Software Tags

django open source python Sphinx homelessness