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

nautobot/circuits/views.py

@@ -2,9 +2,18 @@ from django.contrib import messages
 from django.db import transaction
 from django.db.models import Q
 from django.shortcuts import get_object_or_404, redirect, render
+from django.utils.html import format_html
 from django_tables2 import RequestConfig
 
 from nautobot.core.forms import ConfirmationForm
+from nautobot.core.templatetags.helpers import bettertitle, humanize_speed, placeholder
+from nautobot.core.ui.choices import SectionChoices
+from nautobot.core.ui.object_detail import (
+    ObjectDetailContent,
+    ObjectFieldsPanel,
+    ObjectsTablePanel,
+)
+from nautobot.core.ui.utils import render_component_template
 from nautobot.core.views import generic, mixins as view_mixins
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.viewsets import NautobotUIViewSet
@@ -79,11 +88,11 @@ class CircuitTerminationUIViewSet(
             obj.circuit = get_object_or_404(Circuit, pk=self.kwargs["circuit"])
         return obj
 
-    def get_return_url(self, request, obj=None):
+    def get_return_url(self, request, obj=None, default_return_url=None):
         if obj is not None and obj.present_in_database and obj.pk:
-            return super().get_return_url(request, obj=obj.circuit)
+            return super().get_return_url(request, obj=obj.circuit, default_return_url=default_return_url)
 
-        return super().get_return_url(request, obj=obj)
+        return super().get_return_url(request, obj=obj, default_return_url=default_return_url)
 
 
 class ProviderUIViewSet(NautobotUIViewSet):
@@ -94,27 +103,22 @@ class ProviderUIViewSet(NautobotUIViewSet):
     queryset = Provider.objects.all()
     serializer_class = serializers.ProviderSerializer
     table_class = tables.ProviderTable
-
-    def get_extra_context(self, request, instance):
-        context = super().get_extra_context(request, instance)
-        if self.action == "retrieve":
-            circuits = (
-                Circuit.objects.restrict(request.user, "view")
-                .filter(provider=instance)
-                .select_related("circuit_type", "tenant")
-                .prefetch_related("circuit_terminations__location")
-            )
-            circuits_table = tables.CircuitTable(circuits)
-            circuits_table.columns.hide("provider")
-
-            paginate = {
-                "paginator_class": EnhancedPaginator,
-                "per_page": get_paginate_count(request),
-            }
-            RequestConfig(request, paginate).configure(circuits_table)
-
-            context["circuits_table"] = circuits_table
-        return context
+    object_detail_content = ObjectDetailContent(
+        panels=(
+            ObjectFieldsPanel(
+                section=SectionChoices.LEFT_HALF,
+                weight=100,
+                fields="__all__",
+            ),
+            ObjectsTablePanel(
+                weight=200,
+                table_class=tables.CircuitTable,
+                table_filter="provider",
+                section=SectionChoices.FULL_WIDTH,
+                exclude_columns=["provider"],
+            ),
+        ),
+    )
 
 
 class CircuitUIViewSet(NautobotUIViewSet):
@@ -127,8 +131,121 @@ class CircuitUIViewSet(NautobotUIViewSet):
     queryset = Circuit.objects.all()
     serializer_class = serializers.CircuitSerializer
     table_class = tables.CircuitTable
-    # NOTE: This is how `NautobotUIViewSet` would define use_new_ui attr
-    # use_new_ui = ["list", "retrieve"]
+
+    class CircuitTerminationPanel(ObjectFieldsPanel):
+        def __init__(self, **kwargs):
+            super().__init__(
+                fields=(
+                    "location",  # TODO: render location hierarchy
+                    "cable",
+                    "provider_network",
+                    "cloud_network",
+                    "port_speed",
+                    "upstream_speed",
+                    "ip_addresses",
+                    "xconnect_id",
+                    "pp_info",
+                    "description",
+                ),
+                value_transforms={
+                    "port_speed": [humanize_speed, placeholder],
+                    "upstream_speed": [humanize_speed],
+                },
+                hide_if_unset=("location", "provider_network", "cloud_network", "upstream_speed"),
+                ignore_nonexistent_fields=True,  # ip_addresses may be undefined
+                header_extra_content_template_path="circuits/inc/circuit_termination_header_extra_content.html",
+                **kwargs,
+            )
+
+        def should_render(self, context):
+            return True
+
+        def get_extra_context(self, context):
+            return {"termination": context[self.context_object_key]}
+
+        def get_data(self, context):
+            """
+            Extend the panel data to include custom relationships on the termination.
+
+            This is done for feature parity with the existing UI, and is not a pattern we *generally* should emulate.
+            """
+            data = super().get_data(context)
+            termination = context["termination"]
+            if termination is not None:
+                for side, relationships in termination.get_relationships_with_related_objects(
+                    include_hidden=False
+                ).items():
+                    for relationship, value in relationships.items():
+                        key = (relationship, side)
+                        data[key] = value
+
+            return data
+
+        def render_key(self, key, value, context):
+            """
+            Extend the panel rendering to render custom relationship information.
+
+            This is done for feature parity with the existing UI, and is not a pattern we *generally* should emulate.
+            """
+            if isinstance(key, tuple):
+                # Copied from _ObjectRelationshipsPanel.render_key()
+                relationship, side = key
+                return format_html(
+                    '<span title="{} ({})">{}</span>',
+                    relationship.label,
+                    relationship.key,
+                    bettertitle(relationship.get_label(side)),
+                )
+            return super().render_key(key, value, context)
+
+        def render_value(self, key, value, context):
+            """
+            Add custom rendering of connected cables.
+
+            TODO: this might make sense to move into the base class to handle Cable objects in general?
+            """
+            if key == "cable":
+                if not context["termination"].location:
+                    return ""
+                return render_component_template("circuits/inc/circuit_termination_cable_fragment.html", context)
+            return super().render_value(key, value, context)
+
+        def queryset_list_url_filter(self, key, value, context):
+            """
+            Extend the panel rendering to render custom relationship information.
+
+            This is done for feature parity with the existing UI, and is not a pattern we *generally* should emulate.
+            """
+            if isinstance(key, tuple):
+                # Copied from _ObjectRelationshipsPanel.queryset_list_url_filter()
+                relationship, side = key
+                termination = context["termination"]
+                return f"cr_{relationship.key}__{side}={termination.pk}"
+            return super().queryset_list_url_filter(key, value, context)
+
+    object_detail_content = ObjectDetailContent(
+        panels=(
+            ObjectFieldsPanel(
+                section=SectionChoices.LEFT_HALF,
+                weight=100,
+                fields="__all__",
+                exclude_fields=["comments", "circuit_termination_a", "circuit_termination_z"],
+                value_transforms={"commit_rate": [humanize_speed, placeholder]},
+            ),
+            CircuitTerminationPanel(
+                label="Termination - A Side",
+                section=SectionChoices.RIGHT_HALF,
+                weight=100,
+                context_object_key="circuit_termination_a",
+            ),
+            CircuitTerminationPanel(
+                label="Termination - Z Side",
+                section=SectionChoices.RIGHT_HALF,
+                weight=200,
+                context_object_key="circuit_termination_z",
+            ),
+        ),
+    )
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)

nautobot/cloud/api/views.py

@@ -9,40 +9,36 @@ from . import serializers
 
 
 class CloudAccountViewSet(NautobotModelViewSet):
-    queryset = models.CloudAccount.objects.select_related("provider", "secrets_group")
+    queryset = models.CloudAccount.objects.all()
     serializer_class = serializers.CloudAccountSerializer
     filterset_class = filters.CloudAccountFilterSet
 
 
 class CloudResourceTypeViewSet(NautobotModelViewSet):
-    queryset = models.CloudResourceType.objects.select_related("provider")
+    queryset = models.CloudResourceType.objects.all()
     serializer_class = serializers.CloudResourceTypeSerializer
     filterset_class = filters.CloudResourceTypeFilterSet
 
 
 class CloudNetworkViewSet(NautobotModelViewSet):
-    queryset = models.CloudNetwork.objects.select_related(
-        "cloud_resource_type", "cloud_account", "parent"
-    ).prefetch_related("prefixes")
+    queryset = models.CloudNetwork.objects.all()
     serializer_class = serializers.CloudNetworkSerializer
     filterset_class = filters.CloudNetworkFilterSet
 
 
 class CloudNetworkPrefixAssignmentViewSet(NautobotModelViewSet):
-    queryset = models.CloudNetworkPrefixAssignment.objects.select_related("cloud_network", "prefix")
+    queryset = models.CloudNetworkPrefixAssignment.objects.all()
     serializer_class = serializers.CloudNetworkPrefixAssignmentSerializer
     filterset_class = filters.CloudNetworkPrefixAssignmentFilterSet
 
 
 class CloudServiceViewSet(NautobotModelViewSet):
-    queryset = models.CloudService.objects.select_related("cloud_account", "cloud_resource_type").prefetch_related(
-        "cloud_networks"
-    )
+    queryset = models.CloudService.objects.all()
     serializer_class = serializers.CloudServiceSerializer
     filterset_class = filters.CloudServiceFilterSet
 
 
 class CloudServiceNetworkAssignmentViewSet(NautobotModelViewSet):
-    queryset = models.CloudServiceNetworkAssignment.objects.select_related("cloud_network", "cloud_service")
+    queryset = models.CloudServiceNetworkAssignment.objects.all()
     serializer_class = serializers.CloudServiceNetworkAssignmentSerializer
     filterset_class = filters.CloudServiceNetworkAssignmentFilterSet

nautobot/cloud/factory.py

@@ -86,7 +86,10 @@ class CloudNetworkFactory(PrimaryModelFactory):
             if extracted:
                 self.prefixes.set(extracted)
             else:
-                self.prefixes.set(get_random_instances(Prefix))
+                # TODO Investigate https://github.com/nautobot/nautobot/actions/runs/11019738391/job/30603271529
+                # to uncomment the line below.
+                # self.prefixes.set(get_random_instances(Prefix))
+                self.prefixes.set(get_random_instances(model_or_queryset_or_lambda=Prefix, maximum=1))
 
 
 class CloudServiceFactory(PrimaryModelFactory):

nautobot/cloud/models.py

@@ -109,7 +109,7 @@ class CloudResourceTypeMixin(models.Model):
         super().clean()
 
         # Copied from nautobot.extras.models.models.ConfigContextSchemaValidationMixin
-        schema = self.cloud_resource_type.config_schema
+        schema = self.cloud_resource_type.config_schema  # pylint: disable=no-member
         if schema:
             try:
                 Draft7Validator(schema, format_checker=Draft7Validator.FORMAT_CHECKER).validate(self.extra_config)

nautobot/cloud/tests/test_filters.py

@@ -5,12 +5,13 @@ from nautobot.core.testing import FilterTestCases
 from nautobot.extras.models import SecretsGroup
 
 
-class CloudAccountTestCase(FilterTestCases.NameOnlyFilterTestCase):
+class CloudAccountTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudAccount.objects.all()
     filterset = filters.CloudAccountFilterSet
     generic_filter_tests = [
         ("account_number",),
         ("description",),
+        ("name",),
         ("provider", "provider__id"),
         ("provider", "provider__name"),
         ("secrets_group", "secrets_group__id"),
@@ -31,7 +32,7 @@ class CloudAccountTestCase(FilterTestCases.NameOnlyFilterTestCase):
             cls.cloud_accounts[i].validated_save()
 
 
-class CloudResourceTypeTestCase(FilterTestCases.NameOnlyFilterTestCase):
+class CloudResourceTypeTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudResourceType.objects.all()
     filterset = filters.CloudResourceTypeFilterSet
     generic_filter_tests = [
@@ -50,7 +51,7 @@ class CloudResourceTypeTestCase(FilterTestCases.NameOnlyFilterTestCase):
         )
 
 
-class CloudNetworkTestCase(FilterTestCases.NameOnlyFilterTestCase):
+class CloudNetworkTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudNetwork.objects.all()
     filterset = filters.CloudNetworkFilterSet
     generic_filter_tests = [
@@ -110,7 +111,7 @@ class CloudServiceNetworkAssignmentTestCase(FilterTestCases.FilterTestCase):
     ]
 
 
-class CloudServiceTestCase(FilterTestCases.NameOnlyFilterTestCase):
+class CloudServiceTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudService.objects.all()
     filterset = filters.CloudServiceFilterSet
     generic_filter_tests = [

nautobot/cloud/views.py

@@ -100,16 +100,6 @@ class CloudNetworkUIViewSet(NautobotUIViewSet):
 
         return context
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_prefixes", None):
-            obj.prefixes.add(*form.cleaned_data["add_prefixes"])
-        if form.cleaned_data.get("remove_prefixes", None):
-            obj.prefixes.remove(*form.cleaned_data["remove_prefixes"])
-        if form.cleaned_data.get("add_cloud_services", None):
-            obj.cloud_services.add(*form.cleaned_data["add_cloud_services"])
-        if form.cleaned_data.get("remove_cloud_services", None):
-            obj.cloud_services.remove(*form.cleaned_data["remove_cloud_services"])
-
 
 class CloudResourceTypeUIViewSet(NautobotUIViewSet):
     queryset = CloudResourceType.objects.all()
@@ -173,9 +163,3 @@ class CloudServiceUIViewSet(NautobotUIViewSet):
             )
 
         return context
-
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_cloud_networks", None):
-            obj.cloud_networks.add(*form.cleaned_data["add_cloud_networks"])
-        if form.cleaned_data.get("remove_cloud_networks", None):
-            obj.cloud_networks.remove(*form.cleaned_data["remove_cloud_networks"])

nautobot/core/api/constants.py

@@ -0,0 +1,11 @@
+# Query parameters that are *not* filterset filters
+NON_FILTER_QUERY_PARAMS = (
+    "api_version",  # used to select the Nautobot API version
+    "depth",  # nested levels of the serializers default to depth=0
+    "exclude_m2m",  # used to exclude many-to-many fields from the REST API
+    "format",  # "json" or "api", used in the interactive HTML REST API views
+    "include",  # used to include computed fields, relationships, config-contexts, etc. (excluded by default)
+    "limit",  # pagination
+    "offset",  # pagination
+    "sort",  # sorting of results
+)

nautobot/core/api/fields.py

@@ -53,10 +53,10 @@ class ChoiceField(serializers.Field):
                 data = ""
         return super().validate_empty_values(data)
 
-    def to_representation(self, obj):
-        if obj == "":
+    def to_representation(self, value):
+        if value == "":
             return None
-        return OrderedDict([("value", obj), ("label", self._choices[obj])])
+        return OrderedDict([("value", value), ("label", self._choices[value])])
 
     def to_internal_value(self, data):
         if data == "":
@@ -123,8 +123,8 @@ class ContentTypeField(RelatedField):
             self.fail("invalid")
         return None
 
-    def to_representation(self, obj):
-        return f"{obj.app_label}.{obj.model}"
+    def to_representation(self, value):
+        return f"{value.app_label}.{value.model}"
 
 
 class LaxURLField(URLField):

nautobot/core/api/filter_backends.py

@@ -2,6 +2,8 @@ from django_filters.rest_framework.backends import DjangoFilterBackend
 from rest_framework.filters import OrderingFilter
 from tree_queries.models import TreeNode
 
+from nautobot.core.api.constants import NON_FILTER_QUERY_PARAMS
+
 
 class NautobotFilterBackend(DjangoFilterBackend):
     """Custom filtering backend for use with django-rest-framework and django-filters."""
@@ -17,15 +19,7 @@ class NautobotFilterBackend(DjangoFilterBackend):
         # The default 'data' is a reference to request.GET, which is immutable; copies of this data are mutable
         data = kwargs["data"].copy()
 
-        for non_filter_param in (
-            "api_version",  # used to select the Nautobot API version
-            "depth",  # nested levels of the serializers default to depth=0
-            "format",  # "json" or "api", used in the interactive HTML REST API views
-            "include",  # used to include computed fields, relationships, config-contexts, etc. (excluded by default)
-            "limit",  # pagination
-            "offset",  # pagination
-            "sort",  # sorting of results
-        ):
+        for non_filter_param in NON_FILTER_QUERY_PARAMS:
             data.pop(non_filter_param, None)
 
         kwargs["data"] = data