nautobot 2.4.9__py3-none-any.whl → 2.4.11__py3-none-any.whl

nautobot/extras/views.py

@@ -2,6 +2,7 @@ import logging
 from typing import Optional
 from urllib.parse import parse_qs
 
+from django.conf import settings
 from django.contrib import messages
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
@@ -15,7 +16,7 @@ from django.urls import reverse
 from django.urls.exceptions import NoReverseMatch
 from django.utils import timezone
 from django.utils.encoding import iri_to_uri
-from django.utils.html import format_html
+from django.utils.html import format_html, format_html_join
 from django.utils.http import url_has_allowed_host_and_scheme
 from django.utils.timezone import get_current_timezone
 from django.views.generic import View
@@ -86,7 +87,6 @@ from .choices import (
     JobExecutionType,
     JobQueueTypeChoices,
     JobResultStatusChoices,
-    LogLevelChoices,
 )
 from .datasources import (
     enqueue_git_repository_diff_origin_and_local,
@@ -111,7 +111,6 @@ from .models import (
     Job as JobModel,
     JobButton,
     JobHook,
-    JobLogEntry,
     JobQueue,
     JobResult,
     MetadataType,
@@ -180,55 +179,89 @@ class ComputedFieldUIViewSet(NautobotUIViewSet):
 # have an associated owner, such as a Git repository
 
 
-class ConfigContextListView(generic.ObjectListView):
+class ConfigContextUIViewSet(NautobotUIViewSet):
+    bulk_update_form_class = forms.ConfigContextBulkEditForm
+    filterset_class = filters.ConfigContextFilterSet
+    filterset_form_class = forms.ConfigContextFilterForm
+    form_class = forms.ConfigContextForm
     queryset = ConfigContext.objects.all()
-    filterset = filters.ConfigContextFilterSet
-    filterset_form = forms.ConfigContextFilterForm
-    table = tables.ConfigContextTable
-    action_buttons = ("add",)
+    serializer_class = serializers.ConfigContextSerializer
+    table_class = tables.ConfigContextTable
 
+    class AssignmentObjectFieldsPanel(object_detail.ObjectFieldsPanel):
+        def render_value(self, key, value, context):
+            if key == "dynamic_groups" and not settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED:
+                return None
+            if not value:
+                return helpers.HTML_NONE
 
-class ConfigContextView(generic.ObjectView):
-    queryset = ConfigContext.objects.all()
+            items = []
+            for val in value.all():
+                rendered_val = helpers.hyperlinked_object(val)
+                items.append(rendered_val)
+
+            if not items:
+                return helpers.HTML_NONE
+
+            return format_html("<ul>{}</ul>", format_html_join("", "<li>{}</li>", ((item,) for item in items)))
+
+    object_detail_content = object_detail.ObjectDetailContent(
+        panels=(
+            object_detail.ObjectFieldsPanel(
+                weight=100,
+                section=SectionChoices.LEFT_HALF,
+                fields="__all__",
+                exclude_fields=[
+                    "data",
+                    "owner_content_type",
+                    "owner_object_id",
+                ],
+                hide_if_unset=[
+                    "owner",
+                ],
+            ),
+            object_detail.Panel(
+                weight=100,
+                section=SectionChoices.FULL_WIDTH,
+                label="Data",
+                header_extra_content_template_path="extras/inc/json_format.html",
+                body_content_template_path="extras/inc/configcontext_data.html",
+            ),
+            AssignmentObjectFieldsPanel(
+                weight=200,
+                section=SectionChoices.RIGHT_HALF,
+                label="Assignment",
+                fields=[
+                    "locations",
+                    "roles",
+                    "device_types",
+                    "platforms",
+                    "cluster_groups",
+                    "clusters",
+                    "tenant_groups",
+                    "tenants",
+                    "device_redundancy_groups",
+                    "dynamic_groups",
+                ],
+            ),
+        )
+    )
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)
         # Determine user's preferred output format
-        if request.GET.get("format") in ["json", "yaml"]:
-            context["format"] = request.GET.get("format")
+        if request.GET.get("data_format") in ["json", "yaml"]:
+            context["data_format"] = request.GET.get("data_format")
             if request.user.is_authenticated:
-                request.user.set_config("extras.configcontext.format", context["format"], commit=True)
+                request.user.set_config("extras.configcontext.format", context["data_format"], commit=True)
         elif request.user.is_authenticated:
-            context["format"] = request.user.get_config("extras.configcontext.format", "json")
+            context["data_format"] = request.user.get_config("extras.configcontext.format", "json")
         else:
-            context["format"] = "json"
+            context["data_format"] = "json"
 
         return context
 
 
-class ConfigContextEditView(generic.ObjectEditView):
-    queryset = ConfigContext.objects.all()
-    model_form = forms.ConfigContextForm
-    template_name = "extras/configcontext_edit.html"
-
-
-class ConfigContextBulkEditView(generic.BulkEditView):
-    queryset = ConfigContext.objects.all()
-    filterset = filters.ConfigContextFilterSet
-    table = tables.ConfigContextTable
-    form = forms.ConfigContextBulkEditForm
-
-
-class ConfigContextDeleteView(generic.ObjectDeleteView):
-    queryset = ConfigContext.objects.all()
-
-
-class ConfigContextBulkDeleteView(generic.BulkDeleteView):
-    queryset = ConfigContext.objects.all()
-    table = tables.ConfigContextTable
-    filterset = filters.ConfigContextFilterSet
-
-
 class ObjectConfigContextView(generic.ObjectView):
     base_template = None
     template_name = "extras/object_configcontext.html"
@@ -263,28 +296,26 @@ class ObjectConfigContextView(generic.ObjectView):
 # have an associated owner, such as a Git repository
 
 
-class ConfigContextSchemaListView(generic.ObjectListView):
-    queryset = ConfigContextSchema.objects.all()
-    filterset = filters.ConfigContextSchemaFilterSet
-    filterset_form = forms.ConfigContextSchemaFilterForm
-    table = tables.ConfigContextSchemaTable
-    action_buttons = ("add",)
-
-
-class ConfigContextSchemaView(generic.ObjectView):
+class ConfigContextSchemaUIViewSet(NautobotUIViewSet):
+    bulk_update_form_class = forms.ConfigContextSchemaBulkEditForm
+    filterset_class = filters.ConfigContextSchemaFilterSet
+    filterset_form_class = forms.ConfigContextSchemaFilterForm
+    form_class = forms.ConfigContextSchemaForm
     queryset = ConfigContextSchema.objects.all()
+    serializer_class = serializers.ConfigContextSchemaSerializer
+    table_class = tables.ConfigContextSchemaTable
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)
         # Determine user's preferred output format
-        if request.GET.get("format") in ["json", "yaml"]:
-            context["format"] = request.GET.get("format")
+        if request.GET.get("data_format") in ["json", "yaml"]:
+            context["data_format"] = request.GET.get("data_format")
             if request.user.is_authenticated:
-                request.user.set_config("extras.configcontextschema.format", context["format"], commit=True)
+                request.user.set_config("extras.configcontextschema.format", context["data_format"], commit=True)
         elif request.user.is_authenticated:
-            context["format"] = request.user.get_config("extras.configcontextschema.format", "json")
+            context["data_format"] = request.user.get_config("extras.configcontextschema.format", "json")
         else:
-            context["format"] = "json"
+            context["data_format"] = "json"
 
         return context
 
@@ -372,29 +403,6 @@ class ConfigContextSchemaObjectValidationView(generic.ObjectView):
         }
 
 
-class ConfigContextSchemaEditView(generic.ObjectEditView):
-    queryset = ConfigContextSchema.objects.all()
-    model_form = forms.ConfigContextSchemaForm
-    template_name = "extras/configcontextschema_edit.html"
-
-
-class ConfigContextSchemaBulkEditView(generic.BulkEditView):
-    queryset = ConfigContextSchema.objects.all()
-    filterset = filters.ConfigContextSchemaFilterSet
-    table = tables.ConfigContextSchemaTable
-    form = forms.ConfigContextSchemaBulkEditForm
-
-
-class ConfigContextSchemaDeleteView(generic.ObjectDeleteView):
-    queryset = ConfigContextSchema.objects.all()
-
-
-class ConfigContextSchemaBulkDeleteView(generic.BulkDeleteView):
-    queryset = ConfigContextSchema.objects.all()
-    table = tables.ConfigContextSchemaTable
-    filterset = filters.ConfigContextSchemaFilterSet
-
-
 #
 # Contacts
 #
@@ -1553,6 +1561,11 @@ class JobEditView(generic.ObjectEditView):
     model_form = forms.JobEditForm
     template_name = "extras/job_edit.html"
 
+    def alter_obj(self, obj, request, url_args, url_kwargs):
+        # Reload the job class to ensure we have the latest version
+        get_job(obj.class_path, reload=True)
+        return obj
+
 
 class JobBulkEditView(generic.BulkEditView):
     queryset = JobModel.objects.all()
@@ -2077,44 +2090,12 @@ class JobHookUIViewSet(NautobotUIViewSet):
 #
 
 
-def get_annotated_jobresult_queryset():
-    return (
-        JobResult.objects.defer("result")
-        .select_related("job_model", "user")
-        .annotate(
-            debug_log_count=count_related(
-                JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_DEBUG}
-            ),
-            success_log_count=count_related(
-                JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_SUCCESS}
-            ),
-            info_log_count=count_related(
-                JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_INFO}
-            ),
-            warning_log_count=count_related(
-                JobLogEntry, "job_result", filter_dict={"log_level": LogLevelChoices.LOG_WARNING}
-            ),
-            error_log_count=count_related(
-                JobLogEntry,
-                "job_result",
-                filter_dict={
-                    "log_level__in": [
-                        LogLevelChoices.LOG_FAILURE,
-                        LogLevelChoices.LOG_ERROR,
-                        LogLevelChoices.LOG_CRITICAL,
-                    ],
-                },
-            ),
-        )
-    )
-
-
 class JobResultListView(generic.ObjectListView):
     """
     List JobResults
     """
 
-    queryset = get_annotated_jobresult_queryset()
+    queryset = JobResult.objects.defer("result").select_related("job_model", "user")
     filterset = filters.JobResultFilterSet
     filterset_form = forms.JobResultFilterForm
     table = tables.JobResultTable
@@ -2126,7 +2107,7 @@ class JobResultDeleteView(generic.ObjectDeleteView):
 
 
 class JobResultBulkDeleteView(generic.BulkDeleteView):
-    queryset = get_annotated_jobresult_queryset()
+    queryset = JobResult.objects.defer("result").select_related("job_model", "user")
     table = tables.JobResultTable
     filterset = filters.JobResultFilterSet
 
@@ -2519,24 +2500,15 @@ class RelationshipUIViewSet(NautobotUIViewSet):
     )
 
 
-class RelationshipAssociationListView(generic.ObjectListView):
+class RelationshipAssociationUIViewSet(ObjectListViewMixin, ObjectDestroyViewMixin, ObjectBulkDestroyViewMixin):
+    filterset_class = filters.RelationshipAssociationFilterSet
+    filterset_form_class = forms.RelationshipAssociationFilterForm
+    serializer_class = serializers.RelationshipAssociationSerializer
+    table_class = tables.RelationshipAssociationTable
     queryset = RelationshipAssociation.objects.all()
-    filterset = filters.RelationshipAssociationFilterSet
-    filterset_form = forms.RelationshipAssociationFilterForm
-    table = tables.RelationshipAssociationTable
     action_buttons = ()
 
 
-class RelationshipAssociationBulkDeleteView(generic.BulkDeleteView):
-    queryset = RelationshipAssociation.objects.all()
-    table = tables.RelationshipAssociationTable
-    filterset = filters.RelationshipAssociationFilterSet
-
-
-class RelationshipAssociationDeleteView(generic.ObjectDeleteView):
-    queryset = RelationshipAssociation.objects.all()
-
-
 #
 # Roles
 #
@@ -3005,17 +2977,28 @@ class StatusUIViewSet(NautobotUIViewSet):
 #
 
 
-class TagListView(generic.ObjectListView):
-    queryset = Tag.objects.annotate(items=count_related(TaggedItem, "tag"))
-    filterset = filters.TagFilterSet
-    filterset_form = forms.TagFilterForm
-    table = tables.TagTable
+class TagUIViewSet(NautobotUIViewSet):
+    bulk_update_form_class = forms.TagBulkEditForm
+    filterset_class = filters.TagFilterSet
+    filterset_form_class = forms.TagFilterForm
+    form_class = forms.TagForm
+    queryset = Tag.objects.all()
+    serializer_class = serializers.TagSerializer
+    table_class = tables.TagTable
+
+    def alter_queryset(self, request):
+        queryset = super().alter_queryset(request)
 
+        # Only annotate for list, bulk_edit, bulk_delete views
+        if self.action in ["list", "bulk_update", "bulk_destroy"]:
+            queryset = queryset.annotate(items=count_related(TaggedItem, "tag"))
 
-class TagView(generic.ObjectView):
-    queryset = Tag.objects.all()
+        return queryset
 
     def get_extra_context(self, request, instance):
+        # Only run this logic when retrieving a single object
+        if instance is None or self.action != "retrieve":
+            return super().get_extra_context(request, instance)
         tagged_items = (
             TaggedItem.objects.filter(tag=instance).select_related("content_type").prefetch_related("content_object")
         )
@@ -3036,34 +3019,6 @@ class TagView(generic.ObjectView):
         }
 
 
-class TagEditView(generic.ObjectEditView):
-    queryset = Tag.objects.all()
-    model_form = forms.TagForm
-    template_name = "extras/tag_edit.html"
-
-
-class TagDeleteView(generic.ObjectDeleteView):
-    queryset = Tag.objects.all()
-
-
-class TagBulkImportView(generic.BulkImportView):  # 3.0 TODO: remove, unused
-    queryset = Tag.objects.all()
-    table = tables.TagTable
-
-
-class TagBulkEditView(generic.BulkEditView):
-    queryset = Tag.objects.annotate(items=count_related(TaggedItem, "tag"))
-    table = tables.TagTable
-    form = forms.TagBulkEditForm
-    filterset = filters.TagFilterSet
-
-
-class TagBulkDeleteView(generic.BulkDeleteView):
-    queryset = Tag.objects.annotate(items=count_related(TaggedItem, "tag"))
-    table = tables.TagTable
-    filterset = filters.TagFilterSet
-
-
 #
 # Teams
 #

nautobot/ipam/models.py

@@ -200,6 +200,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_device.alters_data = True
+
     def remove_device(self, device):
         """
         Remove a `device` from this VRF.
@@ -213,6 +215,8 @@ class VRF(PrimaryModel):
         instance = self.devices.through.objects.get(vrf=self, device=device)
         return instance.delete()
 
+    remove_device.alters_data = True
+
     def add_virtual_machine(self, virtual_machine, rd="", name=""):
         """
         Add a `virtual_machine` to this VRF, optionally overloading `rd` and `name`.
@@ -231,6 +235,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_virtual_machine.alters_data = True
+
     def remove_virtual_machine(self, virtual_machine):
         """
         Remove a `virtual_machine` from this VRF.
@@ -244,6 +250,8 @@ class VRF(PrimaryModel):
         instance = self.virtual_machines.through.objects.get(vrf=self, virtual_machine=virtual_machine)
         return instance.delete()
 
+    remove_virtual_machine.alters_data = True
+
     def add_virtual_device_context(self, virtual_device_context, rd="", name=""):
         """
         Add a `virtual_device_context` to this VRF, optionally overloading `rd` and `name`.
@@ -264,6 +272,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_virtual_device_context.alters_data = True
+
     def remove_virtual_device_context(self, virtual_device_context):
         """
         Remove a `virtual_device_context` from this VRF.
@@ -279,6 +289,8 @@ class VRF(PrimaryModel):
         )
         return instance.delete()
 
+    remove_virtual_device_context.alters_data = True
+
     def add_prefix(self, prefix):
         """
         Add a `prefix` to this VRF. Each object must be in the same Namespace.
@@ -293,6 +305,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_prefix.alters_data = True
+
     def remove_prefix(self, prefix):
         """
         Remove a `prefix` from this VRF.
@@ -306,6 +320,8 @@ class VRF(PrimaryModel):
         instance = self.prefixes.through.objects.get(vrf=self, prefix=prefix)
         return instance.delete()
 
+    remove_prefix.alters_data = True
+
 
 @extras_features("graphql")
 class VRFDeviceAssignment(BaseModel):
@@ -374,6 +390,8 @@ class VRFDeviceAssignment(BaseModel):
                 "A VRFDeviceAssignment entry must be associated with a device, a virtual machine, or a virtual device context."
             )
 
+    clean.alters_data = True
+
 
 @extras_features("graphql")
 class VRFPrefixAssignment(BaseModel):
@@ -640,6 +658,8 @@ class Prefix(PrimaryModel):
             self.prefix_length = prefix.prefixlen
             self.ip_version = prefix.version
 
+    _deconstruct_prefix.alters_data = True
+
     def delete(self, *args, **kwargs):
         """
         A Prefix with children will be impossible to delete and raise a `ProtectedError`.
@@ -705,6 +725,8 @@ class Prefix(PrimaryModel):
             return parent
         return None
 
+    get_parent.alters_data = True
+
     def clean(self):
         if self.prefix is not None:  # missing network/prefix_length will be caught by super().clean()
             # Clear host bits from prefix
@@ -716,6 +738,8 @@ class Prefix(PrimaryModel):
 
         super().clean()
 
+    clean.alters_data = True
+
     def save(self, *args, **kwargs):
         self.clean()
 
@@ -821,6 +845,8 @@ class Prefix(PrimaryModel):
 
         return query.update(parent=self)
 
+    reparent_subnets.alters_data = True
+
     def reparent_ips(self):
         """Determine the list of child IPAddresses and set the parent to self."""
         query = IPAddress.objects.select_for_update().filter(
@@ -832,6 +858,8 @@ class Prefix(PrimaryModel):
 
         return query.update(parent=self)
 
+    reparent_ips.alters_data = True
+
     def supernets(self, direct=False, include_self=False, for_update=False):
         """
         Return supernets of this Prefix.
@@ -861,7 +889,7 @@ class Prefix(PrimaryModel):
             prefix_length__lte=self.prefix_length,
             network__lte=self.network,
             broadcast__gte=self.broadcast,
-            namespace=self.namespace,
+            namespace_id=self.namespace_id,
         )
 
         return supernets
@@ -893,7 +921,7 @@ class Prefix(PrimaryModel):
             ip_version=self.ip_version,
             network__gte=self.network,
             broadcast__lte=self.broadcast,
-            namespace=self.namespace,
+            namespace_id=self.namespace_id,
         )
 
     def is_child_node(self):
@@ -1065,6 +1093,17 @@ class Prefix(PrimaryModel):
         For prefixes containing IP addresses and/or pools, pools are considered fully utilized while
         only IP addresses that are not contained within pools are added to the utilization.
 
+        It is recommended that when using this method you add the following prefetch to the queryset when dealing with
+        multiple prefixes to ensure good performance:
+
+        ```
+        prefetch_related(
+            Prefetch(
+                "children", queryset=Prefix.objects.only("network", "prefix_length", "parent_id").order_by()
+            )
+        )
+        ```
+
         Returns:
             UtilizationData (namedtuple): (numerator, denominator)
         """
@@ -1077,7 +1116,7 @@ class Prefix(PrimaryModel):
         # change this when that is the case, see #3873 for historical context.
         if self.type != choices.PrefixTypeChoices.TYPE_CONTAINER:
             pool_ips = IPAddress.objects.filter(
-                parent__namespace=self.namespace,
+                parent__namespace_id=self.namespace_id,
                 ip_version=self.ip_version,
                 host__gte=self.network,
                 host__lte=self.broadcast,
@@ -1085,7 +1124,11 @@ class Prefix(PrimaryModel):
             child_ips = netaddr.IPSet(pool_ips)
 
         if self.type != choices.PrefixTypeChoices.TYPE_POOL:
-            child_prefixes = netaddr.IPSet(p.prefix for p in self.children.only("network", "prefix_length").iterator())
+            # Using self.children.all over self.children.iterator (with chunk_size given or not) consistently shaves
+            # off around 200 extra SQL queries and shows better performance.
+            # Also note that this is meant to be used in conjunction with a Prefetch on an only query. This query is
+            # performed in nautobot.ipam.tables.PrefixDetailTable.
+            child_prefixes = netaddr.IPSet(p.prefix for p in self.children.all())
 
         numerator_set = child_ips | child_prefixes
 
@@ -1228,6 +1271,8 @@ class IPAddress(PrimaryModel):
             self.mask_length = address.prefixlen
             self.ip_version = address.version
 
+    _deconstruct_address.alters_data = True
+
     natural_key_field_names = ["parent__namespace", "host"]
 
     def _get_closest_parent(self):
@@ -1289,6 +1334,8 @@ class IPAddress(PrimaryModel):
 
         super().clean()
 
+    clean.alters_data = True
+
     def save(self, *args, **kwargs):
         self.clean()  # MUST do data fixup as above
 

nautobot/ipam/tables.py

@@ -1,5 +1,8 @@
+from django.db.models import Prefetch, QuerySet
 from django.utils.safestring import mark_safe
 import django_tables2 as tables
+from django_tables2.data import TableData
+from django_tables2.rows import BoundRows
 from django_tables2.utils import Accessor
 
 from nautobot.core.tables import (
@@ -47,7 +50,9 @@ UTILIZATION_GRAPH = """
 # object: the base ancestor Prefix, in the case of PrefixDetailTable, else None
 PREFIX_COPY_LINK = """
 {% load helpers %}
+{% if not table.hide_hierarchy_ui %}
 {% tree_hierarchy_ui_representation record.ancestors.count|as_range table.hide_hierarchy_ui base_tree_depth|default:0 %}
+{% endif %}
 <span class="hover_copy">
   <a href="\
 {% if record.present_in_database %}\
@@ -418,6 +423,20 @@ class PrefixDetailTable(PrefixTable):
     tenant = TenantColumn()
     tags = TagColumn(url_name="ipam:prefix_list")
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # Conditionally prefetch children for the utilization calculation if that column is visible.
+        if self.columns["utilization"].visible and isinstance(self.data.data, QuerySet):
+            self.data = TableData.from_data(
+                self.data.data.prefetch_related(
+                    Prefetch(
+                        "children", queryset=Prefix.objects.only("network", "prefix_length", "parent_id").order_by()
+                    )
+                )
+            )
+            self.data.set_table(self)
+            self.rows = BoundRows(data=self.data, table=self, pinned_data=self.pinned_data)
+
     class Meta(PrefixTable.Meta):
         fields = (
             "pk",