Skip to main content

Seamless polymorphic inheritance for Django models

Project description

https://github.com/jazzband/django-polymorphic/actions/workflows/test.yml/badge.svg https://img.shields.io/pypi/v/django-polymorphic.svg https://img.shields.io/codecov/c/github/jazzband/django-polymorphic/master.svg https://readthedocs.org/projects/django-polymorphic/badge/?version=stable 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 - 4.0 on Python 3.6+.

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

Installation

Install using pip

$ pip install django-polymorphic

At the moment we have an unoffical version (4.0.0a). While we wait to gain access to pip. If you want to use the latest version (which works for Django >4.0.0). You can install it using

pip install git+https://github.com/jazzband/django-polymorphic.git@v4.0.0a#egg=django-polymorphic

License

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

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

django_polymorphic-4.1.0.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

django_polymorphic-4.1.0-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

Details for the file django_polymorphic-4.1.0.tar.gz.

File metadata

  • Download URL: django_polymorphic-4.1.0.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for django_polymorphic-4.1.0.tar.gz
Algorithm Hash digest
SHA256 4438d95a0aef6c4307cd6c83ead387e1142ce80b65188a931ec2f0dbdd9bfc51
MD5 46fb18def8546dd1929b2e70484997b7
BLAKE2b-256 7a4cb8dc06147602b4c990e1094a1f230771fd65b2f9c1107f28afe1461ee249

See more details on using hashes here.

File details

Details for the file django_polymorphic-4.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_polymorphic-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ce3984999e103a0d1a434a5c5617f2c7f990dc3d5fb3585ce0fadadf9ff90ea
MD5 25a3e42191adb32f45cf9ed8bd914f7e
BLAKE2b-256 306600e6fc8ca9cf10ca41aa5d3d7746214fa7690138174c6716e9a08259bff2

See more details on using hashes here.

Supported by

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