nautobot 2.4.17__py3-none-any.whl → 2.4.19__py3-none-any.whl

nautobot/core/tests/test_views_utils.py

@@ -1,16 +1,22 @@
 import urllib.parse
 
 from django.contrib.auth.models import AnonymousUser
+from django.contrib.contenttypes.models import ContentType
 from django.db import ProgrammingError
-from django.test import TestCase
 
 from nautobot.core.models.querysets import count_related
-from nautobot.core.testing import TransactionTestCase
-from nautobot.core.views.utils import check_filter_for_display, get_saved_views_for_user, prepare_cloned_fields
+from nautobot.core.testing import TestCase
+from nautobot.core.views.utils import (
+    check_filter_for_display,
+    get_bulk_queryset_from_view,
+    get_saved_views_for_user,
+    prepare_cloned_fields,
+)
 from nautobot.dcim.filters import DeviceFilterSet
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, InventoryItem, Location, Manufacturer
 from nautobot.extras.models import Role, SavedView, Status
-from nautobot.users.models import User
+from nautobot.ipam.models import Namespace, VRF
+from nautobot.users.models import ObjectPermission, User
 
 
 class CheckFilterForDisplayTest(TestCase):
@@ -173,7 +179,7 @@ class CheckPrepareClonedFields(TestCase):
                 self.assertTrue(query_params["description"][0] == description)
 
 
-class GetSavedViewsForUserTestCase(TransactionTestCase):
+class GetSavedViewsForUserTestCase(TestCase):
     """
     Class to test `get_saved_views_for_user`.
     """
@@ -186,6 +192,8 @@ class GetSavedViewsForUserTestCase(TransactionTestCase):
 
     def setUp(self):
         super().setUp()
+        # We want a clean slate for SavedViews
+        SavedView.objects.all().delete()
         self.user2 = User.objects.create_user(username="second_user")
         self.create_saved_view(name="saved_view")
         self.create_saved_view(name="saved_view_shared", is_shared=True)
@@ -219,3 +227,229 @@ class GetSavedViewsForUserTestCase(TransactionTestCase):
         self.assertEqual(saved_views.count(), 2)
         expected_names = ["saved_view_shared", "saved_view_shared_different_owner"]
         self.assertEqual(list(saved_views.values_list("name", flat=True)), expected_names)
+
+
+class GetBulkQuerysetFromViewTestCase(TestCase):
+    """Class to test get_bulk_queryset_from_view with VRF."""
+
+    def setUp(self):
+        super().setUp()
+        self.user = User.objects.create_user(username="testuser", password="testpass", is_superuser=True)  # noqa: S106  # hardcoded-password-func-arg -- ok as this is test code only
+        self.vrfs = []
+        namespace = Namespace.objects.create(name="test-namespace")
+        for i in range(10):
+            vrf = VRF.objects.create(
+                name=f"VRF {i}",
+                description=f"desc-{i % 3}",  # 3 unique descriptions, repeated
+                namespace=namespace,
+            )
+            self.vrfs.append(vrf)
+        # SavedView filters by name of VRF 5
+        self.saved_view = SavedView.objects.create(
+            name="VRF 5 Only",
+            owner=self.user,
+            view="ipam:vrf_list",
+            config={"filter_params": {"name": self.vrfs[5].name}},
+        )
+        self.saved_view_empty = SavedView.objects.create(
+            name="NO Filter Params", owner=self.user, view="ipam:vrf_list", config={"per_page": 50, "sort_order": []}
+        )
+        self.content_type = ContentType.objects.get_for_model(VRF)
+
+    def test_not_is_all_and_pk_list(self):
+        """!is_all and pk_list: Return queryset filtered by pk_list"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=False,
+            filter_query_params={},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, [self.vrfs[2], self.vrfs[4]], ordered=False)
+
+    def test_not_is_all_and_no_pk_list(self):
+        """!is_all and !pk_list: Return empty queryset. This should not normally happen in practice."""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=False,
+            filter_query_params={},
+            pk_list=[],
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertEqual(qs.count(), 0)
+
+    def test_is_all_and_no_saved_view_and_no_filter_query_params(self):
+        """is_all and !saved_view_id and !filter_query_params: Return all objects"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.all(), ordered=False)
+
+    def test_all_filters_removed_flag_ignores_saved_view(self):
+        """
+        If filter_query_params contains 'all_filters_removed', the saved view is ignored and all objects are returned.
+        """
+        # Pass the all_filters_removed flag in filter_query_params
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            filter_query_params={"all_filters_removed": [True], "saved_view": [self.saved_view.id]},
+            pk_list=[],
+            saved_view_id=self.saved_view.id,
+            action="change",
+            edit_all=True,
+        )
+        # Should return all VRFs, not just the one from the saved view
+        self.assertQuerysetEqual(qs, VRF.objects.all(), ordered=False)
+
+    def test_is_all_and_filter_query_params(self):
+        """is_all and filter_query_params: Return queryset filtered by filter_query_params (description)"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={"description": ["desc-1"]},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.filter(description="desc-1"), ordered=False)
+
+    def test_is_all_and_saved_view_id(self):
+        """is_all and saved_view_id: Return queryset filtered by saved_view_filter_params (name)"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=self.saved_view.id,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, [self.vrfs[5]], ordered=False)
+
+    def test_is_all_and_not_saved_view_id_but_saved_view_filter_params(self):
+        """is_all and not saved_view_id: Return queryset filtered by filter_query_params (name)"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={"name": [self.vrfs[7].name]},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, [self.vrfs[7]], ordered=False)
+
+    def test_queryset_respects_permissions(self):
+        """is_all and not saved_view_id: Return queryset filtered by filter_query_params (name)"""
+        # Create a non-superuser with no permissions
+        limited_permissions_user = User.objects.create_user(
+            username="user_no_perms",
+            password="testpass",  # noqa: S106  # hardcoded-password-func-arg -- ok as this is test code only
+            is_superuser=False,
+        )
+        # Assign object permission
+        obj_perm = ObjectPermission.objects.create(
+            name="Test permission",
+            constraints={"name": self.vrfs[2].name},
+            actions=["view", "change", "delete", "add"],
+        )
+        obj_perm.users.add(limited_permissions_user)
+        obj_perm.object_types.add(self.content_type)
+
+        qs = get_bulk_queryset_from_view(
+            user=limited_permissions_user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={},
+            pk_list=[self.vrfs[3].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.filter(name=self.vrfs[2].name), ordered=False)
+
+    def test_querydict_ignores(self):
+        """is_all and not saved_view_id: Return queryset filtered by filter_query_params (name)"""
+        filter_query_params = {"name": [self.vrfs[7].name], "per_page": [10]}
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params=filter_query_params,
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=None,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.filter(name=self.vrfs[7].name), ordered=False)
+
+    def test_no_valid_operation_found_raises(self):
+        """If no valid operation is found, raise RuntimeError."""
+        # Simulate a situation where all logic branches are skipped
+        with self.assertRaises(RuntimeError):
+            get_bulk_queryset_from_view(
+                user=self.user,
+                content_type=self.content_type,
+                filter_query_params=None,
+                pk_list=[],
+                saved_view_id=None,
+                action="change",
+                edit_all=None,  # Not True, so not valid for 'change'
+            )
+
+    def test_runtime_error_when_all_param_missing(self):
+        """Raise RuntimeError if required *_all param is not provided for the action."""
+        with self.assertRaises(RuntimeError):
+            get_bulk_queryset_from_view(
+                user=self.user,
+                content_type=self.content_type,
+                filter_query_params={},
+                pk_list=[],
+                saved_view_id=None,
+                action="delete",  # delete_all is missing
+            )
+        with self.assertRaises(RuntimeError):
+            get_bulk_queryset_from_view(
+                user=self.user,
+                content_type=self.content_type,
+                filter_query_params={},
+                pk_list=[],
+                saved_view_id=None,
+                action="change",  # edit_all is missing
+            )
+
+    def test_is_all_and_saved_view__with_no_filter_params(self):
+        """is_all and saved_view_id with no filter_params in saved view: Return all objects"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id=self.saved_view_empty.id,
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.all(), ordered=False)
+
+    def test_bad_saved_view(self):
+        """Test with a saved view ID that does not exist: Return no objects"""
+        qs = get_bulk_queryset_from_view(
+            user=self.user,
+            content_type=self.content_type,
+            edit_all=True,
+            filter_query_params={},
+            pk_list=[self.vrfs[2].pk, self.vrfs[4].pk],  # should be ignored but is sent anyway by form
+            saved_view_id="00000000-0000-4000-8000-000000000000",  # valid UUID but does not exist
+            action="change",
+        )
+        self.assertQuerysetEqual(qs, VRF.objects.none(), ordered=False)

nautobot/core/ui/breadcrumbs.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
 import logging
+from operator import attrgetter
 from typing import Any, Callable, Literal, Optional, Protocol, Type, Union
 from urllib.parse import urlencode
 
@@ -7,10 +8,12 @@ from django.db.models import Model
 from django.template import Context
 from django.urls import NoReverseMatch, reverse
 
+from nautobot.core.models.tree_queries import TreeModel
 from nautobot.core.templatetags import helpers
 from nautobot.core.ui.utils import get_absolute_url, render_component_template
 from nautobot.core.utils import lookup
 from nautobot.core.utils.lookup import get_model_for_view_name, get_model_from_name
+from nautobot.core.views.utils import get_obj_from_context
 
 logger = logging.getLogger(__name__)
 
@@ -27,6 +30,32 @@ BreadcrumbItemsType = dict[str, list["BaseBreadcrumbItem"]]
 ReverseParams = Union[dict[str, Any], Callable[[Context], dict[str, Any]], None]
 
 
+def context_object_attr(attr_path: str, context_key: str = "object"):
+    """
+    Helper function that creates callable to fetch the object from context and then nested attributes.
+
+    Useful for composing breadcrumbs. For example:
+    ```
+    context = Context({"object": Device.objects.first()})
+    breadcrumbs = Breadcrumbs(items={"detail": [
+        InstanceBreadcrumbItem(instance=context_object_attr("location.location_type")),
+        InstanceBreadcrumbItem(instance=context_object_attr("location")),
+    ]})
+    ```
+    Will render:
+    - url to the device.location.location_type detail page
+    - url to the device.location detail page
+
+    Examples:
+        >>> context_object_attr("location.name")
+        lambda context: context['object'].location.name
+        >>> context_object_attr("location.name", context_key="device")
+        lambda context: context['device'].location.name
+
+    """
+    return lambda context: attrgetter(attr_path)(context[context_key]) if context.get(context_key) else None
+
+
 @dataclass
 class BaseBreadcrumbItem:
     """
@@ -128,17 +157,17 @@ class BaseBreadcrumbItem:
         """
         Construct the (URL, label) pair for the breadcrumb.
 
-        Combines `get_url()` and `get_label()` and applies title casing to the label.
+        Combines `get_url()` and `get_label()` and applies formatting to the label.
 
         Args:
             context (Context): Context object used to resolve the breadcrumb parts.
 
         Returns:
             tuple[str, Optional[str]]: A tuple of (URL, label), where URL may be an empty string
-            if unresolved, and label is title-cased.
+            if unresolved, and label.
         """
         url = self.get_url(context) or ""
-        label = helpers.bettertitle(self.get_label(context))
+        label = self.get_label(context)
         return url, label
 
 
@@ -192,9 +221,14 @@ class ViewNameBreadcrumbItem(BaseBreadcrumbItem):
 
     def get_label(self, context: Context) -> str:
         if self.label_from_view_name:
-            model = get_model_for_view_name(self.get_view_name(context))
-            if model is not None:
-                return model._meta.verbose_name_plural
+            try:
+                model = get_model_for_view_name(self.get_view_name(context))
+                if model is not None:
+                    return helpers.bettertitle(model._meta.verbose_name_plural)
+            except ValueError:
+                # `get_model_for_view_name` is not working properly with some proper paths like "home"
+                # and because by default we're trying to resolve label by using `list_url` this error may occur in some apps
+                pass
         return super().get_label(context)
 
     def get_view_name(self, context: Context) -> Optional[str]:
@@ -217,7 +251,7 @@ class ModelBreadcrumbItem(BaseBreadcrumbItem):
 
     Attributes:
         model (Union[str, Type[Model], None, Callable[[Context], Union[str, Type[Model], None]]): Django model class, instance, or dotted path string or callable that returns one of this.
-        model_key (Optional[str]): Context key to fetch a model class, instance or dotted path string.
+        model_key (Optional[str]): Context key to fetch a model class, instance or dotted path string. By default: "object".
         action (str): Action to use when resolving a model-based route (default: "list").
         label_type (Literal["singular", "plural"]): Whether to use `verbose_name` or `verbose_name_plural`.
         reverse_kwargs (Union[dict[str, Any], Callable[[Context], dict[str, Any]], None]): Keyword arguments passed to `reverse()`.
@@ -236,7 +270,7 @@ class ModelBreadcrumbItem(BaseBreadcrumbItem):
     """
 
     model: Union[ModelType, Callable[[Context], ModelType]] = None
-    model_key: Optional[str] = None
+    model_key: Optional[str] = "object"
     action: str = "list"
     label_type: ModelLabelType = "plural"
     reverse_kwargs: ReverseParams = None
@@ -276,21 +310,26 @@ class ModelBreadcrumbItem(BaseBreadcrumbItem):
 
         model_obj = self.get_model(context)
         name_attr = "verbose_name" if self.label_type == "singular" else "verbose_name_plural"
+        label = ""
 
         if model_obj is not None:
             if isinstance(model_obj, str):
                 model_cls = get_model_from_name(model_obj)
-                return getattr(model_cls._meta, name_attr)
-            return getattr(model_obj._meta, name_attr)
-        return ""
+                label = getattr(model_cls._meta, name_attr)
+            else:
+                label = getattr(model_obj._meta, name_attr)
+
+        return helpers.bettertitle(label)
 
     def get_model(self, context: Context) -> ModelType:
-        if self.model_key:
-            return context.get(self.model_key)
         if self.model:
             if callable(self.model):
                 return self.model(context)
             return self.model
+
+        if self.model_key:
+            return context.get(self.model_key)
+
         return None
 
 
@@ -303,8 +342,8 @@ class InstanceBreadcrumbItem(BaseBreadcrumbItem):
     Label will be generated from object, but you can still override it.
 
     Attributes:
-        instance_key (Optional[str]): Context key to fetch a Django model instance for building the breadcrumb.
-        instance (Callable[[Context], Optional[Model]): Callable to fetch the instance from context. If
+        instance_key (Optional[str]): Context key to fetch a Django model instance for building the breadcrumb. Default: "object".
+        instance (Union[Callable[[Context], Optional[Model]], Model, None]): Callable to fetch the instance from context. If
         should_render (Callable[[Context], bool]): Callable to decide whether this item should be rendered or not.
         label (Union[Callable[[Context], str], WithStr, None]): Optional override for the display label in the breadcrumb.
         label_key (Optional[str]): Optional key to take label from the context.
@@ -316,8 +355,8 @@ class InstanceBreadcrumbItem(BaseBreadcrumbItem):
         ("/dcim/devices/1234", "Custom Device Label")  # Assuming that under "object" there is a Device instance
     """
 
-    instance_key: str = "object"
-    instance: Optional[Callable[[Context], Optional[Model]]] = None
+    instance_key: Optional[str] = "object"
+    instance: Union[Callable[[Context], Optional[Model]], Model, None] = None
     label: Union[Callable[[Context], str], WithStr, None] = None
 
     def get_url(self, context: Context) -> Optional[str]:
@@ -361,9 +400,95 @@ class InstanceBreadcrumbItem(BaseBreadcrumbItem):
             Optional[Model]: Instance from context.
         """
         if self.instance:
-            return self.instance(context)
+            if callable(self.instance):
+                return self.instance(context)
+            return self.instance
+
+        if self.instance_key:
+            return context.get(self.instance_key)
+
+        return None
+
+
+@dataclass
+class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
+    """
+    Breadcrumb item prepared to be "parent" or "group" of given model.
+
+    It will create a breadcrumb item to the object list but will try to filter it by given parent.
+
+    Attributes:
+        parent_key (str): Instance attribute to get the parent instance. Default: "parent".
+        parent_query_param (Optional[str]): Query param name under which parent lookup key will be added into breadcrumb url. If None, will be the same as `parent_key`.
+        parent_lookup_key (Optional[str]): Parent attribute which will be used to build the url and filter the instance list url. Can be set to None to use parent as key.
+
+    Examples:
+        >>> InstanceParentBreadcrumbItem()
+        ("/dcim/devices?parent=<parent.pk>", "Parent")  # Assuming that under "object" there is a Device instance and has "parent"
+        >>> InstanceParentBreadcrumbItem(parent_key="group", parent_lookup_key="name")
+        ("/dcim/devices?group=<group_name>", "Group")  # Assuming that under "object" there is a Device instance and has "group"
+    """
+
+    parent_key: str = "parent"
+    parent_query_param: Optional[str] = None
+    parent_lookup_key: Optional[str] = "pk"
+
+    def __post_init__(self):
+        """
+        Set `parent_query_param` if not filled.
+        """
+        if self.parent_query_param is None:
+            self.parent_query_param = self.parent_key
+
+    def get_url(self, context: Context) -> Optional[str]:
+        """
+        Resolve the URL for the breadcrumb item based on the instance and provided parent.
+
+        Args:
+            context (Context): The current template context.
+
+        Returns:
+            Optional[str]: The URL as a string, or None.
+        """
+        instance = self.get_instance(context)
+        parent = self.get_parent_attr(instance)
+        if not instance or not parent:
+            return None
+
+        view_name = lookup.get_route_for_model(instance, "list")
+        return self.reverse_view_name(view_name, context, reverse_query_params=self.get_reverse_query_params(parent))
+
+    def get_label(self, context: Context) -> str:
+        """
+        Get the label (display text) for the breadcrumb from instance and provided parent.
+
+        Args:
+            context (Context): The current template context.
 
-        return context.get(self.instance_key)
+        Returns:
+            str: Label as a string.
+        """
+        if self.label or self.label_key:
+            return super().get_label(context)
+        instance = self.get_instance(context)
+        parent = self.get_parent_attr(instance)
+        if not instance or not parent:
+            return ""
+        return getattr(parent, "display", str(parent))
+
+    def get_reverse_query_params(self, parent: Model) -> Optional[dict]:
+        if self.parent_lookup_key is None:
+            return {self.parent_query_param: parent}
+
+        if hasattr(parent, self.parent_lookup_key):
+            if query_param := getattr(parent, self.parent_lookup_key):
+                return {self.parent_query_param: query_param}
+        return {}
+
+    def get_parent_attr(self, instance: Model) -> Optional[Model]:
+        if hasattr(instance, self.parent_key):
+            return getattr(instance, self.parent_key) or None
+        return None
 
 
 class Breadcrumbs:
@@ -401,6 +526,7 @@ class Breadcrumbs:
         # Default breadcrumb if view defines `list_url` in the Context
         ViewNameBreadcrumbItem(
             view_name_key="list_url",
+            label_key="title",
             label_from_view_name=True,
             should_render=lambda context: context.get("list_url") is not None,
         ),
@@ -411,7 +537,8 @@ class Breadcrumbs:
     def __init__(
         self,
         items: BreadcrumbItemsType = None,
-        template: str = "inc/breadcrumbs.html",
+        template: str = "components/breadcrumbs.html",
+        detail_item_label: LabelType = None,
     ):
         """
         Initialize the Breadcrumbs configuration.
@@ -419,8 +546,10 @@ class Breadcrumbs:
         Args:
             items (Optional[dict[str, list[BreadcrumbItem]]]): Default breadcrumb items for each action.
             template (str): The template used to render the breadcrumbs.
+            detail_item_label (Union[Callable[[Context], str], WithStr, None]): Custom label for last built-in breadcrumb item with link to the object details.
         """
         self.template = template
+        self.detail_item_label = detail_item_label
 
         # Set the default breadcrumbs
         self.items = {
@@ -433,7 +562,7 @@ class Breadcrumbs:
             self.items = {**self.items, **items}
 
         # Built-in feature: always add the instance details at the end of breadcrumbs path
-        self.items["detail"].append(InstanceBreadcrumbItem())
+        self.items["detail"].append(InstanceBreadcrumbItem(label=detail_item_label))
 
     def get_breadcrumbs_items(self, context: Context) -> list[tuple[str, str]]:
         """
@@ -447,9 +576,9 @@ class Breadcrumbs:
         Returns:
             (list[tuple[str, str]]): A list of (url, label) tuples representing breadcrumb entries.
         """
-        action = context.get("view_action", "list")
+        action = context.get("view_action", "")
         detail = context.get("detail", False)
-        items = self.get_items_for_action(self.items, action, detail)
+        items = self.get_items_for_action(self.items, action, detail, context)
         return [item.as_pair(context) for item in items if item.should_render(context)]
 
     def filter_breadcrumbs_items(self, items: list[tuple[str, str]], context: Context) -> list[tuple[str, str]]:
@@ -457,7 +586,7 @@ class Breadcrumbs:
         Filters out all items that both label and url are None or empty str.
 
         Args:
-            items (list[tuple[str, str]]): breadcrumb items pair.s
+            items (list[tuple[str, str]]): breadcrumb items pairs.
             context (Context): The view or template context.
 
         Returns:
@@ -478,16 +607,17 @@ class Breadcrumbs:
         """
         return label and label.strip()
 
-    @staticmethod
-    def get_items_for_action(items: BreadcrumbItemsType, action: str, detail: bool) -> list[BaseBreadcrumbItem]:
+    def get_items_for_action(
+        self, items: BreadcrumbItemsType, action: str, detail: bool, context: Context
+    ) -> list[BaseBreadcrumbItem]:
         """
-        Get the breadcrumb items for a specific action, with fallback to 'detail' if not found
-        and to asterisk (*) if present.
+        Get the breadcrumb items for a specific action, 'detail' or to asterisk (*) if present.
 
         Args:
             items (BreadcrumbItemsType): Dictionary mapping action names to breadcrumb item lists.
             action (str): Current action name (e.g., "list", "detail").
             detail (bool): Whether this is a detail view (for fallback).
+            context (Context): The view or template context.
 
         Returns:
             list[BaseBreadcrumbItem]: List of breadcrumb items for the action.
@@ -536,3 +666,65 @@ class Breadcrumbs:
             (dict): A dictionary of extra context variables.
         """
         return {}
+
+
+class AncestorsBreadcrumbs(Breadcrumbs):
+    """
+    Breadcrumbs class which can render list of ancestors of given instance.
+
+    Default behavior:
+    - render breadcrumb item with link to the list view
+    - dynamically add list of `InstanceBreadcrumbItem` from `ancestors()`
+    - adds standard breadcrumb item with link to the details
+    """
+
+    def get_items_for_action(
+        self, items: BreadcrumbItemsType, action: str, detail: bool, context: Context
+    ) -> list[BaseBreadcrumbItem]:
+        """
+        Get the breadcrumb items for a specific action, 'detail' or to asterisk (*) if present.
+
+        For detail action it calls `self.get_detail_items()` method. For other actions, it calls parent class method.
+
+        Args:
+            items (BreadcrumbItemsType): Dictionary mapping action names to breadcrumb item lists.
+            action (str): Current action name (e.g., "list", "detail").
+            detail (bool): Whether this is a detail view (for fallback).
+            context (Context): The view or template context.
+
+        Returns:
+            list[BaseBreadcrumbItem]: List of breadcrumb items for the action.
+        """
+        if not detail:
+            return super().get_items_for_action(items, action, detail, context)
+
+        return self.get_detail_items(context)
+
+    def get_detail_items(self, context: Context) -> list[BaseBreadcrumbItem]:
+        """
+        Build breadcrumb items for a detail view, including the model, its ancestors, and the instance itself.
+
+        Args:
+            context (Context): Template or view context containing the current object.
+
+        Returns:
+            list[BaseBreadcrumbItem]: Ordered breadcrumb items for the given instance.
+        """
+        instance = get_obj_from_context(context)
+        return [
+            ModelBreadcrumbItem(model=instance),
+            *self.get_ancestors_items(instance),
+            InstanceBreadcrumbItem(instance=instance, label=self.detail_item_label),
+        ]
+
+    def get_ancestors_items(self, instance: TreeModel) -> list[BaseBreadcrumbItem]:
+        """
+        Create breadcrumb items for all ancestor objects of the given instance.
+
+        Args:
+            instance (TreeModel): Object from context.
+
+        Returns:
+            list[BaseBreadcrumbItem]: Breadcrumb items for each ancestor of the instance.
+        """
+        return [InstanceBreadcrumbItem(instance=ancestor, label=ancestor.name) for ancestor in instance.ancestors()]