Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabiocaccamo/django-treenode
:deciduous_tree: probably the best abstract model/admin for your tree based stuff.
https://github.com/fabiocaccamo/django-treenode
abstract ancestors categories category children descendants django model node nodes parent python root roots siblings tree trees
Last synced: about 1 month ago
JSON representation
:deciduous_tree: probably the best abstract model/admin for your tree based stuff.
- Host: GitHub
- URL: https://github.com/fabiocaccamo/django-treenode
- Owner: fabiocaccamo
- License: mit
- Created: 2018-04-03T15:16:32.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T17:10:00.000Z (about 1 month ago)
- Last Synced: 2024-07-29T23:00:50.516Z (about 1 month ago)
- Topics: abstract, ancestors, categories, category, children, descendants, django, model, node, nodes, parent, python, root, roots, siblings, tree, trees
- Language: Python
- Homepage:
- Size: 390 KB
- Stars: 630
- Watchers: 14
- Forks: 30
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-django - django-treenode - Abstract model/admin for tree based stuff. (Third-Party Packages / Models)
README
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://pypi.org/project/django-treenode/)
[](https://pepy.tech/project/django-treenode)
[](https://github.com/fabiocaccamo/django-treenode/stargazers)
[](https://github.com/fabiocaccamo/django-treenode/blob/main/LICENSE.txt)
[](https://results.pre-commit.ci/latest/github/fabiocaccamo/django-treenode/main)
[](https://github.com/fabiocaccamo/django-treenode)
[](https://codecov.io/gh/fabiocaccamo/django-treenode)
[](https://www.codacy.com/app/fabiocaccamo/django-treenode)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
# django-treenode
Probably the best abstract model / admin for your **tree** based stuff.
## Features
- **Fast** - get `ancestors`, `children`, `descendants`, `parent`, `root`, `siblings`, `tree` with **no queries**
- **Synced** - in-memory model instances are automatically updated
- **Compatibility** - you can easily add `treenode` to existing projects
- **No dependencies**
- **Easy configuration** - just extend the abstract model / model-admin
- **Admin integration** - great tree visualization: **accordion**, **breadcrumbs** or **indentation**
| indentation (default) | breadcrumbs | accordion |
| --- | --- | --- |
| ![treenode-admin-display-mode-indentation][treenode-admin-display-mode-indentation] | ![treenode-admin-display-mode-breadcrumbs][treenode-admin-display-mode-breadcrumbs] | ![treenode-admin-display-mode-accordion][treenode-admin-display-mode-accordion] |
## Installation
- Run `pip install django-treenode`
- Add `treenode` to `settings.INSTALLED_APPS`
- Make your model inherit from `treenode.models.TreeNodeModel` *(described below)*
- Make your model-admin inherit from `treenode.admin.TreeNodeModelAdmin` *(described below)*
- Run `python manage.py makemigrations` and `python manage.py migrate`
## Configuration
### `models.py`
Make your model class inherit from `treenode.models.TreeNodeModel`:
```python
from django.db import models
from treenode.models import TreeNodeModel
class Category(TreeNodeModel):
# the field used to display the model instance
# default value 'pk'
treenode_display_field = "name"
name = models.CharField(max_length=50)
class Meta(TreeNodeModel.Meta):
verbose_name = "Category"
verbose_name_plural = "Categories"
```
The `TreeNodeModel` abstract class adds many fields (prefixed with `tn_` to prevent direct access) and public methods to your models.
:warning: **If you are extending a model that already has some fields, please ensure that your model existing fields names don't clash with `TreeNodeModel` public [methods/properties](#methodsproperties) names.**
---
### `admin.py`
Make your model-admin class inherit from `treenode.admin.TreeNodeModelAdmin`.
```python
from django.contrib import admin
from treenode.admin import TreeNodeModelAdmin
from treenode.forms import TreeNodeForm
from .models import Category
class CategoryAdmin(TreeNodeModelAdmin):
# set the changelist display mode: 'accordion', 'breadcrumbs' or 'indentation' (default)
# when changelist results are filtered by a querystring,
# 'breadcrumbs' mode will be used (to preserve data display integrity)
treenode_display_mode = TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_ACCORDION
# treenode_display_mode = TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_BREADCRUMBS
# treenode_display_mode = TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_INDENTATION
# use TreeNodeForm to automatically exclude invalid parent choices
form = TreeNodeForm
admin.site.register(Category, CategoryAdmin)
```
---
### `settings.py`
You can use a custom cache backend by adding a `treenode` entry to `settings.CACHES`, otherwise the default cache backend will be used.
```python
CACHES = {
"default": {
"BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
"LOCATION": "...",
},
"treenode": {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
},
}
```
## Usage
### Methods/Properties
- [`delete`](#delete)
- [`delete_tree`](#delete_tree)
- [`get_ancestors`](#get_ancestors)
- [`get_ancestors_count`](#get_ancestors_count)
- [`get_ancestors_pks`](#get_ancestors_pks)
- [`get_ancestors_queryset`](#get_ancestors_queryset)
- [`get_breadcrumbs`](#get_breadcrumbs)
- [`get_children`](#get_children)
- [`get_children_count`](#get_children_count)
- [`get_children_pks`](#get_children_pks)
- [`get_children_queryset`](#get_children_queryset)
- [`get_depth`](#get_depth)
- [`get_descendants`](#get_descendants)
- [`get_descendants_count`](#get_descendants_count)
- [`get_descendants_pks`](#get_descendants_pks)
- [`get_descendants_queryset`](#get_descendants_queryset)
- [`get_descendants_tree`](#get_descendants_tree)
- [`get_descendants_tree_display`](#get_descendants_tree_display)
- [`get_first_child`](#get_first_child)
- [`get_index`](#get_index)
- [`get_last_child`](#get_last_child)
- [`get_level`](#get_level)
- [`get_order`](#get_order)
- [`get_parent`](#get_parent)
- [`get_parent_pk`](#get_parent_pk)
- [`set_parent`](#set_parent)
- [`get_priority`](#get_priority)
- [`set_priority`](#set_priority)
- [`get_root`](#get_root)
- [`get_root_pk`](#get_root_pk)
- [`get_roots`](#get_roots)
- [`get_roots_queryset`](#get_roots_queryset)
- [`get_siblings`](#get_siblings)
- [`get_siblings_count`](#get_siblings_count)
- [`get_siblings_pks`](#get_siblings_pks)
- [`get_siblings_queryset`](#get_siblings_queryset)
- [`get_tree`](#get_tree)
- [`get_tree_display`](#get_tree_display)
- [`is_ancestor_of`](#is_ancestor_of)
- [`is_child_of`](#is_child_of)
- [`is_descendant_of`](#is_descendant_of)
- [`is_first_child`](#is_first_child)
- [`is_last_child`](#is_last_child)
- [`is_leaf`](#is_leaf)
- [`is_parent_of`](#is_parent_of)
- [`is_root`](#is_root)
- [`is_root_of`](#is_root_of)
- [`is_sibling_of`](#is_sibling_of)
- [`update_tree`](#update_tree)
#### `delete`
**Delete a node** if `cascade=True` (default behaviour), children and descendants will be deleted too,
otherwise children's parent will be set to `None` (then children become roots):
```python
obj.delete(cascade=True)
```
#### `delete_tree`
**Delete the whole tree** for the current node class:
```python
cls.delete_tree()
```
#### `get_ancestors`
Get a **list with all ancestors** (ordered from root to parent):
```python
obj.get_ancestors()
# or
obj.ancestors
```
#### `get_ancestors_count`
Get the **ancestors count**:
```python
obj.get_ancestors_count()
# or
obj.ancestors_count
```
#### `get_ancestors_pks`
Get the **ancestors pks** list:
```python
obj.get_ancestors_pks()
# or
obj.ancestors_pks
```
#### `get_ancestors_queryset`
Get the **ancestors queryset** (ordered from parent to root):
```python
obj.get_ancestors_queryset()
```
#### `get_breadcrumbs`
Get the **breadcrumbs** to current node (included):
```python
obj.get_breadcrumbs(attr=None)
# or
obj.breadcrumbs
```
#### `get_children`
Get a **list containing all children**:
```python
obj.get_children()
# or
obj.children
```
#### `get_children_count`
Get the **children count**:
```python
obj.get_children_count()
# or
obj.children_count
```
#### `get_children_pks`
Get the **children pks** list:
```python
obj.get_children_pks()
# or
obj.children_pks
```
#### `get_children_queryset`
Get the **children queryset**:
```python
obj.get_children_queryset()
```
#### `get_depth`
Get the **node depth** (how many levels of descendants):
```python
obj.get_depth()
# or
obj.depth
```
#### `get_descendants`
Get a **list containing all descendants**:
```python
obj.get_descendants()
# or
obj.descendants
```
#### `get_descendants_count`
Get the **descendants count**:
```python
obj.get_descendants_count()
# or
obj.descendants_count
```
#### `get_descendants_pks`
Get the **descendants pks** list:
```python
obj.get_descendants_pks()
# or
obj.descendants_pks
```
#### `get_descendants_queryset`
Get the **descendants queryset**:
```python
obj.get_descendants_queryset()
```
#### `get_descendants_tree`
Get a **n-dimensional** `dict` representing the **model tree**:
```python
obj.get_descendants_tree()
# or
obj.descendants_tree
```
#### `get_descendants_tree_display`
Get a **multiline** `string` representing the **model tree**:
```python
obj.get_descendants_tree_display()
# or
obj.descendants_tree_display
```
#### `get_first_child`
Get the **first child node**:
```python
obj.get_first_child()
# or
obj.first_child
```
#### `get_index`
Get the **node index** (index in node.parent.children list):
```python
obj.get_index()
# or
obj.index
```
#### `get_last_child`
Get the **last child node**:
```python
obj.get_last_child()
# or
obj.last_child
```
#### `get_level`
Get the **node level** (starting from 1):
```python
obj.get_level()
# or
obj.level
```
#### `get_order`
Get the **order value** used for ordering:
```python
obj.get_order()
# or
obj.order
```
#### `get_parent`
Get the **parent node**:
```python
obj.get_parent()
# or
obj.parent
```
#### `get_parent_pk`
Get the **parent node pk**:
```python
obj.get_parent_pk()
# or
obj.parent_pk
```
#### `set_parent`
Set the **parent node**:
```python
obj.set_parent(parent_obj)
```
#### `get_priority`
Get the **node priority**:
```python
obj.get_priority()
# or
obj.priority
```
#### `set_priority`
Set the **node priority**:
```python
obj.set_priority(100)
```
#### `get_root`
Get the **root node** for the current node:
```python
obj.get_root()
# or
obj.root
```
#### `get_root_pk`
Get the **root node pk** for the current node:
```python
obj.get_root_pk()
# or
obj.root_pk
```
#### `get_roots`
Get a **list with all root nodes**:
```python
cls.get_roots()
# or
cls.roots
```
#### `get_roots_queryset`
Get **root nodes queryset**:
```python
cls.get_roots_queryset()
```
#### `get_siblings`
Get a **list with all the siblings**:
```python
obj.get_siblings()
# or
obj.siblings
```
#### `get_siblings_count`
Get the **siblings count**:
```python
obj.get_siblings_count()
# or
obj.siblings_count
```
#### `get_siblings_pks`
Get the **siblings pks** list:
```python
obj.get_siblings_pks()
# or
obj.siblings_pks
```
#### `get_siblings_queryset`
Get the **siblings queryset**:
```python
obj.get_siblings_queryset()
```
#### `get_tree`
Get a **n-dimensional** `dict` representing the **model tree**:
```python
cls.get_tree()
# or
cls.tree
```
#### `get_tree_display`
Get a **multiline** `string` representing the **model tree**:
```python
cls.get_tree_display()
# or
cls.tree_display
```
#### `is_ancestor_of`
Return `True` if the current node **is ancestor** of target_obj:
```python
obj.is_ancestor_of(target_obj)
```
#### `is_child_of`
Return `True` if the current node **is child** of target_obj:
```python
obj.is_child_of(target_obj)
```
#### `is_descendant_of`
Return `True` if the current node **is descendant** of target_obj:
```python
obj.is_descendant_of(target_obj)
```
#### `is_first_child`
Return `True` if the current node is the **first child**:
```python
obj.is_first_child()
```
#### `is_last_child`
Return `True` if the current node is the **last child**:
```python
obj.is_last_child()
```
#### `is_leaf`
Return `True` if the current node is **leaf** (it has not children):
```python
obj.is_leaf()
```
#### `is_parent_of`
Return `True` if the current node **is parent** of target_obj:
```python
obj.is_parent_of(target_obj)
```
#### `is_root`
Return `True` if the current node **is root**:
```python
obj.is_root()
```
#### `is_root_of`
Return `True` if the current node **is root** of target_obj:
```python
obj.is_root_of(target_obj)
```
#### `is_sibling_of`
Return `True` if the current node **is sibling** of target_obj:
```python
obj.is_sibling_of(target_obj)
```
#### `update_tree`
**Update tree** manually, useful after **bulk updates**:
```python
cls.update_tree()
```
### Bulk Operations
To perform bulk operations it is recommended to turn off signals, then triggering the tree update at the end:
```python
from treenode.signals import no_signals
with no_signals():
# execute custom bulk operations
pass
# trigger tree update only once
YourModel.update_tree()
```
## FAQ
### Custom tree serialization
> How can I serialize a tree using a custom data structure?
This has been discussed [here](https://github.com/fabiocaccamo/django-treenode/discussions/89#discussioncomment-5521654).
## Testing
```bash
# clone repository
git clone https://github.com/fabiocaccamo/django-treenode.git && cd django-treenode
# create virtualenv and activate it
python -m venv venv && . venv/bin/activate
# upgrade pip
python -m pip install --upgrade pip
# install requirements
pip install -r requirements.txt -r requirements-test.txt
# install pre-commit to run formatters and linters
pre-commit install --install-hooks
# run tests
tox
# or
python runtests.py
# or
python -m django test --settings "tests.settings"
```
## License
Released under [MIT License](LICENSE.txt).
---
## Supporting
- :star: Star this project on [GitHub](https://github.com/fabiocaccamo/django-treenode)
- :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)
- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)
- :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)
## See also
- [`django-admin-interface`](https://github.com/fabiocaccamo/django-admin-interface) - the default admin interface made customizable by the admin itself. popup windows replaced by modals. 🧙 ⚡
- [`django-cache-cleaner`](https://github.com/fabiocaccamo/django-cache-cleaner) - clear the entire cache or individual caches easily using the admin panel or management command. 🧹✨
- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨
- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. ⚙️
- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. 🚧 🛠️
- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. ↪️
- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘
- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳
- [`python-fontbro`](https://github.com/fabiocaccamo/python-fontbro) - friendly font operations. 🧢
- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. 🧟♂️
[treenode-admin-display-mode-accordion]: https://user-images.githubusercontent.com/1035294/54942407-5040ec00-4f2f-11e9-873b-d0b3b521f534.png
[treenode-admin-display-mode-breadcrumbs]: https://user-images.githubusercontent.com/1035294/54942410-50d98280-4f2f-11e9-8a8b-a1ac6208398a.png
[treenode-admin-display-mode-indentation]: https://user-images.githubusercontent.com/1035294/54942411-50d98280-4f2f-11e9-9daf-d8339dd7a159.png