Skip to main content

Seamless Polymorphic Inheritance for Django Models

Project description

https://travis-ci.org/django-polymorphic/django-polymorphic.png?branch=master https://img.shields.io/pypi/v/django-polymorphic.svg https://img.shields.io/codecov/c/github/django-polymorphic/django-polymorphic/master.svg

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 minumum amount of queries needed to fetch the inherited models.

  • Disabling polymorphic behavior when needed.

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

Install using pip

$ pip install 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-1.0.2.tar.gz (57.4 kB view details)

Uploaded Source

Built Distribution

django_polymorphic-1.0.2-py2.py3-none-any.whl (70.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-polymorphic-1.0.2.tar.gz.

File metadata

File hashes

Hashes for django-polymorphic-1.0.2.tar.gz
Algorithm Hash digest
SHA256 835c105155f76cee8bf04a4efd4759190458530c573f4f94c1c6fd61e9ac0bec
MD5 0c04f00c50e252ad5c2faf026709f50d
BLAKE2b-256 36c909587553e59a2225fbbd382221e2108214a3e9ddfa2053272246284ccfc8

See more details on using hashes here.

Provenance

File details

Details for the file django_polymorphic-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_polymorphic-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 60ed83135957bbcf92f48380f987decce43a35187e31d9f66143e103eeea9823
MD5 953f8aa9794a4f182302177bee939fa7
BLAKE2b-256 01d487caaa0a9e9c8144c13bf681dc7001b84eb452549c0322ca534c7f11236e

See more details on using hashes here.

Provenance

Supported by

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