skip to navigation
skip to content

django-polymorphic-tree 1.4

A polymorphic mptt structure to display content in a tree.


This package combines django-mptt with django-polymorphic. You can write Django models that form a tree structure where each node can be a different model type.

Example uses:

  • Build a tree of organisation and company types (e.g. Partner, Reseller, Group and Customer)
  • Build a tree of a root node, category nodes, leaf nodes, each with custom fields.
  • Build a todo list of projects, categories and items.
  • Build a book of chapters, sections, and pages.


This code was created in django-fluent-pages, and extracted to become a separate package. This was done during contract work at Leukeleu (known for django-fiber).


First install the module, preferably in a virtual environment:

pip install django-polymorphic-tree

Or install the current repository:

pip install -e git+

The main dependencies are django-mptt and django-polymorphic, which will be automatically installed.


Next, create a project which uses the application:

cd .. startproject demo

Add the following to



The main feature of this module is creating a tree of custom node types. It boils down to creating a application with 2 files:

The file should define the custom node type, and any fields it has:

from django.db import models
from django.utils.translation import ugettext_lazy as _
from polymorphic_tree.models import PolymorphicMPTTModel, PolymorphicTreeForeignKey

# A base model for the tree:

class BaseTreeNode(PolymorphicMPTTModel):
    parent = PolymorphicTreeForeignKey('self', blank=True, null=True, related_name='children', verbose_name=_('parent'))
    title = models.CharField(_("Title"), max_length=200)

    class Meta(PolymorphicMPTTModel.Meta):
        verbose_name = _("Tree node")
        verbose_name_plural = _("Tree nodes")

# Create 3 derived models for the tree nodes:

class CategoryNode(BaseTreeNode):
    opening_title = models.CharField(_("Opening title"), max_length=200)
    opening_image = models.ImageField(_("Opening image"), upload_to='images')

    class Meta:
        verbose_name = _("Category node")
        verbose_name_plural = _("Category nodes")

class TextNode(BaseTreeNode):
    extra_text = models.TextField()

    # Extra settings:
    can_have_children = False

    class Meta:
        verbose_name = _("Text node")
        verbose_name_plural = _("Text nodes")

class ImageNode(BaseTreeNode):
    image = models.ImageField(_("Image"), upload_to='images')

    class Meta:
        verbose_name = _("Image node")
        verbose_name_plural = _("Image nodes")

The file should define the admin, both for the child nodes and parent:

from django.contrib import admin
from django.utils.translation import ugettext_lazy as _
from polymorphic_tree.admin import PolymorphicMPTTParentModelAdmin, PolymorphicMPTTChildModelAdmin
from . import models

# The common admin functionality for all derived models:

class BaseChildAdmin(PolymorphicMPTTChildModelAdmin):
        'fields': ('parent', 'title'),

    base_model = models.BaseTreeNode
    base_fieldsets = (

# Optionally some custom admin code

class TextNodeAdmin(BaseChildAdmin):

# Create the parent admin that combines it all:

class TreeNodeParentAdmin(PolymorphicMPTTParentModelAdmin):
    base_model = models.BaseTreeNode
    child_models = (
        (models.CategoryNode, BaseChildAdmin),
        (models.TextNode, TextNodeAdmin),  # custom admin allows custom edit/delete view.
        (models.ImageNode, BaseChildAdmin),

    list_display = ('title', 'actions_column',)

    class Media:
        css = {
            'all': ('admin/treenode/admin.css',)
        }, TreeNodeParentAdmin)

The child_models attribute defines which admin interface is loaded for the edit and delete page. The list view is still rendered by the parent admin.


When drag-n-drop nodes in tree in admin, clean/full_clean method is not called. To implement validation, you should override can_be_moved model method. Method have to return True if nothing happens and moving is allowing. Otherwise, can_be_moved have to raise ValidationError or InvalidMove from mptt.exceptions

class Participant(PolymorphicMPTTModel):
    conference = models.ForeignKey(Conference)
    invited_by = PolymorphicTreeForeignKey(

    def clean(self):
        if self.participant:
            if self.conference != self.manager.conference:
                raise ValidationError({
                    'invited_by': _(
                        'Participants have to be from the same '

    def can_be_moved(self, target):
        self.invited_by = target
        return True


To run the included test suite, execute:


To test support for multiple Python and Django versions, you need to follow steps below:

  • install project requirements in virtual environment

  • install python 2.7, 3.3, 3.4, 3.5, 3.6 python versions through pyenv (See pyenv (Linux) or Homebrew (Mac OS X).)

  • create .python-version file and add full list of installed versions with which project have to be tested, example:

  • run tox from the repository root:

    pip install tox

Python 2.7, 3.3, 3.4, 3.5 and 3.6 and django 1.7, 1.8, 1.9 and 1.10 are the currently supported versions.


  • Sphinx Documentation


This module is designed to be generic. In case there is anything you didn’t like about it, or think it’s not flexible enough, please let us know. We’d love to improve it!

If you have any other valuable contribution, suggestion or idea, please let us know as well because we will look into it. Pull requests are welcome too. :-)

File Type Py Version Uploaded on Size
django-polymorphic-tree-1.4.tar.gz (md5) Source 2017-02-18 141KB
django_polymorphic_tree-1.4-py2.py3-none-any.whl (md5) Python Wheel py2.py3 2017-02-18 159KB