nautobot 2.4.0__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

nautobot/core/tables.py

@@ -4,6 +4,7 @@ import logging
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.core.exceptions import FieldDoesNotExist, FieldError
+from django.db import NotSupportedError
 from django.db.models import Prefetch
 from django.db.models.fields.related import ForeignKey, RelatedField
 from django.db.models.fields.reverse_related import ManyToOneRel
@@ -13,15 +14,13 @@ from django.utils.http import urlencode
 from django.utils.safestring import mark_safe
 from django.utils.text import Truncator
 import django_tables2
-from django_tables2.data import TableData, TableQuerysetData
-from django_tables2.rows import BoundRows
+from django_tables2.data import TableQuerysetData
 from django_tables2.utils import Accessor, OrderBy, OrderByTuple
 from tree_queries.models import TreeNode
 
 from nautobot.core.models.querysets import count_related
 from nautobot.core.templatetags import helpers
 from nautobot.core.utils.lookup import get_model_for_view_name, get_related_field_for_models, get_route_for_model
-from nautobot.core.utils.querysets import maybe_prefetch_related, maybe_select_related
 from nautobot.extras import choices, models
 
 logger = logging.getLogger(__name__)
@@ -47,27 +46,8 @@ class BaseTable(django_tables2.Table):
         user=None,
         hide_hierarchy_ui=False,
         order_by=None,
-        data_transform_callback=None,
         **kwargs,
     ):
-        """
-        Instantiate a BaseTable.
-
-        Args:
-            *args (list, optional): Passed through to django_tables2.Table
-            table_changes_pending (bool): TODO
-            saved_view (SavedView, optional): TODO
-            user (User, optional): TODO
-            hide_hierarchy_ui (bool): Whether to display or hide hierarchy indentation of nested objects.
-            order_by (list, optional): Field(s) to sort by
-            data_transform_callback (function, optional): A function that takes the given `data` as an input and
-                returns new data. Runs after all of the queryset auto-optimization performed by this class.
-                Used for example in IPAM views to inject "fake" records for "available" Prefixes, IPAddresses, or VLANs.
-            **kwargs (dict, optional): Passed through to django_tables2.Table
-        Warning:
-            Do not modify/set the `base_columns` attribute after BaseTable class is instantiated.
-            Do not modify/set the `base_columns` attribute after calling super().__init__() of BaseTable class.
-        """
         # Add custom field columns
         model = self._meta.model
 
@@ -109,14 +89,6 @@ class BaseTable(django_tables2.Table):
         # Init table
         super().__init__(*args, order_by=order_by, **kwargs)
 
-        if not isinstance(self.data, TableQuerysetData):
-            # LinkedCountColumns don't work properly if the data is a list of dicts instead of a queryset,
-            # as they rely on a `queryset.annotate()` call to gather the data.
-            self.exclude = [
-                *self.exclude,
-                *[column.name for column in self.columns if isinstance(column.column, LinkedCountColumn)],
-            ]
-
         # Don't show hierarchy if we're sorted
         if order_by is not None and hide_hierarchy_ui is None:
             hide_hierarchy_ui = True
@@ -150,7 +122,7 @@ class BaseTable(django_tables2.Table):
                 columns = user.get_config(f"tables.{self.__class__.__name__}.columns")
         if columns:
             for name, column in self.base_columns.items():
-                if name in columns and name not in self.exclude:
+                if name in columns:
                     self.columns.show(name)
                 else:
                     self.columns.hide(name)
@@ -189,8 +161,7 @@ class BaseTable(django_tables2.Table):
                         logger.error("Couldn't find model for %s", column.column.viewname)
                         continue
                     reverse_lookup = column.column.reverse_lookup or next(iter(column.column.url_params.keys()))
-                    distinct = column.column.distinct
-                    count_fields.append((column.name, column_model, reverse_lookup, distinct))
+                    count_fields.append((column.name, column_model, reverse_lookup))
                     try:
                         lookup = column.column.lookup or get_related_field_for_models(model, column_model).name
                         # For some reason get_related_field_for_models(Tag, DynamicGroup) gives a M2M with the name
@@ -202,8 +173,7 @@ class BaseTable(django_tables2.Table):
                     if lookup is not None:
                         # Also attempt to prefetch the first matching record for display - see LinkedCountColumn
                         prefetch_fields.append(
-                            # Use order_by() because we don't care about ordering here and it's potentially expensive
-                            Prefetch(lookup, column_model.objects.order_by()[:1], to_attr=f"{lookup}_list")
+                            Prefetch(lookup, column_model.objects.all()[:1], to_attr=f"{lookup}_list")
                         )
                     continue
 
@@ -239,46 +209,75 @@ class BaseTable(django_tables2.Table):
                     prefetch_fields.append("__".join(prefetch_path))
 
             if select_fields:
-                queryset = maybe_select_related(queryset, select_fields)
+                # Django doesn't allow .select_related() on a QuerySet that had .values()/.values_list() applied, or
+                # one that has had union()/intersection()/difference() applied.
+                # We can detect and avoid these cases the same way that Django itself does.
+                if queryset._fields is not None:
+                    logger.debug(
+                        "NOT applying select_related(%s) to %s QuerySet as it includes .values()/.values_list()",
+                        select_fields,
+                        model.__name__,
+                    )
+                elif queryset.query.combinator:
+                    logger.debug(
+                        "NOT applying select_related(%s) to %s QuerySet as it is a combinator query",
+                        select_fields,
+                        model.__name__,
+                    )
+                else:
+                    logger.debug("Applying .select_related(%s) to %s QuerySet", select_fields, model.__name__)
+                    # Belt and suspenders - we should have avoided any error cases above, but be safe anyway:
+                    try:
+                        queryset = queryset.select_related(*select_fields)
+                    except (TypeError, ValueError, NotSupportedError) as exc:
+                        logger.warning(
+                            "Unexpected error when trying to .select_related() on %s QuerySet: %s",
+                            model.__name__,
+                            exc,
+                        )
 
             if prefetch_fields:
-                queryset = maybe_prefetch_related(queryset, prefetch_fields)
+                if queryset.query.combinator:
+                    logger.debug(
+                        "NOT applying prefetch_related(%s) to %s QuerySet as it is a combinator query",
+                        prefetch_fields,
+                        model.__name__,
+                    )
+                else:
+                    logger.debug("Applying .prefetch_related(%s) to %s QuerySet", prefetch_fields, model.__name__)
+                    # Belt and suspenders - we should have avoided any error cases above, but be safe anyway:
+                    try:
+                        queryset = queryset.prefetch_related(*prefetch_fields)
+                    except (AttributeError, TypeError, ValueError, NotSupportedError) as exc:
+                        logger.warning(
+                            "Unexpected error when trying to .prefetch_related() on %s QuerySet: %s",
+                            model.__name__,
+                            exc,
+                        )
 
             if count_fields:
-                for column_name, column_model, lookup_name, distinct in count_fields:
+                for column_name, column_model, lookup_name in count_fields:
                     if hasattr(queryset.first(), column_name):
                         continue
                     try:
                         logger.debug(
-                            "Applying .annotate(%s=count_related(%s, %r, distinct=%s) to %s QuerySet",
+                            "Applying .annotate(%s=count_related(%s, %r) to %s QuerySet",
                             column_name,
                             column_model.__name__,
                             lookup_name,
-                            distinct,
                             model.__name__,
                         )
-                        queryset = queryset.annotate(
-                            **{column_name: count_related(column_model, lookup_name, distinct=distinct)}
-                        )
+                        queryset = queryset.annotate(**{column_name: count_related(column_model, lookup_name)})
                     except FieldError:
                         # No error message logged here as the above is *very much* best-effort
                         pass
 
             self.data.data = queryset
 
-        # TODO: it would be better if we could apply this transformation and the above queryset optimizations
-        #       **before** calling super().__init__(), but the current implementation works for now, though inelegant.
-        if data_transform_callback is not None:
-            self.data = TableData.from_data(data_transform_callback(self.data.data))
-            self.data.set_table(self)
-            self.rows = BoundRows(data=self.data, table=self, pinned_data=self.pinned_data)
-
     @property
     def configurable_columns(self):
         selected_columns = [
-            (name, column.verbose_name)
-            for name, column in self.columns.items()
-            if name in self.sequence and name not in ["pk", "actions"]
+            (name, self.columns[name].verbose_name) for name in self.sequence if name not in ["pk", "actions"]
         ]
         available_columns = [
             (name, column.verbose_name)
@@ -289,7 +288,7 @@ class BaseTable(django_tables2.Table):
 
     @property
     def visible_columns(self):
-        return [name for name, column in self.columns.items() if column.visible and name not in self.exclude]
+        return [name for name in self.sequence if self.columns[name].visible]
 
     @property
     def order_by(self):
@@ -444,7 +443,7 @@ class ChoiceFieldColumn(django_tables2.Column):
     choices. The CSS class is derived by calling .get_FOO_class() on the row record.
     """
 
-    def render(self, *, record, bound_column, value):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, record, bound_column, value):  # pylint: disable=arguments-differ
         if value:
             name = bound_column.name
             css_class = getattr(record, f"get_{name}_class")()
@@ -491,7 +490,6 @@ class LinkedCountColumn(django_tables2.Column):
             TODO: this currently does *not* support nested lookups via `__`. That may be solvable in the future.
         reverse_lookup (str, optional): The reverse lookup parameter to use to derive the count.
             If not specified, the first key in `url_params` will be implicitly used as the `reverse_lookup` value.
-        distinct (bool, optional): Parameter passed through to `count_related()`.
         **kwargs (dict, optional): As the parent Column class.
 
     Examples:
@@ -516,37 +514,25 @@ class LinkedCountColumn(django_tables2.Column):
                 # We'd like to do the below but this module isn't currently smart enough to build the right Prefetch()
                 # for a nested lookup:
                 # lookup="circuit_terminations__circuit",
-                # For the count,
-                # .annotate(circuit_count=count_related(Circuit, "circuit_terminations__cloud_network", distinct=True))
+                # For the count, .annotate(circuit_count=count_related(Circuit, "circuit_terminations__cloud_network"))
                 reverse_lookup="circuit_terminations__cloud_network",
-                distinct=True,
                 verbose_name="Circuits",
             )
         ```
     """
 
     def __init__(
-        self,
-        viewname,
-        *args,
-        view_kwargs=None,
-        url_params=None,
-        lookup=None,
-        reverse_lookup=None,
-        distinct=False,
-        default=None,
-        **kwargs,
+        self, viewname, *args, view_kwargs=None, url_params=None, lookup=None, reverse_lookup=None, default=0, **kwargs
     ):
         self.viewname = viewname
         self.lookup = lookup
         self.view_kwargs = view_kwargs or {}
         self.url_params = url_params
         self.reverse_lookup = reverse_lookup or next(iter(url_params.keys()))
-        self.distinct = distinct
         self.model = get_model_for_view_name(self.viewname)
         super().__init__(*args, default=default, **kwargs)
 
-    def render(self, *, bound_column, record, value):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, bound_column, record, value):  # pylint: disable=arguments-differ
         related_record = None
         try:
             lookup = self.lookup or get_related_field_for_models(bound_column._table._meta.model, self.model).name
@@ -630,7 +616,7 @@ class ComputedFieldColumn(django_tables2.Column):
 
         super().__init__(*args, **kwargs)
 
-    def render(self, *, record):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, record):
         return self.computedfield.render({"obj": record})
 
 
@@ -649,7 +635,7 @@ class CustomFieldColumn(django_tables2.Column):
 
         super().__init__(*args, **kwargs)
 
-    def render(self, *, record, bound_column, value):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, record, bound_column, value):  # pylint: disable=arguments-differ
         if self.customfield.type == choices.CustomFieldTypeChoices.TYPE_BOOLEAN:
             template = helpers.render_boolean(value)
         elif self.customfield.type == choices.CustomFieldTypeChoices.TYPE_MULTISELECT:
@@ -680,7 +666,7 @@ class RelationshipColumn(django_tables2.Column):
         kwargs.setdefault("accessor", Accessor("associations"))
         super().__init__(orderable=False, *args, **kwargs)
 
-    def render(self, *, record, value):  # pylint: disable=arguments-differ  # tables2 varies its kwargs
+    def render(self, record, value):  # pylint: disable=arguments-differ
         # Filter the relationship associations by the relationship instance.
         # Since associations accessor returns all the relationship associations regardless of the relationship.
         value = [v for v in value if v.relationship == self.relationship]

nautobot/core/templates/inc/media.html

@@ -47,6 +47,3 @@
     <meta name="theme-color" content="#ffffff">
     <meta charset="UTF-8">
     <meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=no, width=device-width">
-    {% if settings.PUBLISH_ROBOTS_TXT %}
-    <meta name="robots" content="noindex, nofollow">
-    {% endif %}

nautobot/core/templates/inc/nav_menu.html

@@ -93,7 +93,6 @@
                             <span class="mdi mdi-chevron-down"></span>
                         </a>
                         <ul class="collapse nav-dropdown-menu" id="adminDropdown">
-                            <li><a href="{% url 'about' %}"><i class="mdi mdi-information"></i> About</a></li>
                             <li><a href="{% url 'user:profile' %}"><i class="mdi mdi-account-box"></i> Profile</a></li>
                             {% if request.user.is_staff %}
                                 <li><a href="{% url 'worker_status' %}"><i class="mdi mdi-server-network"></i> Worker Status</a></li>

nautobot/core/templates/nautobot_config.py.j2

@@ -463,16 +463,6 @@ INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRIC
 #
 # NAPALM_ARGS = {}
 
-# Expiration date (YYYY-MM-DD) for an active Nautobot support contract with Network to Code.
-# Displayed in the About page.
-# if (
-#     "NAUTOBOT_NTC_SUPPORT_CONTRACT_EXPIRATION_DATE" in os.environ
-#     and os.environ["NAUTOBOT_NTC_SUPPORT_CONTRACT_EXPIRATION_DATE"] != ""
-# ):
-#     NTC_SUPPORT_CONTRACT_EXPIRATION_DATE = datetime.date.fromisoformat(
-#         os.environ["NAUTOBOT_NTC_SUPPORT_CONTRACT_EXPIRATION_DATE"]
-#     )
-
 # Default number of objects to display per page of the UI and REST API. Default is 50
 #
 # if "NAUTOBOT_PAGINATE_COUNT" in os.environ and os.environ["NAUTOBOT_PAGINATE_COUNT"] != "":
@@ -503,9 +493,6 @@ INSTALLATION_METRICS_ENABLED = is_truthy(os.getenv("NAUTOBOT_INSTALLATION_METRIC
 # if "NAUTOBOT_PREFER_IPV4" in os.environ and os.environ["NAUTOBOT_PREFER_IPV4"] != "":
 #     PREFER_IPV4 = is_truthy(os.environ["NAUTOBOT_PREFER_IPV4"])
 
-# Publish a simple "no-index" robots.txt for Nautobot?
-# PUBLISH_ROBOTS_TXT = is_truthy(os.getenv("NAUTOBOT_PUBLISH_ROBOTS_TXT", "True"))
-
 # Default height and width in pixels of a single rack unit in rendered rack elevations. Defaults are 22 and 230
 #
 # if (

nautobot/core/templates/search.html

@@ -65,10 +65,3 @@
         </div>
     {% endif %}
 {% endblock %}
-
-{% block javascript %}
-    {{ block.super }}
-    <script>
-        var clipboard = new ClipboardJS('.btn');
-    </script>
-{% endblock %}

nautobot/core/templates/utilities/render_jinja2.html

@@ -10,7 +10,7 @@
     }
     #render_jinja_template_form textarea {
         resize: vertical;
-        white-space: pre;
+        white-space: nowrap;
     }
 
 </style>

nautobot/core/templates/utilities/templatetags/tag.html

@@ -1,3 +1,3 @@
 {% load helpers %}
 
-{% if url_name %}<a href="{% url url_name %}?tags={{ tag.name }}">{% endif %}<span class="label" style="color: {{ tag.color|fgcolor }}; background-color: #{{ tag.color }}">{{ tag }}</span>{% if url_name %}</a>{% endif %}
+{% if url_name %}<a href="{% url url_name %}?tags={{ tag.name }}">{% endif %}<span class="label label-default" style="color: {{ tag.color|fgcolor }}; background-color: #{{ tag.color }}">{{ tag }}</span>{% if url_name %}</a>{% endif %}

nautobot/core/templates/utilities/theme_preview.html

@@ -330,7 +330,6 @@
                     <small>title for most object views</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -341,7 +340,6 @@
                     <small>used for special purposes such as Location detail "badges"</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -352,7 +350,6 @@
                     <small>title for object create/edit forms</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -363,7 +360,6 @@
                     <small>used in modal titles and a few others</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -374,7 +370,6 @@
                     <small>used in user profiles and cable traces</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -385,7 +380,6 @@
                     <small>Unused in core</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -396,7 +390,6 @@
                     <small>Small text</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
-                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>

nautobot/core/templatetags/helpers.py

@@ -890,13 +890,7 @@ def saved_view_modal(
         "clear_view",
     ]
 
-    view_class = lookup.get_view_for_model(model, "List")
-    table_name = None
-    if hasattr(view_class, "table"):
-        table_name = view_class.table.__name__
-    if hasattr(view_class, "table_class"):
-        table_name = view_class.table_class.__name__
-
+    table_name = lookup.get_table_for_model(model).__name__
     for param in non_filter_params:
         if param == "saved_view":
             current_saved_view_pk = filters_applied.pop(param, None)
@@ -1050,13 +1044,12 @@ def versioned_static(file_path):
 
 
 @register.simple_tag
-def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui, base_depth=0):
+def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui):
     """Generates a visual representation of a tree record hierarchy using dots.
 
     Args:
         tree_depth (range): A range representing the depth of the tree nodes.
         hide_hierarchy_ui (bool): Indicates whether to hide the hierarchy UI.
-        base_depth (int, optional): Starting depth (number of dots to skip rendering).
 
     Returns:
         str: A string containing dots (representing hierarchy levels) if `hide_hierarchy_ui` is False,
@@ -1064,8 +1057,6 @@ def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui, base_depth=0
     """
     if hide_hierarchy_ui or tree_depth == 0:
         return ""
-    if isinstance(base_depth, int):  # may be an empty string
-        tree_depth = tree_depth[base_depth:]
     ui_representation = " ".join(['<i class="mdi mdi-circle-small"></i>' for _ in tree_depth])
     return mark_safe(ui_representation)  # noqa: S308 # suspicious-mark-safe-usage, OK here since its just the `i` tag
 

nautobot/core/testing/__init__.py

@@ -21,23 +21,23 @@ from nautobot.extras.models import Job, JobResult
 __all__ = (
     "APITestCase",
     "APIViewTestCases",
-    "FilterTestCases",
-    "JobClassInfo",
-    "ModelTestCase",
-    "ModelViewTestCase",
-    "NautobotTestCaseMixin",
-    "NautobotTestClient",
-    "TestCase",
-    "ViewTestCases",
     "create_job_result_and_run_job",
     "create_test_user",
     "disable_warnings",
     "extract_form_failures",
     "extract_page_body",
+    "FilterTestCases",
     "get_deletable_objects",
     "get_job_class_and_model",
+    "JobClassInfo",
+    "ModelTestCase",
+    "ModelViewTestCase",
+    "NautobotTestCaseMixin",
+    "NautobotTestClient",
     "post_data",
     "run_job_for_testing",
+    "TestCase",
+    "ViewTestCases",
 )
 
 # Use the proper swappable User model