Skip to main content

Efficient tree-based datastructure for Django

Project description

Build Status Code Health Badge Documentation Status Test Coverage Version Badge License Badge

django-closuretree is an implementation of the closure tree technique for Django applications designed to provide efficient querying of tree-based structures in a relational database. Its goal is to reduce the number of queries required when querying the children or parents of a given object.

Given the following model:

class Node(models.Model):
    name = models.CharField(max_length=24)
    parent = models.ForeignKey('self', related_name='children')

The children of each model can be queried with:

Node.objects.get(name='A').children.all()

However, for recursive lookups, this results in a large number of queries. Instead, django-closuretree allows you to extract them all in one go:

from closuretree.models import ClosureModel

class Node(ClosureModel):
    name = models.CharField(max_length=24)
    parent = models.ForeignKey('self', related_name='children')

Node.objects.get(name='A').get_descendants()

A single query will obtain all the descendants.

Quick Start

  • Install django-closuretree with pip install django-closuretree.

  • Inherit your models from closuretree.models.ClosureModel instead of django.db.models.Model.

That’s it. You can now use get_descendants() and get_ancestors() on a model instance.

If you’re adding this to an existing application that already has data in the database, you’ll need to run the rebuildtable() method of each model before the closure tree will be populated with the existing data:

Node.rebuildtable()

Contributing

To contribute, fork the repo, do your work, and issue a pull request. We ask that contributors adhere to PEP8 standards, and include full tests for all their code.

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-closuretree-1.1.7.tar.gz (11.8 kB view details)

Uploaded Source

Built Distributions

django_closuretree-1.1.7-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

django_closuretree-1.1.7-py2-none-any.whl (11.2 kB view details)

Uploaded Python 2

File details

Details for the file django-closuretree-1.1.7.tar.gz.

File metadata

File hashes

Hashes for django-closuretree-1.1.7.tar.gz
Algorithm Hash digest
SHA256 e73f305d937fda68a3952ed407c2bdc7ea0cd331251ccf773c4f4cf317a6363a
MD5 0ee493e250ce483bd7faa7c426ed0daa
BLAKE2b-256 1171deb528d1cd71b9c19289ef324ab35d709c71b752f74d20690f0890607e32

See more details on using hashes here.

File details

Details for the file django_closuretree-1.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for django_closuretree-1.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 11e619a308a8fecd1de7131bef3d2e0708b6c5bdc2f669e11909743017ac0406
MD5 4086ad29766defd4b018eafb9effe59b
BLAKE2b-256 0c504a631ecc4e88e8f810f8111bcb074ba1afacc1f51c72cac793ee93b25dee

See more details on using hashes here.

File details

Details for the file django_closuretree-1.1.7-py2-none-any.whl.

File metadata

File hashes

Hashes for django_closuretree-1.1.7-py2-none-any.whl
Algorithm Hash digest
SHA256 738292f18932947140183e4de3c13875f5306af539bb56d9486c58dd048a392a
MD5 eef21c762b73495dceea01ec8ed54520
BLAKE2b-256 caa2c4fe26e5538587c80582f31919a5722ffe79cc37465f5f9df7ff6a5bb9e6

See more details on using hashes here.

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