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

Uploaded Source

Built Distribution

django_polymorphic-0.7.1-py2.py3-none-any.whl (42.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django_polymorphic-0.7.1.tar.gz
Algorithm Hash digest
SHA256 b823e2afa55b1d9699899beafa975c34f1f0660d89a118c1a8eae734bbaccd4a
MD5 c6999aa8aa4d5a992e2664f050a8e858
BLAKE2b-256 ddb04be0812300f80ef5dcc48dbf8a6d9816bf7f5813a66f1e635dbacd7187dd

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_polymorphic-0.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2303bde18d01c4693bdc038463ac35f87c608733a8a194d23a03844b8162445
MD5 d094168f8e29f9f977dc9ec92891df91
BLAKE2b-256 ae5f12d4e86a91465be70436c9489bbba7bbf81a9befc124c1a867c0aece5574

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