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, 2.1, 2.2 and Python 2.7 and 3.5+ 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.1.tar.gz (100.3 kB view details)

Uploaded Source

Built Distribution

django_polymorphic-2.1-py2.py3-none-any.whl (79.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django-polymorphic-2.1.tar.gz
  • Upload date:
  • Size: 100.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.10.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16

File hashes

Hashes for django-polymorphic-2.1.tar.gz
Algorithm Hash digest
SHA256 5a3ea3f611e5f01f70dd04138fe6e18ad6684ab12397dbf0106539bf5b777253
MD5 b019b902c8cbd4bbe2cf8325649eb072
BLAKE2b-256 7cc08dc6226f55ce64202f6d30e0e19e1a6e9d66ad6f59dae99c7a55ecc9ec5b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_polymorphic-2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 79.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.10.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16

File hashes

Hashes for django_polymorphic-2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2bef8471d7d59a6d9d1d5fe4649795c21438a033d3c11a5b72a2e443415a5b0
MD5 2cc2cd0492d82cc770c0de9161905a21
BLAKE2b-256 642bc5f9f628a362cc5080300b3cf284ef1ad51d97b35aa3ade3f74fa08acfc2

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