nautobot 2.4.21__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/core/ui/object_detail.py

@@ -4,6 +4,8 @@ import contextlib
 from dataclasses import dataclass
 from enum import Enum
 import logging
+from typing import Any
+import uuid
 
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import FieldDoesNotExist, ObjectDoesNotExist
@@ -35,14 +37,17 @@ from nautobot.core.templatetags.helpers import (
     render_json,
     render_markdown,
     slugify,
+    table_config_form,
     validated_viewname,
 )
 from nautobot.core.ui.choices import LayoutChoices, SectionChoices
+from nautobot.core.ui.echarts import EChartsBase
 from nautobot.core.ui.utils import render_component_template
 from nautobot.core.utils.lookup import get_filterset_for_model, get_route_for_model
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import get_obj_from_context
+from nautobot.data_validation.tables import DataComplianceTable
 from nautobot.dcim.models import Rack
 from nautobot.extras.choices import CustomFieldTypeChoices
 from nautobot.extras.tables import AssociatedContactsTable, DynamicGroupTable, ObjectMetadataTable
@@ -97,6 +102,7 @@ class ObjectDetailContent:
             _ObjectDetailContactsTab(),
             _ObjectDetailGroupsTab(),
             _ObjectDetailMetadataTab(),
+            _ObjectDetailDataComplianceTab(),
         ]
         if extra_tabs is not None:
             tabs.extend(extra_tabs)
@@ -197,7 +203,7 @@ class Button(Component):
         size=None,
         link_includes_pk=True,
         context_object_key=None,
-        render_on_tab_id="__all__",
+        render_on_tab_id="main",
         **kwargs,
     ):
         """
@@ -376,8 +382,9 @@ class Tab(Component):
     WEIGHT_CONTACTS_TAB = 300
     WEIGHT_GROUPS_TAB = 400
     WEIGHT_METADATA_TAB = 500
-    WEIGHT_NOTES_TAB = 600  # reserved, not yet using this framework
-    WEIGHT_CHANGELOG_TAB = 700  # reserved, not yet using this framework
+    WEIGHT_DATACOMPLIANCE_TAB = 600
+    WEIGHT_NOTES_TAB = 700  # reserved, not yet using this framework
+    WEIGHT_CHANGELOG_TAB = 800  # reserved, not yet using this framework
 
     def panels_for_section(self, section):
         """
@@ -420,6 +427,9 @@ class Tab(Component):
         """
         Only render a main-view Tab if the active request is for the main object view rather than a separate action.
         """
+        if not self.should_render(context):
+            return False
+
         request = context["request"]
         obj = get_obj_from_context(context)
         return request.path == obj.get_absolute_url()
@@ -435,6 +445,7 @@ class Tab(Component):
                 "tab_id": self.tab_id,
                 "label": self.render_label(context),
                 "include_plugin_content": self.tab_id == "main",
+                "include_timestamps_and_buttons": self.tab_id == "main",
                 "left_half_panels": self.panels_for_section(SectionChoices.LEFT_HALF),
                 "right_half_panels": self.panels_for_section(SectionChoices.RIGHT_HALF),
                 "full_width_panels": self.panels_for_section(SectionChoices.FULL_WIDTH),
@@ -504,6 +515,9 @@ class DistinctViewTab(Tab):
         """
         A DistinctViewTab should only render its content if the view in question is active.
         """
+        if not self.should_render(context):
+            return False
+
         with context.update(self.get_extra_context(context)):
             request = context["request"]
             return request.path == context["url"]
@@ -581,6 +595,8 @@ class Panel(Component):
         """
         if not self.should_render(context):
             return ""
+        if not self.body_id:
+            self.body_id = self._get_body_id(context)
         with context.update(self.get_extra_context(context)):
             return render_component_template(
                 self.template_path,
@@ -590,11 +606,21 @@ class Panel(Component):
                 header_extra_content=self.render_header_extra_content(context),
                 body=self.render_body(context),
                 footer_content=self.render_footer_content(context),
+                body_id=self.body_id,
             )
 
+    def _get_body_id(self, context: Context):
+        """Retreive the `body_id` attribute to the rendered components, used for the collapsible panel feature."""
+        if self.body_id:
+            return self.body_id
+        if self.label:
+            return slugify(self.label)
+
+        return str(uuid.uuid4())
+
     def render_label(self, context: Context):
         """Render the label of this panel, if any."""
-        return self.label
+        return self.label.upper()
 
     def render_header_extra_content(self, context: Context):
         """
@@ -790,8 +816,8 @@ class ObjectsTablePanel(Panel):
                 If None, defaults to the `get_paginate_count()` (which is user's preference or a global setting).
             paginate (bool, optional): If False, do not attach a paginator to the table and render all rows
                 (or up to `max_display_count` if provided). Defaults to True.
-            show_table_config_button (bool, optional): If False, hide the small "Configure" button rendered in the
-                panel header for this table. Defaults to True.
+            show_table_config_button (bool, optional): If False, do not allow user configuration of the table.
+                Defaults to True.
             table_title (str, optional): The title to display in the panel heading for the table.
                 If None, defaults to the plural verbose name of the table model.
             include_columns (list, optional): A list of field names to include in the table display.
@@ -904,6 +930,16 @@ class ObjectsTablePanel(Panel):
 
         return body_content_table_add_url
 
+    def render_table_config_form(self, context: Context):
+        if not self.should_render(context):
+            return ""
+        if not self.show_table_config_button:
+            return ""
+        context = self.get_extra_context(context)
+        return render_to_string(
+            "utilities/templatetags/table_config_form.html", table_config_form(context["body_content_table"])
+        )
+
     def get_extra_context(self, context: Context):
         """Add additional context for rendering the table panel.
 
@@ -946,7 +982,10 @@ class ObjectsTablePanel(Panel):
             if self.distinct:
                 body_content_table_queryset = body_content_table_queryset.distinct()
             body_content_table = body_content_table_class(
-                body_content_table_queryset, hide_hierarchy_ui=self.hide_hierarchy_ui, user=request.user
+                body_content_table_queryset,
+                hide_hierarchy_ui=self.hide_hierarchy_ui,
+                user=request.user,
+                configurable=self.show_table_config_button,
             )
             if self.tab_id and "actions" in body_content_table.columns:
                 # Use the `self.tab_id`, if it exists, to determine the correct return URL for the table
@@ -1022,7 +1061,7 @@ class ObjectsTablePanel(Panel):
             "form_id": self.form_id,
             "more_queryset_count": more_queryset_count,
             "include_paginator": self.include_paginator,
-            "show_table_config_button": self.show_table_config_button,
+            "show_table_config_button": self.show_table_config_button,  # unused now in core but kept for compatibility
         }
 
 
@@ -1226,10 +1265,11 @@ class KeyValueTablePanel(Panel):
                 else:
                     value_tag = format_html(
                         """
-                            <span class="hover_copy">
+                            <span>
                                 <span id="{unique_id}_value_{key}">{value}</span>
-                                <button class="btn btn-inline btn-default hover_copy_button" data-clipboard-target="#{unique_id}_value_{key}">
-                                    <span class="mdi mdi-content-copy"></span>
+                                <button class="btn btn-secondary nb-btn-inline-hover" data-clipboard-target="#{unique_id}_value_{key}">
+                                    <span aria-hidden="true" class="mdi mdi-content-copy"></span>
+                                    <span class="visually-hidden">Copy</span>
                                 </button>
                             </span>
                         """,
@@ -1244,6 +1284,83 @@ class KeyValueTablePanel(Panel):
         return result
 
 
+class EChartsPanel(Panel, EChartsBase):
+    """A panel that renders ECharts charts using the EChartsBase class."""
+
+    def __init__(
+        self,
+        *,
+        chart_kwargs=None,
+        width="100%",
+        height="32rem",
+        chart_container_id=None,
+        body_wrapper_template_path="components/echarts.html",
+        **kwargs,
+    ):
+        """
+        Initialize an ECharts panel.
+
+        Args:
+            chart_kwargs (dict): Kwargs to pass to EChartsBase constructor.
+            width (str): CSS width for the chart container (default: "100%").
+            height (str): CSS height for the chart container (default: "32rem").
+            chart_container_id (str): Custom HTML ID for the chart container. If None, auto-generated.
+        """
+        self.width = width
+        self.height = height
+        self.chart_container_id = chart_container_id
+        self.body_id = (
+            self.chart_container_id or f"{slugify('echart-' + chart_kwargs.get('header', ''))}-{uuid.uuid4().hex[:8]}"
+        )
+
+        super().__init__(body_wrapper_template_path=body_wrapper_template_path, body_id=self.body_id, **kwargs)
+        EChartsBase.__init__(self, **chart_kwargs)
+
+    def get_data(self, context: Context) -> dict[str, Any] | None:
+        """Get the data for chart.
+
+        Args:
+            context (Context): The template or request context.
+
+        Returns:
+            dict[str, Any] | None:
+                - A dictionary in internal chart format, e.g.:
+                    {"x": [...], "series": [{"name": str, "data": [...]}]}
+                - A nested dictionary of series, e.g.:
+                    {"Series1": {"x1": val1, "x2": val2}, ...}
+                - `None` if no data is set.
+        """
+        if callable(self.data):
+            return self.data(context)  # pylint: disable=not-callable
+        return self.data
+
+    def should_render(self, context: Context):
+        """Determine if the panel should be rendered."""
+        if not super().should_render(context):
+            return False
+
+        # Check permissions if specified
+        if self.permission:
+            request = context.get("request")
+            if request and hasattr(request, "user"):
+                return request.user.has_perm(self.permission)
+
+        return True
+
+    def get_extra_context(self, context: Context):
+        """Add chart-specific context variables."""
+        self.data = self.get_data(context)
+        chart_config = self.get_config()
+        return {
+            **super().get_extra_context(context),
+            "chart": self,
+            "chart_config": chart_config,
+            "chart_width": self.width,
+            "chart_height": self.height,
+            "chart_container_id": self.body_id,
+        }
+
+
 class ObjectFieldsPanel(KeyValueTablePanel):
     """A panel that renders a table of object instance attributes and their values."""
 
@@ -1291,7 +1408,7 @@ class ObjectFieldsPanel(KeyValueTablePanel):
     def render_label(self, context: Context):
         """Default to rendering the provided object's `verbose_name` if no more specific `label` was defined."""
         if self.label is None:
-            return bettertitle(get_obj_from_context(context, self.context_object_key)._meta.verbose_name)
+            return get_obj_from_context(context, self.context_object_key)._meta.verbose_name.upper()
         return super().render_label(context)
 
     def render_value(self, key, value, context: Context):
@@ -1437,10 +1554,19 @@ class GroupedKeyValueTablePanel(KeyValueTablePanel):
         super().__init__(body_id=body_id, **kwargs)
 
     def render_header_extra_content(self, context: Context):
-        """Add a "Collapse All" button to the header."""
+        """Add a "Collapse All Groups" button to the header."""
         return format_html(
-            '<button type="button" class="btn-xs btn-primary pull-right accordion-toggle-all" data-target="#{body_id}">'
-            "Collapse All</button>",
+            """
+            <button
+                aria-expanded="true"
+                class="btn btn-primary btn-sm float-end"
+                data-nb-target="[class^=&quot;collapseme-{body_id}-&quot;]"
+                data-nb-toggle="collapse-all"
+                type="button"
+            >
+                Collapse All Groups
+            </button>
+            """,
             body_id=self.body_id,
         )
 
@@ -1469,7 +1595,7 @@ class GroupedKeyValueTablePanel(KeyValueTablePanel):
                 if value_display:
                     # TODO: add a copy button on hover to all display items
                     result += format_html(
-                        '<tr class="collapseme-{body_id}-{counter} collapse in" data-parent="#{body_id}">'
+                        '<tr class="collapseme-{body_id}-{counter} collapse show nb-transition-none">'
                         "<td>{key}</td><td>{value}</td></tr>",
                         counter=counter,
                         body_id=self.body_id,
@@ -2019,6 +2145,7 @@ class _ObjectDetailContactsTab(Tab):
                     # TODO: we should provide a standard reusable component template for bulk-actions in the footer
                     footer_content_template_path="components/panel/footer_contacts_table.html",
                     header_extra_content_template_path=None,
+                    label="Contacts/Teams",
                 ),
             )
         super().__init__(tab_id=tab_id, label=label, weight=weight, panels=panels, **kwargs)
@@ -2039,6 +2166,42 @@ class _ObjectDetailContactsTab(Tab):
         )
 
 
+class _ObjectDetailDataComplianceTab(DistinctViewTab):
+    """Built-in class for a Tab displaying information about data compliance."""
+
+    def __init__(
+        self,
+        *,
+        tab_id="data_compliance",
+        label="Data Compliance",
+        weight=Tab.WEIGHT_DATACOMPLIANCE_TAB,
+        panels=None,
+        **kwargs,
+    ):
+        if panels is None:
+            panels = (
+                ObjectsTablePanel(
+                    weight=100,
+                    table_class=DataComplianceTable,
+                    table_attribute="associated_data_compliance",
+                    related_field_name="object_id",
+                    label="Data Compliance",
+                    add_button_route=None,
+                    header_extra_content_template_path=None,
+                    include_paginator=True,
+                ),
+            )
+        super().__init__(url_name="", tab_id=tab_id, label=label, weight=weight, panels=panels, **kwargs)
+
+    def get_extra_context(self, context: Context):
+        return {"url": get_obj_from_context(context).get_data_compliance_url()}
+
+    def should_render(self, context: Context):
+        if not super().should_render(context):
+            return False
+        return getattr(get_obj_from_context(context), "is_data_compliance_model", False)
+
+
 class DynamicGroupsTextPanel(BaseTextPanel):
     """Panel displaying a note about caching of dynamic groups."""
 
@@ -2145,6 +2308,7 @@ class _ObjectDetailMetadataTab(Tab):
                     add_button_route=None,
                     related_field_name="assigned_object_id",
                     header_extra_content_template_path=None,
+                    label="Object Metadata",
                 ),
             )
         super().__init__(

nautobot/core/urls.py

@@ -1,10 +1,11 @@
 from django.conf import settings
 from django.http import HttpResponse, HttpResponseNotFound
 from django.urls import include, path
-from django.views.generic import TemplateView
+from django.views.generic import RedirectView, TemplateView
 
 from nautobot.core.views import (
     AboutView,
+    AppDocsView,
     CustomGraphQLView,
     get_file_with_authorization,
     HomeView,
@@ -37,6 +38,7 @@ urlpatterns = [
     # Apps
     path("circuits/", include("nautobot.circuits.urls")),
     path("cloud/", include("nautobot.cloud.urls")),
+    path("data-validation/", include("nautobot.data_validation.urls")),
     path("dcim/", include("nautobot.dcim.urls")),
     path("extras/", include("nautobot.extras.urls")),
     path("ipam/", include("nautobot.ipam.urls")),
@@ -45,6 +47,7 @@ urlpatterns = [
     path("user/", include("nautobot.users.urls")),
     path("users/", include("nautobot.users.urls", "users")),
     path("virtualization/", include("nautobot.virtualization.urls")),
+    path("vpn/", include("nautobot.vpn.urls")),
     path("wireless/", include("nautobot.wireless.urls")),
     # API
     path("api/", include("nautobot.core.api.urls")),
@@ -58,6 +61,15 @@ urlpatterns = [
     path("media-failure/", StaticMediaFailureView.as_view(), name="media_failure"),
     # Apps
     path("apps/", include((apps_patterns, "apps"))),
+    # Redirect /docs/<app_base_url>/ -> /docs/<app_base_url>/index.html
+    path(
+        "docs/<str:app_base_url>/",
+        RedirectView.as_view(pattern_name="docs_file", permanent=False),
+        kwargs={"path": "index.html"},
+        name="docs_index_redirect",
+    ),
+    # Apps docs - Serve docs file
+    path("docs/<str:app_base_url>/<path:path>", AppDocsView.as_view(), name="docs_file"),
     path("plugins/", include((plugin_patterns, "plugins"))),
     path("admin/plugins/", include(plugin_admin_patterns)),
     # Social auth/SSO

nautobot/core/utils/cache.py

@@ -0,0 +1,71 @@
+"""Utilities for conveniently working with the Django/Redis cache."""
+
+import logging
+
+from django.conf import settings
+from django.db import models
+
+logger = logging.getLogger(__name__)
+
+
+def construct_cache_key(obj, *, method_name=None, branch_aware=True, **params):
+    """
+    Construct a consistently-structured Django/Redis cache key for the given obj and/or method name.
+
+    Args:
+        obj (Any): A model class, model instance, model manager, class, or function that will make use of the cache.
+        method_name (str): Name of a specific method on `obj`. May be omitted only if `obj` is itself a function.
+        branch_aware (bool): Whether this cache key needs to vary by branch when Version Control is enabled.
+        **params (dict): Parameters that should further narrow the scope of the cache key.
+
+    Examples:
+        >>> construct_cache_key(Location.objects, method_name="max_depth")
+        'nautobot.dcim.location.max_depth'
+        >>> construct_cache_key(MinMaxValidationRule, method_name="get_for_model")
+        'nautobot.data_validation.minmaxvalidationrule.get_for_model'
+        >>> construct_cache_key(MinMaxValidationRule, method_name="get_for_model", content_type="dcim.location")
+        'nautobot.data_validation.minmaxvalidationrule.get_for_model(content_type=dcim.location)'
+        >>> construct_cache_key(CustomField.objects, method_name="get_for_model", model="dcim.location", exclude_filter_disabled=True, listing=True)
+        'nautobot.extras.customfield.get_for_model(model=dcim.location,exclude_filter_disabled=True,listing=True)'
+        >>> from nautobot.extras.utils import change_logged_models_queryset
+        >>> construct_cache_key(change_logged_models_queryset)
+        'nautobot.extras.utils.change_logged_models_queryset'
+    """
+    method_name_must_be_set = True
+    if isinstance(obj, models.Model):
+        tokens = ["nautobot", obj._meta.concrete_model._meta.label_lower, str(obj.pk), method_name]
+    elif isinstance(obj, models.Manager):
+        tokens = ["nautobot", obj.model._meta.concrete_model._meta.label_lower, method_name]
+    elif isinstance(obj, type):
+        # A class object
+        if issubclass(obj, models.Model):
+            tokens = ["nautobot", obj._meta.concrete_model._meta.label_lower, method_name]
+        elif issubclass(obj, models.Manager):
+            tokens = ["nautobot", obj.model._meta.concrete_model._meta.label_lower, method_name]
+        else:
+            tokens = [obj.__module__, obj.__name__, method_name]
+    elif method_name is not None:
+        # An instance of any class not specifically handled above
+        tokens = [obj.__module__, obj.__class__.__name__, method_name]
+    else:
+        # A standalone function
+        tokens = [obj.__module__, obj.__name__]
+        method_name_must_be_set = False
+
+    if method_name_must_be_set and method_name is None:
+        raise ValueError("method_name must be specified for the given obj")
+
+    if branch_aware and "nautobot_version_control" in settings.PLUGINS:
+        from nautobot_version_control.utils import active_branch  # pylint: disable=import-error
+
+        tokens += ["branch", active_branch()]
+
+    cache_key = ".".join(tokens)
+
+    params_tokens = [f"{key}={value}" for key, value in params.items()]
+    if params_tokens:
+        cache_key += f"({','.join(params_tokens)})"
+
+    # Disabled as it's very noisy in some cases
+    # logger.debug("Constructed cache key is %s", cache_key)
+    return cache_key

nautobot/core/utils/data.py

@@ -28,9 +28,10 @@ def flatten_dict(d, prefix="", separator="."):
     """
     Flatten nested dictionaries into a single level by joining key names with a separator.
 
-    :param d: The dictionary to be flattened
-    :param prefix: Initial prefix (if any)
-    :param separator: The character to use when concatenating key names
+    Args:
+        d (dict): The dictionary to be flattened
+        prefix (str): Initial prefix (if any)
+        separator (str): The character to use when concatenating key names
     """
     ret = {}
     for k, v in d.items():
@@ -46,8 +47,10 @@ def flatten_iterable(iterable):
     """
     Flatten a nested iterable such as a list of lists, keeping strings intact.
 
-    :param iterable: The iterable to be flattened
-    :returns: generator
+    Args:
+        iterable (Iterable): The iterable to be flattened
+
+    Yields: str
     """
     for i in iterable:
         if hasattr(i, "__iter__") and not isinstance(i, str):

nautobot/core/utils/filtering.py

@@ -18,12 +18,18 @@ from nautobot.core.utils.lookup import get_filterset_for_model
 CONTAINS_LOOKUP_EXPR_RE = re.compile(r"(?<=__)\w+")
 
 MODEL_VERBOSE_NAME_PLURAL_TO_FEATURE_NAME_MAPPING = {
+    "approval_workflow_definitions": "approval_workflows",
     "cables": "cable_terminations",
+    "data_compliance": "custom_validators",
+    "location_types": "locations",
     "metadata_types": "metadata",
+    "min_max_validation_rules": "custom_validators",
     "object_metadata": "metadata",
-    "location_types": "locations",
-    "static_group_associations": "dynamic_groups",
+    "regular_expression_validation_rules": "custom_validators",
     "relationship_associations": "relationships",
+    "required_validation_rules": "custom_validators",
+    "static_group_associations": "dynamic_groups",
+    "unique_validation_rules": "custom_validators",
 }
 
 

nautobot/core/utils/git.py

@@ -41,10 +41,10 @@ def swap_status_initials(data):
 
 def convert_git_diff_log_to_list(logs):
     """
-    Convert Git diff log into a list splitted by \\n
+    Convert Git diff log into a list splitted by `\\n`
 
-    Example:
-        >>> git_log = "M\tindex.html\nR\tsample.txt"
+    Examples:
+        >>> git_log = "M\\tindex.html\\nR\\tsample.txt"
         >>> print(convert_git_diff_log_to_list(git_log))
         ["Modification - index.html", "Renaming - sample.txt"]
     """