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

Uploaded Source

Built Distributions

django_closuretree-1.1.5-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

django_closuretree-1.1.5-py2-none-any.whl (8.7 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for django-closuretree-1.1.5.tar.gz
Algorithm Hash digest
SHA256 7c53c8aa604bf37148c67dc92523e2a64a4725a8f892e262b4670fa2130ec5dc
MD5 e3be09ccdf5caf0fd82b235befa402cf
BLAKE2b-256 6a03a25aa0efcfd84205acade9af902ed48890c10c0638f0a3bd7644b9aaac2f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_closuretree-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1e7c7559793081b0bd6a9a4021ae4a88e6dda3772a1686995d26070b7c8ff097
MD5 8ab11be612902dc1c6ac1015cb41d244
BLAKE2b-256 88a07c784622eb28d9840044714a8226925c5c7a9f04e2b7ac33893845fa0098

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_closuretree-1.1.5-py2-none-any.whl
Algorithm Hash digest
SHA256 4019d4abfc9b719d7bf7dcaf6da0617361d31e2ef7d5302e936eaf19b0e8b427
MD5 f36fa7f6a1763660b2a460b107cfec60
BLAKE2b-256 bfbbb889d7b678b930762c544594afc410b46a449f5823740537a5ccf1658980

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