nautobot 2.4.13__py3-none-any.whl → 2.4.15__py3-none-any.whl

nautobot/core/tables.py

@@ -5,7 +5,7 @@ from django.conf import settings
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.core.exceptions import FieldDoesNotExist, FieldError
-from django.db.models import Prefetch
+from django.db.models import Prefetch, QuerySet
 from django.db.models.fields.related import ForeignKey, RelatedField
 from django.db.models.fields.reverse_related import ManyToOneRel
 from django.urls import reverse
@@ -80,14 +80,14 @@ class BaseTable(django_tables2.Table):
                 reverse_lookup="static_group_associations__associated_object_id",
             )
 
-        for cf in models.CustomField.objects.get_for_model(model):
+        for cf in models.CustomField.objects.get_for_model(model, get_queryset=False):
             name = cf.add_prefix_to_cf_key()
             self.base_columns[name] = CustomFieldColumn(cf)
 
-        for cpf in models.ComputedField.objects.get_for_model(model):
+        for cpf in models.ComputedField.objects.get_for_model(model, get_queryset=False):
             self.base_columns[f"cpf_{cpf.key}"] = ComputedFieldColumn(cpf)
 
-        for relationship in models.Relationship.objects.get_for_model_source(model):
+        for relationship in models.Relationship.objects.get_for_model_source(model, get_queryset=False):
             if not relationship.symmetric:
                 self.base_columns[f"cr_{relationship.key}_src"] = RelationshipColumn(
                     relationship, side=choices.RelationshipSideChoices.SIDE_SOURCE
@@ -97,7 +97,7 @@ class BaseTable(django_tables2.Table):
                     relationship, side=choices.RelationshipSideChoices.SIDE_PEER
                 )
 
-        for relationship in models.Relationship.objects.get_for_model_destination(model):
+        for relationship in models.Relationship.objects.get_for_model_destination(model, get_queryset=False):
             if not relationship.symmetric:
                 self.base_columns[f"cr_{relationship.key}_dst"] = RelationshipColumn(
                     relationship, side=choices.RelationshipSideChoices.SIDE_DESTINATION
@@ -333,6 +333,29 @@ class BaseTable(django_tables2.Table):
             # Otherwise, use the default sorting method
             self.data.order_by(self._order_by)
 
+    def add_conditional_prefetch(self, table_field, db_column=None, prefetch=None):
+        """Conditionally prefetch the specified database column if the related table field is visible.
+
+        Args:
+            table_field (str): Name of the field on the table to check for visibility. Also used as the prefetch field
+                               if neither db_column nor prefetch is specified.
+            db_column (str): Optionally specify the db column to prefetch. Mutually exclusive with prefetch.
+            prefetch (Prefetch): Optionally specify a prefetch object. Mutually exclusive with db_column.
+        """
+        if db_column and prefetch:
+            raise ValueError(
+                "BaseTable.add_conditional_prefetch called with both db_column and prefetch, this is not allowed."
+            )
+        if not db_column:
+            db_column = table_field
+        if table_field in self.columns and self.columns[table_field].visible and isinstance(self.data.data, QuerySet):
+            if prefetch:
+                self.data = TableData.from_data(self.data.data.prefetch_related(prefetch))
+            else:
+                self.data = TableData.from_data(self.data.data.prefetch_related(db_column))
+            self.data.set_table(self)
+            self.rows = BoundRows(data=self.data, table=self, pinned_data=self.pinned_data)
+
 
 #
 # Table columns
@@ -353,7 +376,7 @@ class ToggleColumn(django_tables2.CheckBoxColumn):
 
     @property
     def header(self):
-        return mark_safe('<input type="checkbox" class="toggle" title="Toggle all" />')  # noqa: S308  # suspicious-mark-safe-usage, but this is a static string so it's safe
+        return mark_safe('<input type="checkbox" class="toggle" title="Toggle all" />')
 
 
 class BooleanColumn(django_tables2.Column):

nautobot/core/templates/base_django.html

@@ -5,7 +5,7 @@
 <!DOCTYPE html>
 <html lang="en"{% if request.COOKIES|get_item:"theme" == 'dark' %} data-theme="dark"{% endif %}>
 <head>
-    <title>{% block title %}Home{% endblock %} - {{ settings.BRANDING_TITLE }}</title>
+    <title>{% block title %}Home{% endblock %}{% block document_title_extra %}{% endblock %} - {{ settings.BRANDING_TITLE }}</title>
     {% include 'inc/media.html' %}
     {% block extra_styles %}{% endblock %}
 </head>

nautobot/core/templates/components/panel/header_extra_content_table.html

@@ -6,7 +6,7 @@
 {% endif %}
 
 <div class="pull-right noprint">
-    {% if request.user.is_authenticated %}
+    {% if request.user.is_authenticated and show_table_config_button %}
         {% table_config_button_small body_content_table %}
     {% endif %}
 </div>

nautobot/core/templates/generic/object_list.html

@@ -4,18 +4,26 @@
 {% load perms %}
 {% load plugins %}
 {% load static %}
+{% load ui_framework %}
+
+{% block document_title_extra %}{% saved_view_title "plain" %}{% endblock %}
 
 {% block header %}
     <div class="row noprint">
         <div class="{% if search_form %}col-sm-8 col-md-9 {% else %} col-md-12 {% endif %}">
-            <ol class="breadcrumb">
-            {% block breadcrumbs %}
-                {% if list_url %}
-                <li><a href="{% url list_url %}">{{ title }}</a></li>
-                {% endif %}
-                {% block extra_breadcrumbs %}{% endblock extra_breadcrumbs %}
-            {% endblock breadcrumbs %}
-            </ol>
+            {% if breadcrumbs is not None %}
+                {% render_breadcrumbs %}
+            {% else %}
+                {# TODO: remove this fragment after breadcrumbs implementation in generic views like ConsoleConnectionsListView #}
+                <ol class="breadcrumb">
+                    {% block breadcrumbs %}
+                        {% if list_url %}
+                            <li><a href="{% url list_url %}">{{ title }}</a></li>
+                        {% endif %}
+                        {% block extra_breadcrumbs %}{% endblock extra_breadcrumbs %}
+                    {% endblock breadcrumbs %}
+                </ol>
+            {% endif %}
         </div>
         {% if search_form %}
         <div class="col-sm-4 col-md-3">
@@ -146,18 +154,7 @@
         {% endblock export_button %}
     {% endif %}
 </div>
-<h1>{% block title %}
-    {{ title }}
-        {% if current_saved_view %}
-            —
-            {% if new_changes_not_applied %}
-                <i title="Pending changes not saved">{{ current_saved_view.name }}</i>
-            {% else %}
-                {{ current_saved_view.name }}
-            {% endif %}
-        {% endif %}
-    {% endblock %}
-</h1>
+<h1>{% block title %}{% render_title %}{% endblock %}{% saved_view_title %}</h1>
 {% block header_extra %}{% endblock %}
 {% if filter_params %}
 <div class="filters-applied">

nautobot/core/templates/inc/breadcrumbs.html

@@ -0,0 +1,14 @@
+<ol class="breadcrumb">
+    {% block breadcrumbs %}
+        {% for url, title in breadcrumbs_items %}
+            <li>
+            {% if url %}
+                <a href="{{ url }}">{{ title }}</a>
+            {% else %}
+                {{ title }}
+            {% endif %}
+            </li>
+        {% endfor %}
+        {% block extra_breadcrumbs %}{% endblock extra_breadcrumbs %}
+    {% endblock %}
+</ol>

nautobot/core/templatetags/buttons.py

@@ -176,8 +176,6 @@ def consolidate_bulk_action_buttons(context):
             "bulk_action_buttons": bulk_action_buttons,
         }
 
-    params = ("?" + context["request"].GET.urlencode()) if context["request"].GET else ""
-
     primary_button_fragment = child_button_fragment = """
         <button {attrs}>
             <span class="{icon}" aria-hidden="true"></span> {label}
@@ -203,7 +201,7 @@ def consolidate_bulk_action_buttons(context):
                 attrs=render_tag_attrs(
                     {
                         "class": edit_button_classes,
-                        "formaction": reverse(context["bulk_edit_url"]) + params,
+                        "formaction": reverse(context["bulk_edit_url"]),
                         "type": "submit",
                     }
                 ),
@@ -242,7 +240,7 @@ def consolidate_bulk_action_buttons(context):
                         "class": delete_button_classes,
                         "type": "submit",
                         "name": "_delete",
-                        "formaction": reverse(context["bulk_delete_url"]) + params,
+                        "formaction": reverse(context["bulk_delete_url"]),
                     }
                 ),
                 icon="mdi mdi-trash-can-outline",

nautobot/core/templatetags/helpers.py

@@ -2,6 +2,7 @@ import datetime
 import json
 import logging
 import re
+from typing import Literal
 from urllib.parse import parse_qs, quote_plus
 
 from django import template
@@ -12,7 +13,7 @@ from django.contrib.staticfiles.finders import find
 from django.core.exceptions import ObjectDoesNotExist
 from django.templatetags.static import static, StaticNode
 from django.urls import NoReverseMatch, reverse
-from django.utils.html import format_html, format_html_join
+from django.utils.html import format_html, format_html_join, strip_tags
 from django.utils.safestring import mark_safe
 from django.utils.text import slugify as django_slugify
 from django_jinja import library
@@ -25,10 +26,9 @@ from nautobot.core.constants import PAGINATE_COUNT_DEFAULT
 from nautobot.core.utils import color, config, data, logging as nautobot_logging, lookup
 from nautobot.core.utils.requests import add_nautobot_version_query_param_to_url
 
-# S308 is suspicious-mark-safe-usage, but these are all using static strings that we know to be safe
-HTML_TRUE = mark_safe('<span class="text-success"><i class="mdi mdi-check-bold" title="Yes"></i></span>')  # noqa: S308
-HTML_FALSE = mark_safe('<span class="text-danger"><i class="mdi mdi-close-thick" title="No"></i></span>')  # noqa: S308
-HTML_NONE = mark_safe('<span class="text-muted">&mdash;</span>')  # noqa: S308
+HTML_TRUE = mark_safe('<span class="text-success"><i class="mdi mdi-check-bold" title="Yes"></i></span>')
+HTML_FALSE = mark_safe('<span class="text-danger"><i class="mdi mdi-close-thick" title="No"></i></span>')
+HTML_NONE = mark_safe('<span class="text-muted">&mdash;</span>')
 
 DEFAULT_SUPPORT_MESSAGE = (
     "If further assistance is required, please join the `#nautobot` channel "
@@ -1124,7 +1124,7 @@ def custom_branding_or_static(branding_asset, static_asset):
     branding has been configured in settings, else it returns stock branding via static.
     """
     if settings.BRANDING_FILEPATHS.get(branding_asset):
-        url = f"{ settings.MEDIA_URL }{ settings.BRANDING_FILEPATHS.get(branding_asset) }"
+        url = f"{settings.MEDIA_URL}{settings.BRANDING_FILEPATHS.get(branding_asset)}"
     else:
         url = StaticNode.handle_simple(static_asset)
     return add_nautobot_version_query_param_to_url(url)
@@ -1255,3 +1255,26 @@ def _build_hyperlink(value, field="", target="", rel=""):
         except AttributeError:
             pass
     return format_html("{}", display)
+
+
+@register.simple_tag(takes_context=True)
+def saved_view_title(context, mode: Literal["html", "plain"] = "html"):
+    """
+    Creates a formatted title that includes saved view information.
+    Usage: <h1>{{ title }}{% saved_view_title "html" %}</h1>
+    """
+    new_changes_not_applied = context.get("new_changes_not_applied", False)
+    current_saved_view = context.get("current_saved_view")
+
+    if not current_saved_view:
+        return ""
+
+    if new_changes_not_applied:
+        title = format_html(' — <i title="Pending changes not saved">{}</i>', current_saved_view.name)
+    else:
+        title = format_html(" — {}", current_saved_view.name)
+
+    if mode == "plain":
+        return strip_tags(title)
+
+    return title

nautobot/core/templatetags/ui_framework.py

@@ -3,6 +3,8 @@ import logging
 from django import template
 from django.utils.html import format_html_join
 
+from nautobot.core.ui.breadcrumbs import Breadcrumbs
+from nautobot.core.ui.titles import Titles
 from nautobot.core.utils.lookup import get_view_for_model
 from nautobot.core.views.utils import get_obj_from_context
 
@@ -27,6 +29,25 @@ def render_components(context, components):
     return ""
 
 
+@register.simple_tag(takes_context=True)
+def render_title(context, mode="plain"):
+    title_obj = context.get("view_titles")
+    if title_obj is not None and isinstance(title_obj, Titles):
+        return title_obj.render(context, mode=mode)
+
+    if fallback_title := context.get("title"):
+        return fallback_title
+    return ""
+
+
+@register.simple_tag(takes_context=True)
+def render_breadcrumbs(context):
+    breadcrumbs_obj = context.get("breadcrumbs")
+    if breadcrumbs_obj is not None and isinstance(breadcrumbs_obj, Breadcrumbs):
+        return breadcrumbs_obj.render(context)
+    return ""
+
+
 @register.simple_tag(takes_context=True)
 def render_detail_view_extra_buttons(context):
     """

nautobot/core/testing/api.py

@@ -7,6 +7,7 @@ from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import connections, DEFAULT_DB_ALIAS
 from django.db.models import ForeignKey, ManyToManyField, QuerySet
+from django.http import QueryDict
 from django.test import override_settings, tag
 from django.test.utils import CaptureQueriesContext
 from django.urls import reverse
@@ -105,6 +106,12 @@ class APITestCase(views.ModelTestCase):
                 m2m_fields.append(field_name)
         return m2m_fields
 
+    @staticmethod
+    def add_query_params_to_url(url: str, query_dict: dict) -> str:
+        query = QueryDict(mutable=True)
+        query.update(query_dict)
+        return f"{url}?{query.urlencode()}"
+
 
 @tag("unit")
 class APIViewTestCases:

nautobot/core/testing/filters.py

@@ -15,6 +15,7 @@ from nautobot.core.filters import (
     ContentTypeChoiceFilter,
     ContentTypeFilter,
     ContentTypeMultipleChoiceFilter,
+    NaturalKeyOrPKMultipleChoiceFilter,
     RelatedMembershipBooleanFilter,
     SearchFilter,
 )
@@ -207,15 +208,29 @@ class FilterTestCases:
                     qs_result = self.queryset.filter(**{f"{field_name}__in": test_data}).distinct()
                     self.assertQuerysetEqualAndNotEmpty(filterset_result, qs_result, ordered=False)
 
+        def test_automagic_filters(self):
+            """https://github.com/nautobot/nautobot/issues/6656"""
+            self.assertIsNotNone(self.filterset)
+            fs = self.filterset()  # pylint: disable=not-callable
+            if getattr(self.queryset.model, "is_contact_associable_model", False):
+                self.assertIsInstance(fs.filters["contacts"], NaturalKeyOrPKMultipleChoiceFilter)
+                self.assertIsInstance(fs.filters["contacts__n"], NaturalKeyOrPKMultipleChoiceFilter)
+                self.assertIsInstance(fs.filters["teams"], NaturalKeyOrPKMultipleChoiceFilter)
+                self.assertIsInstance(fs.filters["teams__n"], NaturalKeyOrPKMultipleChoiceFilter)
+
+            if getattr(self.queryset.model, "is_dynamic_group_associable_model", False):
+                self.assertIsInstance(fs.filters["dynamic_groups"], NaturalKeyOrPKMultipleChoiceFilter)
+                self.assertIsInstance(fs.filters["dynamic_groups__n"], NaturalKeyOrPKMultipleChoiceFilter)
+
         def test_boolean_filters_generic(self):
-            """Test all `RelatedMembershipBooleanFilter` filters found in `self.filterset.get_filters()`
+            """Test all `RelatedMembershipBooleanFilter` filters found in `self.filterset.filters`
             except for the ones with custom filter logic defined in its `method` attribute.
 
             This test asserts that `filter=True` matches `self.queryset.filter(field__isnull=False)` and
             that `filter=False` matches `self.queryset.filter(field__isnull=True)`.
             """
             self.assertIsNotNone(self.filterset)
-            for filter_name, filter_object in self.filterset.get_filters().items():
+            for filter_name, filter_object in self.filterset().filters.items():  # pylint: disable=not-callable
                 if not isinstance(filter_object, RelatedMembershipBooleanFilter):
                     continue
                 if filter_object.method is not None:
@@ -380,6 +395,8 @@ class FilterTestCases:
                     self._assert_q_filter_predicate_validity(obj, obj_field_name, filter_field_name, lookup_method)
 
         def test_content_type_related_fields_uses_content_type_filter(self):
+            self.assertIsNotNone(self.filterset)
+            fs = self.filterset()  # pylint: disable=not-callable
             for field in self.queryset.model._meta.fields:
                 related_model = getattr(field, "related_model", None)
                 if not related_model or related_model != ContentType:
@@ -387,7 +404,7 @@ class FilterTestCases:
                 with self.subTest(
                     f"Assert {self.filterset.__class__.__name__}.{field.name} implements ContentTypeFilter"
                 ):
-                    filter_field = self.filterset.get_filters().get(field.name)
+                    filter_field = fs.filters.get(field.name)
                     if not filter_field:
                         # This field is not part of the Filterset.
                         continue

nautobot/core/testing/forms.py

@@ -24,7 +24,7 @@ class FormTestCases:
                         self.skipTest(f"{self.form_class.__name__}.{field_name} has no query_params")
                     field_model = field_class.queryset.model
                     filterset_class = get_filterset_for_model(field_model)
-                    filterset_fields = set(filterset_class.get_filters().keys())
+                    filterset_fields = set(filterset_class().filters.keys())
                     invalid_query_params = query_params_fields - filterset_fields
                     self.assertFalse(
                         invalid_query_params,

nautobot/core/tests/integration/test_filters.py

@@ -148,7 +148,7 @@ class ListViewFilterTestCase(SeleniumTestCase):
 
     def test_input_field_gets_updated(self):
         """Assert that a filter input/select field on Dynamic Filter Form updates if same field is updated."""
-        self.browser.visit(f'{self.live_server_url}{reverse("dcim:location_list")}')
+        self.browser.visit(f"{self.live_server_url}{reverse('dcim:location_list')}")
 
         text_field_name = self.custom_fields[0].add_prefix_to_cf_key()
         integer_field_name = self.custom_fields[1].add_prefix_to_cf_key()
@@ -225,7 +225,7 @@ class ListViewFilterTestCase(SeleniumTestCase):
     def test_advanced_filter_application(self):
         """Assert that filters are applied successfully when using the advanced filter."""
         # Go to the location list view
-        self.browser.visit(f'{self.live_server_url}{reverse("dcim:location_list")}')
+        self.browser.visit(f"{self.live_server_url}{reverse('dcim:location_list')}")
         # create a new tag
         tag = Tag.objects.create(name="Tag1")
         tag.content_types.set([ContentType.objects.get_for_model(Location)])