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

Uploaded Source

Built Distributions

django_closuretree-1.1.6-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

django_closuretree-1.1.6-py2-none-any.whl (11.1 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for django-closuretree-1.1.6.tar.gz
Algorithm Hash digest
SHA256 cdd9171dffbb203d1523b8373e7756276081774e7fac3c6673e7511daed26bd6
MD5 a5d4cb7c3105e3eb55d2c588584dd61a
BLAKE2b-256 974753ac6563157a9a0f5e72cbca6a5162bc049858c3bab48ac86ad64ac6abbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_closuretree-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6d02569bc5af43e1afb687d9e51a007351aebc1be1ebeb7df0caa4725bb1c8e2
MD5 2ee930b8c40186be5f229956d4759d2d
BLAKE2b-256 07affd6db37b04f2b9a4d4bcf7c4cd2a9dd95b1c392918db5c5a5242541996b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_closuretree-1.1.6-py2-none-any.whl
Algorithm Hash digest
SHA256 9f67f9deeeffc7c17b06be0dea8b79460084c8a283e11f2a30679749bbdc14fa
MD5 63f664ae4b986f4aba14a2ac84e2d382
BLAKE2b-256 3458d522281cef61b66e91933f0d3da49b658f4c1b91f3aaedf65229d762f3e3

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