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.1b1.tar.gz (99.1 kB view details)

Uploaded Source

Built Distribution

django_polymorphic-1.1b1-py2.py3-none-any.whl (77.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-polymorphic-1.1b1.tar.gz.

File metadata

File hashes

Hashes for django-polymorphic-1.1b1.tar.gz
Algorithm Hash digest
SHA256 161260e4ea121ff7f58f112d306efe5f6a3f2d2b20fcbacaa648427da1a0c746
MD5 9120f8f4dd9e7096a616fd59c264e4e8
BLAKE2b-256 47bb8a8e2b5cb521edeb8580761e3f1d522edfc54ef251a83c0551e1706d6c15

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_polymorphic-1.1b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9cc7a32cc683e88ea49fd5f91b9cd0d4996a2c6dd00245280f38e810afc0788c
MD5 bdefc2b32040214f1db94393aa40e91d
BLAKE2b-256 05bfa8f793b7bd69c883bdb788e4ca10fe2b5fb32e0a33f1dc0a52cdf1282262

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