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

Uploaded Source

Built Distribution

django_polymorphic-2.1.1-py2.py3-none-any.whl (79.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django-polymorphic-2.1.1.tar.gz
  • Upload date:
  • Size: 102.2 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.1.tar.gz
Algorithm Hash digest
SHA256 b8da127b93a441720d9709c8a8c61e1d3b3faec0578c59bdbccbb15117dce7ea
MD5 5b4078aeff71e0c60887f1d2acaf3d06
BLAKE2b-256 138e4770e05e29a95b06601e96c2ca3c92c6f2265342bba1cf24a2fdd3e40597

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_polymorphic-2.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 79.3 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.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9768cd419481fb38ce901642c2b5950ba55e428d37640a28b8bc6dd91b28a7d8
MD5 935d75596e770b3840ca6890189a52f5
BLAKE2b-256 c8144b2d883d786e7af1e79acebce96025d461b1fe19ccc0412d78ed75f36606

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