django-treebeard

Treebeard 6.0.0 is a major release. It features a change to Treebeard's API.

The following methods that previously existing on the Node model class have now moved to the model manager instead:

• load_bulk
• dump_bulk
• find_problems
• fix_tree
• get_tree
• get_descendants_group_count
• get_annotated_list_qs
• get_annotated_list
• get_root_nodes
• get_first_root_node
• get_last_root_node
• get_children
• get_children_count
• get_siblings
• get_descendants
• get_descendant_count
• get_first_child
• get_last_child
• get_first_sibling
• get_last_sibling
• get_prev_sibling
• get_next_sibling
• get_root
• get_parent
• get_ancestors

So, for example, code like this:

    node.get_children()

Would need to be rewritten as:

    MyModel.objects.get_children(node)

Putting these methods on the model manager instead of the model class is more consistent with Django's design patterns, and provides much more flexibility with their use. It also keeps the model class slim, avoiding conflicts with code layered on top.

Backward compatibility exists for all these methods, which will be removed in Treebeard 8.

It is now mandatory for the default model manager for a Treebeard model to subclass Treebeard's manager. An error will be raised if this is not the case.

Bugfixes in these releases:

• Fixed erroneous no-op when moving MP_Node nodes with node_order_by set.

Treebeard 5.3.0 is a minor release.

• Added support for loading data for many-to-many relationships with load_bulk(). These were previously exported when using dump_bulk(), but were not handled when loading the same data.
• Fixed an exception arising when running delete() operations on querysets that had a prefetch.
• Added a warning when the default manager for a model extending a Treebeard Node class does not subclass the corresponding Treebeard model manager. This will raise an error in the next major release of Treebeard.

Revert change to MP_Node.get_ancestors() that caused a performance …

Fix import error in Python 3.10. Ensure lowest supported Python versi…

Treebeard 5.1.0 is a minor release that includes some bug fixes.

New features:

• Added a bulk_create option to MP_Node.load_bulk(), that creates database entries in bulk instead of one at a time.
• Added signals to MP_Node, NS_Node and LT_Node implementations to allow external data stores to stay in sync with Treebeard-based models.

Big fixes:

• Fixed MP_Node paths being incremented unnecessarily when saving nodes with node_order_by in the admin.
• Optimised MoveNodeForm to skip move logic if no treebeard-specific fields were modified.
• Changed the unique constraint for LTree.path to be deferrable, so that move operations do not fail. This requires a database migration for projects using the experimental LTree implementation.

Treebeard 5.1.0 is a bugfix release.

• Fixed add_child and add_sibling behaviour for inherited models using NS_Node.
• Improved query efficiency for AL Trees, for several query operations.
• Added a parent param to MP_Node.find_problems to allow inspecting only a portion of a tree.
• Added a find_problems method to NS_Node to identify issues with nested sets.
• Made license notices for code adapted from third party libraries explicit.

Treebeard 5.0.5 is a bugfix release.

• Reverted change to lock root nodes when adding a new root, which had unwanted performance implications.

Treebeard 5.0.4 is a bugfix release.

• Fixed TypeError when adding root nodes for MP and LT trees with node_order_by set.

Treebeard 5.0.3 is a bugfix release.

• Added row locks to prevent potential race conditions when concurrently calling add_child() on the same node, or when concurrently adding root nodes.

Treebeard 5.0.2 is a bugfix release.

• MP and NS nodes are refreshed from the database after a move, for a better developer experience. Previously it was left to the developer to refresh manually if they needed to use the node, and this was the source of numerous issues.
• Fixed handling of reverse ordering in node_order_by.
• Fixed handling of inherited models in TreeAdmin.
• Fixed adding root nodes for inherited models.
• Handled null values of fields specified in node_order_by more gracefully: ignore the field for the purpose of ordering and log a warning to indicate that the value likely needs to be provided manually.
• Modified dump_bulk() methods to use a queryset iterator to avoid loading large datasets into memory.
• Fixed import error with Django 6 if pyscopg was not installed.

Treebeard 5.0.1 is a bugfix release.

• Fixed count aggregations not working on MariaDB.

Treebeard 5.0 is a major release with a number of significant changes:

• All operations that previously used raw SQL queries were rewritten to use the Django ORM. This provides better security, portability across backends, and compability for multiple database setups.
• An experimental implementation using PostgreSQL Ltree was added.

Backward incompatible changes:

• Internal fields used by Treebeard's MoveNodeForm have been renamed from _position to treebeard_position and _ref_node_id to treebeard_ref_node.
• Changed initialisation signatures for the internal MP_AddChildHandler and MP_AddSiblingHandler to avoid collisions with model field names. Both constructors now expect a mapping of model creation arguments as a single parameter, instead of keywords arguments passed to the constructor.
• MoveNodeForm has been refactored to use a ModelChoiceField for selecting the relative node. This field can be used by projects, e.g., for foreign keys in the Django admin.
• Removed the Node.get_database_vendor() helper function which is no longer used.
• The deprecated destructive argument was removed from MP_Node.fix_tree() use fix_paths instead.

Other changes:

• Added support for Python 3.14.
• Added support for Django 6.0.
• Dropped support for Django 4.2 and 5.1.
• All node create and update operations are now run in a transaction to mitigate against race conditions.
• Added a parent argument to MP_Node.fix_tree to allow fixing only a portion of a tree.

• Add support for Django 5.2, and Python 3.13.
• Drop support for Django 4.1 and 5.0.
• Refactor Django admin integration to be simpler, and more resilient to upstream changes.
• Add include_self option to get_descendants method.
• Fix KeyError in MP_Node.dump_bulk if ordering differs from depth, path.
• Exclude tests from packaged wheel distribution of django-treebeard

• Fix: Allow usage of CSRF_COOKIE_HTTPONLY setting.
• Add support for Django-5.0.

• Drop support for Django 4.0.
• Add support for Django 4.2.

• Fix unescaped string representation of AL_Node models in the Django admin. Thanks to goodguyandy for reporting the issue.
• Optimise MP_Node.get_descendants to avoid database queries when called on a leaf node.

• Removed unnecessary default in MP's depth field.

• Add support for custom primary key fields with custom names.
• Add support for Python 3.9.
• Add support for MSSQL 2019.
• Add Code of conduct
• Removed outdated Sqlite workaround code
• Remove last remains of Python 2.7 code
• Use Pytest-django and fixtures for testing

• Implement a non-destructive path-fixing algorithm for MP_Node.fix_tree.
• Ensure post_save is triggered after the parent node is updated in MP_AddChildHandler.
• Fix static URL generation to use static template tag instead of constructing the URL manually.
• Declare support for Django 2.2, 3.0 and 3.1.
• Drop support for Django 2.1 and lower.
• Drop support for Python 2.7 and Python 3.5.
• Increase performance for MoveNodeForm when using large trees.

• Added check to avoid unnecessary database query for MP_Node.get_ancestors() if the node is a root node.
• Drop support for Python-3.4.
• Play more nicely with other form classes, that implement __init__(self, *args, **kwargs), e.g. django-parler's TranslatableModelForm, where kwargs.get('instance') is None when called from here.
• Sorting on path on necessary queries, fixes some issues and stabilizes the whole MP section.
• Add German translation strings.

• Support for Django-2.0

• Bugfix issues #90: admin change list view and jsi18n load for Django-1.11

• Support for Django-2.0

• Fixed MANIFEST.in for Debian packaging.

• Removed deprecated templatetag inclusion
• Added support for Python-3.6
• Added support for MS-SQL

• Add support for Django-1.10
• Drop support for Django-1.7
• Moved Repository from Bitbucket to GitHub
• Moved documentation to https://django-treebeard.readthedocs.io/
• Moved continuous integration to https://travis-ci.org/django-treebeard/django-treebeard

• Escape input in forms (Martin Koistinen / Divio)
• Clarification on model detail pages (Michael Huang)

• Added support for 3.5 and Django 1.7, 1.8 and 1.9
• Django 1.6 is no longer supported.
• Remove deprecated backports needed for now unsupported Django versions
• Fixed a bug with queryset deletion not handling inheritance correctly.
• Assorted documentation fixes

• Limited tests (and hence support) to Python 2.7+/3.4+ and Django 1.6+
• Removed usage of deprecated Django functions.
• Fixed documentation issues.
• Fixed issues in MoveNodeForm
• Added get_annotated_list_qs and max_depth for get_annotated_list

• Stable release.

• Fixed unicode related issue in the template tags.
• Major documentation cleanup.
• More warnings on the use of managers.
• Faster MP's is_root() method.

• Dropped support for Python 2.5

This is a beta release.

• Added support for Django 1.5 and Python 3.X
• Updated docs: the library supports python 2.5+ and Django 1.4+. Dropped support for older versions
• Revamped admin interface for MP and NS trees, supporting drag&drop to reorder nodes. Work on this patch was sponsored by the Oregon Center for Applied Science, inspired by FeinCMS developed by Jesús del Carpio_ with tests from Fernando Gutierrez_. Thanks ORCAS!
• Updated setup.py to use distribute/setuptools instead of distutils
• Now using pytest for testing
• Small optimization to ns_tree.is_root
• Moved treebeard.tests to it's own directory (instead of tests.py)
• Added the runtests.py test runner
• Added tox support
• Fixed drag&drop bug in the admin
• Fixed a bug when moving MP_Nodes
• Using .pk instead of .id when accessing nodes.
• Removed the Benchmark (tbbench) and example (tbexample) apps.
• Fixed url parts join issues in the admin.
• Fixed: Now installing the static resources
• Fixed ManyToMany form field save handling
• In the admin, the node is now saved when moving so it can trigger handlers and/or signals.
• Improved translation files, including javascript.
• Renamed Node.get_database_engine() to Node.get_database_vendor(). As the name implies, it returns the database vendor instead of the engine used. Treebeard will get the value from Django, but you can subclass the method if needed.

• Added admin i18n. Included translations: es, ru
• Fixed a bug when trying to introspect the database engine used in Django 1.2+ while using new style db settings (DATABASES). Added Node.get_database_engine to deal with this.

• Added get_annotated_list
• Complete revamp of the documentation. It's now divided in sections for easier reading, and the package includes .rst files instead of the html build.
• Added raw id fields support in the admin
• Fixed setup.py to make it work in 2.4 again
• The correct ordering in NS/MP trees is now enforced in the queryset.
• Cleaned up code, removed some unnecessary statements.
• Tests refactoring, to make it easier to spot the model being tested.
• Fixed support of trees using proxied models. It was broken due to a bug in Django.
• Fixed a bug in add_child when adding nodes to a non-leaf in sorted MP.
• There are now 648 unit tests. Test coverage is 96%
• This will be the last version compatible with Django 1.0. There will be a a 1.6.X branch maintained for urgent bug fixes, but the main development will focus on recent Django versions.

• Really fixed the installation of templates.

• Forgot to include treebeard/tempates/*.html in MANIFEST.in

New features added

* Forms

  - Added MoveNodeForm

* Django Admin

  - Added TreeAdmin

* MP_Node

  - Added 2 new checks in MP_Node.find_problems():

    4. a list of ids of nodes with the wrong depth value for
       their path
    5. a list of ids nodes that report a wrong number of children

  - Added a new (safer and faster but less comprehensive) MP_Node.fix_tree()
    approach.

* Documentation

  - Added warnings in the documentation when subclassing MP_Node or NS_Node
    and adding a new Meta.

  - HTML documentation is now included in the package.

  - CHANGES file and section in the docs.

* Other changes:

  - script to build documentation

  - updated numconv.py


Bugs fixed
~~~~~~~~~~

* Added table quoting to all the sql queries that bypass the ORM.
  Solves bug in postgres when the table isn't created by syncdb.

* Removing unused method NS_Node._find_next_node

* Fixed MP_Node.get_tree to include the given parent when given a leaf node