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

Uploaded Source

Built Distribution

django_polymorphic-2.0.3-py2.py3-none-any.whl (74.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django-polymorphic-2.0.3.tar.gz
  • Upload date:
  • Size: 97.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/38.5.2 requests-toolbelt/0.8.0 tqdm/4.19.6 CPython/3.6.1

File hashes

Hashes for django-polymorphic-2.0.3.tar.gz
Algorithm Hash digest
SHA256 1fb5505537bcaf71cfc951ff94c4e3ba83c761eaca04b7b2ce9cb63937634ea5
MD5 92199d7126eb71f8cebbabb256eab487
BLAKE2b-256 aed6bebbc990b5856c36603cd0d635e93137fdf67ec04386ac1bdc87707f9613

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_polymorphic-2.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 74.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/38.5.2 requests-toolbelt/0.8.0 tqdm/4.19.6 CPython/3.6.1

File hashes

Hashes for django_polymorphic-2.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 79e7df455fdc8c3d28d38b7ab8323fc21d109a162b8ca282119e0e9ce8db7bdb
MD5 ba3f812b7bcbc6cf8f737f6b8b2a3963
BLAKE2b-256 c1a9468973be0538e6c516499db460a34c77bfbf16c32b7f5f1ef09cb5e39401

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