Skip to main content

Seamless Polymorphic Inheritance for Django Models

Project description

build-status

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.

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-0.7.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

django_polymorphic-0.7-py2.py3-none-any.whl (42.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django_polymorphic-0.7.tar.gz
Algorithm Hash digest
SHA256 adf2d21e611bafee269660fe59218f63ac7a79aaadcbc2cabc19a1c57641336c
MD5 214a211fcfb6bcbcdb80ed5334e09660
BLAKE2b-256 19375bf87d87f3a5ff1174c26e45158dec2ef675b5e4a63c529199aab923ddea

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_polymorphic-0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 423c247aac96ddccada67c1cabce08a48963a9c2c6daeaa7f71151466a5c1805
MD5 303f721e89a02bf6c00314e459472f22
BLAKE2b-256 2d2609909a2318624e0ff5b385354a92dc9c3b6941db9199a695340769b8a3de

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