Skip to main content

Seamless polymorphic inheritance for Django models

Project description

https://travis-ci.org/django-polymorphic/django-polymorphic.svg?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!

The current release of django-polymorphic supports Django 1.11, 2.0 and Python 2.7 and 3.4+ is supported. For older Django versions, install django-polymorphic==1.3.

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

Uploaded Source

Built Distribution

django_polymorphic-2.0.1-py2.py3-none-any.whl (77.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-polymorphic-2.0.1.tar.gz
Algorithm Hash digest
SHA256 5fa58a0c45987771899717d0bd22eb59a39fe67334b7427e135ae86a19e4e4b3
MD5 aac049c40eb4a988b57423991164149e
BLAKE2b-256 f4fcb2083df3d48388b7f489fb5aa161c9283ea536f87af3829908caaba57c12

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_polymorphic-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7aad085c824e895b27f0f4e3a6c7e7feb265f8488aa9b8b3b9d2ba2ffd63e9e8
MD5 88242803044ab3c33c9ab675a94ae7d1
BLAKE2b-256 1454540103056d15bf06682f97d09f2aed8103916acbd326e4ca54b926d4e021

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