nautobot 3.0.0a2__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

nautobot/core/ui/breadcrumbs.py

@@ -1,7 +1,8 @@
 from dataclasses import dataclass
+from itertools import chain
 import logging
 from operator import attrgetter
-from typing import Any, Callable, Literal, Optional, Protocol, Type, Union
+from typing import Any, Callable, Iterator, Literal, Optional, Protocol, Type, Union
 from urllib.parse import urlencode
 
 from django.db.models import Model
@@ -11,7 +12,7 @@ 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 import deprecation, 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
 
@@ -153,7 +154,7 @@ class BaseBreadcrumbItem:
             return params
         return {}
 
-    def as_pair(self, context: Context) -> tuple[str, str]:
+    def as_pair(self, context: Context) -> Iterator[tuple[str, str]]:
         """
         Construct the (URL, label) pair for the breadcrumb.
 
@@ -163,12 +164,12 @@ class BaseBreadcrumbItem:
             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
+            Iterator[tuple[str, Optional[str]]]: A tuple of (URL, label), where URL may be an empty string
             if unresolved, and label.
         """
         url = self.get_url(context) or ""
         label = self.get_label(context)
-        return url, label
+        yield url, label
 
 
 @dataclass
@@ -387,7 +388,7 @@ class InstanceBreadcrumbItem(BaseBreadcrumbItem):
         instance = self.get_instance(context)
         if not instance:
             return ""
-        return getattr(instance, "display", str(instance))
+        return getattr(instance, "page_title", str(instance))
 
     def get_instance(self, context: Context) -> Optional[Model]:
         """
@@ -419,6 +420,7 @@ class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
 
     Attributes:
         parent_key (str): Instance attribute to get the parent instance. Default: "parent".
+        parent (Optional[Model]): Instance or related object (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.
 
@@ -430,6 +432,7 @@ class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
     """
 
     parent_key: str = "parent"
+    parent: Optional[Model] = None
     parent_query_param: Optional[str] = None
     parent_lookup_key: Optional[str] = "pk"
 
@@ -451,12 +454,14 @@ class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
             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:
+        related_object = self.get_related_object(instance)
+        if not instance or not related_object:
             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))
+        return self.reverse_view_name(
+            view_name, context, reverse_query_params=self.get_reverse_query_params(related_object)
+        )
 
     def get_label(self, context: Context) -> str:
         """
@@ -471,10 +476,10 @@ class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
         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:
+        related_object = self.get_related_object(instance)
+        if not instance or not related_object:
             return ""
-        return getattr(parent, "display", str(parent))
+        return getattr(related_object, "page_title", str(related_object))
 
     def get_reverse_query_params(self, parent: Model) -> Optional[dict]:
         if self.parent_lookup_key is None:
@@ -485,12 +490,58 @@ class InstanceParentBreadcrumbItem(InstanceBreadcrumbItem):
                 return {self.parent_query_param: query_param}
         return {}
 
-    def get_parent_attr(self, instance: Model) -> Optional[Model]:
+    def get_related_object(self, instance: Model) -> Optional[Model]:
+        if self.parent:
+            return self.parent
+
         if hasattr(instance, self.parent_key):
             return getattr(instance, self.parent_key) or None
+
         return None
 
 
+@dataclass
+class AncestorsInstanceBreadcrumbItem(InstanceBreadcrumbItem):
+    """
+    Item class which can render list of ancestors of given instance.
+
+    By default, it won't include itself.
+
+    Attributes:
+        include_self (bool): Whether to include self as last item of ancestors.
+
+    Examples:
+        >>> AncestorsInstanceBreadcrumbItem(instance=location)
+        ("/dcim/locations/<pk>", "Parent 2"), ("/dcim/locations/<pk>", "Parent 1")
+        >>> AncestorsInstanceBreadcrumbItem(instance=location, include_self=True)
+        ("/dcim/locations/<pk>", "Parent 2"), ("/dcim/locations/<pk>", "Parent 1"), ("/dcim/locations/<pk>", "Location")
+    """
+
+    ancestor_item: Callable[[Model], BaseBreadcrumbItem] = lambda instance: InstanceBreadcrumbItem(instance=instance)
+    include_self: bool = False
+
+    def as_pair(self, context: Context) -> Iterator[tuple[str, str]]:
+        """
+        Construct the (URL, label) pair for the breadcrumb with all the instance ancestors.
+
+        Creates separate `InstanceBreadcrumbItem` with copied data from self.
+
+        Args:
+            context (Context): Context object used to resolve the breadcrumb parts.
+
+        Returns:
+            Iterator[tuple[str, Optional[str]]]: A tuple of (URL, label), where URL may be an empty string
+            if unresolved, and label.
+        """
+        instance = self.get_instance(context)
+
+        for ancestor in instance.ancestors():
+            yield from self.ancestor_item(ancestor).as_pair(context)
+
+        if self.include_self:
+            yield from self.ancestor_item(instance).as_pair(context)
+
+
 class Breadcrumbs:
     """
     Base class responsible for generating and rendering breadcrumbs for a page.
@@ -507,14 +558,7 @@ class Breadcrumbs:
          and there is `context['detail'] = True` set in context
 
     !!! important
-        This class automatically adds the:
-        - `InstanceBreadcrumbItem` at the end of `detail` breadcrumbs
-        - `ModelBreadcrumbItem` at the beginning of `list` and `detail` breadcrumbs
-
-        You can override this behavior by subclassing this class and updating
-        the `list_breadcrumb_item` or `detail_breadcrumb_item` attributes.
-
-        If you're using custom action other than `list` / `detail` you need to remember to add above breadcrumbs
+        If you're using custom action other than `list` / `detail` you need to remember to add list view breadcrumb manually
         if you need them in your custom action.
 
     Attributes:
@@ -553,7 +597,7 @@ class Breadcrumbs:
 
         # Set the default breadcrumbs
         self.items = {
-            "list": [*self.breadcrumb_items],
+            "list": [],
             "detail": [*self.breadcrumb_items],
         }
 
@@ -561,9 +605,6 @@ class Breadcrumbs:
         if items:
             self.items = {**self.items, **items}
 
-        # Built-in feature: always add the instance details at the end of breadcrumbs path
-        self.items["detail"].append(InstanceBreadcrumbItem(label=detail_item_label))
-
     def get_breadcrumbs_items(self, context: Context) -> list[tuple[str, str]]:
         """
         Compute the list of breadcrumb items for the given context.
@@ -579,7 +620,8 @@ class Breadcrumbs:
         action = context.get("view_action", "")
         detail = context.get("detail", False)
         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)]
+        items_pairs = [item.as_pair(context) for item in items if item.should_render(context)]
+        return list(chain.from_iterable(items_pairs))
 
     def filter_breadcrumbs_items(self, items: list[tuple[str, str]], context: Context) -> list[tuple[str, str]]:
         """
@@ -657,7 +699,7 @@ class Breadcrumbs:
         Provide additional data to include in the rendering context, based on the configuration of this component.
 
         Context updated here will be applied to resolving url and labels.
-        Please ote that you can't override `breadcrumb_items` here because items are generated after this method call.
+        Please note that you can't override `breadcrumb_items` here because items are generated after this method call.
 
         Args:
             context (Context): The current context passed to `render()`.
@@ -668,6 +710,7 @@ class Breadcrumbs:
         return {}
 
 
+@deprecation.class_deprecated("Functionality of this class was moved to the AncestorsInstanceBreadcrumbItem.")
 class AncestorsBreadcrumbs(Breadcrumbs):
     """
     Breadcrumbs class which can render list of ancestors of given instance.
@@ -675,7 +718,6 @@ class AncestorsBreadcrumbs(Breadcrumbs):
     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(
@@ -714,7 +756,6 @@ class AncestorsBreadcrumbs(Breadcrumbs):
         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]:

nautobot/core/ui/bulk_buttons.py

@@ -32,7 +32,7 @@ class BaseBulkButton(object_detail.FormButton):
 class BulkRenameButton(BaseBulkButton):
     action = "rename"
     color = ButtonActionColorChoices.RENAME
-    icon = "mdi-pencil"
+    icon = "mdi-rename"
     label = "Rename"
     weight = 200
 

nautobot/core/ui/choices.py

@@ -66,37 +66,153 @@ class EChartsTypeChoices(ChoiceSet):
     )
 
 
-class EChartsTypeTheme(ChoiceSet):
-    """Available chart theme for ECharts.
-
-    Attributes:
-        LIGHT (str): Light theme (value: light)
-        DARK (str): Dark theme (value: dark)
-    """
-
-    LIGHT = "default"
-    DARK = "dark"
+class EChartsThemeColors(ChoiceSet):
+    """Available chart colors for ECharts."""
+
+    NAUTOBOT = "default"
+    LIGHTER_GREEN_AND_RED_ONLY = "lighter-green-red-only"
+    DEFAULT = NAUTOBOT
+
+    # Color lists - direct access
+    NAUTOBOT_COLORS = (
+        UI_COLORS["blue"],
+        UI_COLORS["purple"],
+        UI_COLORS["turquoise"],
+        UI_COLORS["orange"],
+        UI_COLORS["green"],
+        UI_COLORS["red"],
+        UI_COLORS["gray"],
+        UI_COLORS["blue-lighter"],
+        UI_COLORS["purple-lighter"],
+        UI_COLORS["turquoise-lighter"],
+        UI_COLORS["orange-lighter"],
+        UI_COLORS["green-lighter"],
+        UI_COLORS["red-lighter"],
+        UI_COLORS["gray-lighter"],
+        UI_COLORS["blue-darker"],
+        UI_COLORS["purple-darker"],
+        UI_COLORS["turquoise-darker"],
+        UI_COLORS["orange-darker"],
+        UI_COLORS["green-darker"],
+        UI_COLORS["red-darker"],
+        UI_COLORS["gray-darker"],
+    )
 
-    DEFAULT = LIGHT
+    LIGHTER_GREEN_RED_COLORS = (
+        UI_COLORS["green-lighter"],
+        UI_COLORS["red-lighter"],
+    )
 
     CHOICES = (
-        (LIGHT, "Default theme"),
-        (DARK, "Dark theme"),
+        (NAUTOBOT, "Default Nautobot Colors"),
+        (LIGHTER_GREEN_AND_RED_ONLY, "Lighter Green and Red Only"),
     )
 
     COLORS = {
-        LIGHT: [
-            UI_COLORS["blue-0"]["light"],
-            UI_COLORS["orange-0"]["light"],
-            UI_COLORS["green-0"]["light"],
-            UI_COLORS["red-0"]["light"],
-            UI_COLORS["gray-0"]["light"],
-        ],
-        DARK: [
-            UI_COLORS["blue-0"]["dark"],
-            UI_COLORS["orange-0"]["dark"],
-            UI_COLORS["green-0"]["dark"],
-            UI_COLORS["red-0"]["dark"],
-            UI_COLORS["gray-0"]["dark"],
-        ],
+        NAUTOBOT: NAUTOBOT_COLORS,
+        LIGHTER_GREEN_AND_RED_ONLY: LIGHTER_GREEN_RED_COLORS,
     }
+
+
+class NavigationIconChoices(ChoiceSet):
+    """Navigation icons for major Nautobot sections."""
+
+    DEVICES = "server"
+    IPAM = "sitemap-outline"
+    ORGANIZATION = "organization"
+    CIRCUITS = "cable-data"
+    VPN = "bus-shield"
+    ROUTING = "route"
+    POWER = "battery-3"
+    WIRELESS = "wifi"
+    DEVICE_LIFECYCLE = "device-lifecycle"
+    SECRETS = "secrets"
+    SECURITY = "security"
+    LOAD_BALANCERS = "arrow-decision"
+    VIRTUALIZATION = "cloud-upload"
+    CLOUD = "cloud"
+    DESIGN = "hammer"
+    APPROVAL_WORKFLOWS = "checkbox-circle"
+    EXTENSIBILITY = "extensibility"
+    GOLDEN_CONFIG = "sliders-vert-2"
+    JOBS = "share"
+    APPS = "elements"
+
+    CHOICES = (
+        (DEVICES, "Devices"),
+        (IPAM, "IPAM"),
+        (ORGANIZATION, "Organization"),
+        (CIRCUITS, "Circuits"),
+        (VPN, "VPN"),
+        (ROUTING, "Routing"),
+        (POWER, "Power"),
+        (WIRELESS, "Wireless"),
+        (DEVICE_LIFECYCLE, "Device Lifecycle"),
+        (SECRETS, "Secrets"),
+        (SECURITY, "Security"),
+        (LOAD_BALANCERS, "Load Balancers"),
+        (VIRTUALIZATION, "Virtualization"),
+        (CLOUD, "Cloud"),
+        (DESIGN, "Design"),
+        (APPROVAL_WORKFLOWS, "Approval Workflows"),
+        (EXTENSIBILITY, "Extensibility"),
+        (GOLDEN_CONFIG, "Golden Config"),
+        (JOBS, "Jobs"),
+        (APPS, "Apps"),
+    )
+
+
+class NavigationWeightChoices(ChoiceSet):
+    """Navigation weights for major Nautobot sections."""
+
+    # In general we are looking to:
+    # - Keep data models before the default weight of 1000
+    # - Leave a gap between the default location of 1000
+    # - Keep non-model items after the default weight of 1000
+    # - Keep key items of GC, Jobs, and Apps at the end for easy access
+    DEVICES = 100
+    IPAM = 200
+    ORGANIZATION = 300
+    CIRCUITS = 400
+    VPN = 450
+    ROUTING = 500
+    POWER = 550
+    WIRELESS = 600
+    DEVICE_LIFECYCLE = 650
+    SECRETS = 700
+    SECURITY = 750
+    LOAD_BALANCERS = 800
+    VIRTUALIZATION = 850
+    CLOUD = 900
+    # We leave a gap here to allow for future expansion and don't use 1000
+    # since it the default weight for NavMenuTab if none is specified.
+    DESIGN = 1100
+    APPROVAL_WORKFLOWS = 1200
+    EXTENSIBILITY = 1300
+    # look to keep these last few items at the end of the nav for easy access
+    GOLDEN_CONFIG = 2000
+    JOBS = 2100
+    APPS = 2200
+
+    CHOICES = (
+        (DEVICES, "Devices"),
+        (IPAM, "IPAM"),
+        (ORGANIZATION, "Organization"),
+        (CIRCUITS, "Circuits"),
+        (VPN, "VPN"),
+        (ROUTING, "Routing"),
+        (POWER, "Power"),
+        (WIRELESS, "Wireless"),
+        (DEVICE_LIFECYCLE, "Device Lifecycle"),
+        (SECRETS, "Secrets"),
+        (SECURITY, "Security"),
+        (VIRTUALIZATION, "Virtualization"),
+        (LOAD_BALANCERS, "Load Balancers"),
+        (CLOUD, "Cloud"),
+        (DESIGN, "Design"),
+        (APPROVAL_WORKFLOWS, "Approval Workflows"),
+        (EXTENSIBILITY, "Extensibility"),
+        (GOLDEN_CONFIG, "Golden Config"),
+        (JOBS, "Jobs"),
+        (APPS, "Apps"),
+    )

nautobot/core/ui/constants.py

@@ -1,22 +1,86 @@
 UI_COLORS = {
-    "blue-0": {
+    "blue": {
         "light": "#007dff",
-        "dark": "#045ab4",
+        "dark": "#339dff",
     },
-    "orange-0": {
-        "light": "#e07807",
-        "dark": "#e07807",
+    "blue-darker": {
+        "light": "#0e4781",
+        "dark": "#255581",
+    },
+    "blue-lighter": {
+        "light": "#8cc5ff",
+        "dark": "#a3d3ff",
+    },
+    "gray": {
+        "light": "#b0b0b0",
+        "dark": "#828282",
+    },
+    "gray-darker": {
+        "light": "#5e5e5e",
+        "dark": "#494949",
+    },
+    "gray-lighter": {
+        "light": "#dbdbdb",
+        "dark": "#c7c7c7",
     },
-    "green-0": {
+    "green": {
         "light": "#1ca92a",
-        "dark": "#005c09",
+        "dark": "#2ecc40",
+    },
+    "green-darker": {
+        "light": "#1b5a21",
+        "dark": "#236a2b",
+    },
+    "green-lighter": {
+        "light": "#99d89f",
+        "dark": "#a1e8a9",
+    },
+    "orange": {
+        "light": "#e07807",
+        "dark": "#ff9933",
     },
-    "red-0": {
+    "orange-darker": {
+        "light": "#734411",
+        "dark": "#815325",
+    },
+    "orange-lighter": {
+        "light": "#f1c28f",
+        "dark": "#ffd1a3",
+    },
+    "purple": {
+        "light": "#7b61ff",
+        "dark": "#a394ff",
+    },
+    "purple-darker": {
+        "light": "#463a81",
+        "dark": "#585181",
+    },
+    "purple-lighter": {
+        "light": "#c4b8ff",
+        "dark": "#d6cfff",
+    },
+    "red": {
         "light": "#e01f1f",
-        "dark": "#960606",
+        "dark": "#ff4c4c",
+    },
+    "red-darker": {
+        "light": "#731c1c",
+        "dark": "#813131",
+    },
+    "red-lighter": {
+        "light": "#f19a9a",
+        "dark": "#ffaeae",
+    },
+    "turquoise": {
+        "light": "#00bfa5",
+        "dark": "#26d7c5",
+    },
+    "turquoise-darker": {
+        "light": "#0e6459",
+        "dark": "#1f6f67",
     },
-    "gray-0": {
-        "light": "#505d68",
-        "dark": "#4f5868",
+    "turquoise-lighter": {
+        "light": "#8ce2d7",
+        "dark": "#9dede5",
     },
 }

nautobot/core/ui/echarts.py

@@ -5,7 +5,7 @@ from typing import Any, Callable
 from django.db.models import QuerySet
 from django.template import Context
 
-from nautobot.core.ui.choices import EChartsTypeChoices, EChartsTypeTheme
+from nautobot.core.ui.choices import EChartsThemeColors, EChartsTypeChoices
 from nautobot.core.utils.lookup import resolve_attr
 
 
@@ -216,7 +216,7 @@ class EChartsBase:
         x_label="X",
         y_label="Y",
         legend=None,
-        theme=EChartsTypeTheme.DEFAULT,
+        theme_colors=None,
         renderer="canvas",
         show_toolbox=True,
         save_image_options=None,
@@ -245,7 +245,8 @@ class EChartsBase:
                     }
                 You can also hide the legend entirely by setting `"show": False`.
                 More details here: https://echarts.apache.org/handbook/en/concepts/legend.
-            theme (str): Theme for chart (default: EChartsTypeTheme.DEFAULT).
+            theme_colors (list[dict[str, str]]): Color palette for chart, each color is {'light': str, 'dark': str}
+                (default: EChartsThemeColors.NAUTOBOT_COLORS).
             renderer (str): If the renderer is set to 'canvas' when chart initialized (default), then
                 'png' (default) and 'jpg' are supported. If the renderer is set to 'svg' when chart
                 initialized, then only 'svg' is supported for type. See more details:
@@ -271,7 +272,7 @@ class EChartsBase:
         self.x_label = x_label
         self.y_label = y_label
         self.legend = legend or {}
-        self.theme = theme
+        self.theme_colors = theme_colors or EChartsThemeColors.NAUTOBOT_COLORS
         self.renderer = renderer
         self.show_toolbox = show_toolbox
         self.save_image_options = {"name": self.header or "echart", "show": True, **(save_image_options or {})}
@@ -279,10 +280,12 @@ class EChartsBase:
         self.permission = permission
         self.combined_with = combined_with
 
-    @property
-    def get_tranform_data(self) -> dict[str, Any]:
+    def get_transform_data(self, context: Context | None = None) -> dict[str, Any]:
         """Get the chart data in ECharts format, ready for rendering."""
-        resolved_data = self._data() if callable(self._data) else self._data
+        if context and callable(self._data):
+            resolved_data = self._data(context)
+        else:
+            resolved_data = self._data() if callable(self._data) else self._data
         return self._transform_data(resolved_data or {})
 
     @property
@@ -299,11 +302,6 @@ class EChartsBase:
         """
         return self._data
 
-    @data.setter
-    def data(self, data):
-        """Set the data."""
-        self._data = data
-
     @property
     def chart_type(self):
         """Get the current chart type."""
@@ -378,13 +376,9 @@ class EChartsBase:
 
         return original
 
-    def get_theme_colors(self):
-        """Map SCSS palette to echarts theme colors (manual sync)."""
-        return EChartsTypeTheme.COLORS.get(self.theme, EChartsTypeTheme.COLORS[EChartsTypeTheme.DEFAULT])
-
-    def get_config(self):
+    def get_config(self, context: Context | None = None):
         """Return a dict ready to dump into echarts option JSON."""
-        data = self.get_tranform_data
+        data = self.get_transform_data(context=context)
 
         # Base configuration
         config = {
@@ -393,7 +387,7 @@ class EChartsBase:
             "toolbox": self.strategy.get_toolbox_config(
                 self.show_toolbox, self.save_image_options, self.data_view_options
             ),
-            "color": self.get_theme_colors(),
+            "color": self.theme_colors,
             "legend": self.legend,
         }
         axis_config = self.strategy.get_axis_config(data, self.x_label, self.y_label)
@@ -408,7 +402,8 @@ class EChartsBase:
 
         # Handle combined charts
         if self.combined_with:
-            combined_series = self.combined_with.strategy.get_series_config(self.combined_with.data)
+            data = self.combined_with.get_transform_data(context=context)
+            combined_series = self.combined_with.strategy.get_series_config(data)
             config["series"].extend(combined_series)
 
         return config