Django Nested Admin

4.1.6 · active · verified Sun Apr 12

django-nested-admin provides Django admin classes that allow for deeply nested inlines within the Django administration interface. It extends Django's native `InlineModelAdmin` functionality to support multiple levels of related objects. The current version is 4.1.6, and it typically releases new versions to maintain compatibility with new Django releases.

Warnings

breaking Version 4.0.0 removed Python 2.x compatibility and dropped support for all Django versions prior to 3.2. Projects on older Django or Python versions must upgrade or use an older `django-nested-admin` release.
Fix: Upgrade your Django project to Django 3.2+ and Python 3.6+ before upgrading to django-nested-admin v4.0.0 or later.
breaking Version 4.1.0 updated the signature for `formfield_for_dbfield` and removed usage of deprecated `filter` methods within the codebase. Custom admin classes overriding `formfield_for_dbfield` might need signature adjustments.
Fix: Review custom `admin.py` files for any overrides of `formfield_for_dbfield` and update their signatures to match the latest Django/nested-admin expectations. Check `ModelAdmin` and `InlineModelAdmin` documentation for current method signatures.
gotcha `django-nested-admin` often requires strict alignment with Django's major version. Upgrading Django may necessitate a corresponding upgrade of `django-nested-admin` to ensure compatibility and prevent unexpected behavior or errors.
Fix: Always check the `django-nested-admin` release notes and `requirements.txt` for your target version of Django before upgrading. Pin `django-nested-admin` to a compatible version in your project's dependencies.
gotcha Integration with `django-grappelli` can sometimes be tricky due to differences in frontend assets and JavaScript event handling. While `django-nested-admin` includes specific fixes for Grappelli, incompatibilities can still arise with certain versions.
Fix: Ensure `django-nested-admin` and `django-grappelli` versions are known to be compatible. If issues arise, test with a simpler admin setup to isolate the problem, and consult the `django-nested-admin` GitHub issues for Grappelli-related discussions.
gotcha If you are using Django's autocomplete fields or other custom JavaScript in your admin, be aware that `django-nested-admin` (especially v4.0.0+) dispatches native JavaScript CustomEvent events like `formset:added` and `formset:removed`. Your custom JS might need to listen for these.
Fix: If custom JavaScript is failing to initialize or re-initialize on dynamically added nested inlines, ensure it's listening for the appropriate `CustomEvent` events dispatched by `django-nested-admin` on the document or relevant formset elements.

Install

pip install django-nested-admin Install stable version

Imports

NestedModelAdmin

from nested_admin import NestedModelAdmin

NestedStackedInline

from nested_admin import NestedStackedInline

NestedTabularInline

from nested_admin import NestedTabularInline

Quickstart

To use `django-nested-admin`, define your models, then create `NestedTabularInline` or `NestedStackedInline` classes for your child models, nesting them as needed. Finally, register your top-level model with `NestedModelAdmin` in your `admin.py` file. This example demonstrates a three-level nesting: Grandparent -> Parent -> Child.

from django.contrib import admin
from django.db import models

from nested_admin import NestedModelAdmin, NestedStackedInline, NestedTabularInline

# Example Models
class Grandparent(models.Model):
    name = models.CharField(max_length=100)

    def __str__(self):
        return self.name

class Parent(models.Model):
    grandparent = models.ForeignKey(Grandparent, on_delete=models.CASCADE, related_name='parents')
    name = models.CharField(max_length=100)

    def __str__(self):
        return self.name

class Child(models.Model):
    parent = models.ForeignKey(Parent, on_delete=models.CASCADE, related_name='children')
    name = models.CharField(max_length=100)

    def __str__(self):
        return self.name


# Admin Inlines
class ChildInline(NestedTabularInline):
    model = Child
    extra = 1

class ParentInline(NestedStackedInline):
    model = Parent
    inlines = [ChildInline]
    extra = 1

@admin.register(Grandparent)
class GrandparentAdmin(NestedModelAdmin):
    inlines = [ParentInline]
    list_display = ('name',)

# Register Parent and Child models to ensure they appear in admin if not directly inline
# admin.site.register(Parent)
# admin.site.register(Child)

view raw JSON →