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

nautobot/core/views/generic.py

@@ -36,11 +36,10 @@ from nautobot.core.forms import (
     CSVFileField,
     ImportForm,
     restrict_form_fields,
-    SearchForm,
     TableConfigForm,
 )
 from nautobot.core.forms.forms import DynamicFilterFormSet
-from nautobot.core.templatetags.helpers import bettertitle, validated_viewname
+from nautobot.core.templatetags.helpers import validated_viewname
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.utils.requests import (
@@ -114,6 +113,7 @@ class ObjectView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
             (dict): Additional context data
         """
         return {
+            "object_detail_content": self.object_detail_content,
             "active_tab": request.GET.get("tab", "main"),
         }
 
@@ -237,30 +237,35 @@ class ObjectListView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
                 self.filterset(),
             )
 
+        # Check if there is a default for this view for this specific user
+        user_default_saved_view = None
+        if not isinstance(user, AnonymousUser):
+            try:
+                user_default_saved_view_pk = UserSavedViewAssociation.objects.get(
+                    user=user, view_name=list_url
+                ).saved_view.pk
+                # Saved view should either belong to the user or be public
+                user_default_saved_view = SavedView.objects.get(
+                    Q(pk=user_default_saved_view_pk),
+                    Q(owner=user) | Q(is_shared=True),
+                )
+            except ObjectDoesNotExist:
+                pass
+
+        # Check if there is a global default for this view
+        global_saved_view = None
+        try:
+            global_saved_view = SavedView.objects.get(view=list_url, is_global_default=True)
+        except ObjectDoesNotExist:
+            pass
+
         # If the user clicks on the clear view button, we do not check for global or user defaults
         if not skip_user_and_global_default_saved_view and not clear_view and not request.GET.get("saved_view"):
-            # Check if there is a default for this view for this specific user
-            if not isinstance(user, AnonymousUser):
-                try:
-                    user_default_saved_view_pk = UserSavedViewAssociation.objects.get(
-                        user=user, view_name=list_url
-                    ).saved_view.pk
-                    # Saved view should either belong to the user or be public
-                    SavedView.objects.get(
-                        Q(pk=user_default_saved_view_pk),
-                        Q(owner=user) | Q(is_shared=True),
-                    )
-                    sv_url = reverse("extras:savedview", kwargs={"pk": user_default_saved_view_pk})
-                    return redirect(sv_url)
-                except ObjectDoesNotExist:
-                    pass
+            if user_default_saved_view:
+                return redirect(reverse("extras:savedview", kwargs={"pk": user_default_saved_view.pk}))
 
-            # Check if there is a global default for this view
-            try:
-                global_saved_view = SavedView.objects.get(view=list_url, is_global_default=True)
+            if global_saved_view:
                 return redirect(reverse("extras:savedview", kwargs={"pk": global_saved_view.pk}))
-            except ObjectDoesNotExist:
-                pass
 
         if self.filterset is not None:
             filter_params = self.get_filter_params(request)
@@ -354,6 +359,7 @@ class ObjectListView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
                 saved_view=current_saved_view,
                 user=request.user,
                 hide_hierarchy_ui=hide_hierarchy_ui,
+                configurable=True,
             )
             if "pk" in table.base_columns and (permissions["change"] or permissions["delete"]):
                 table.columns.show("pk")
@@ -372,10 +378,6 @@ class ObjectListView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
                     f'Requested "per_page" is too large. No more than {max_page_size} items may be displayed at a time.',
                 )
 
-        # For the search form field, use a custom placeholder.
-        q_placeholder = "Search " + bettertitle(model._meta.verbose_name_plural)
-        search_form = SearchForm(data=filter_params, q_placeholder=q_placeholder)
-
         valid_actions = self.validate_action_buttons(request)
 
         # Query SavedViews for dropdown button
@@ -390,11 +392,12 @@ class ObjectListView(UIComponentsMixin, ObjectPermissionRequiredMixin, View):
             "filter_params": display_filter_params,
             "filter_form": filter_form,
             "dynamic_filter_form": dynamic_filter_form,
-            "search_form": search_form,
             "list_url": list_url,
             "new_changes_not_applied": new_changes_not_applied,
             "current_saved_view": current_saved_view,
             "saved_views": saved_views,
+            "user_default_saved_view": user_default_saved_view,
+            "global_saved_view": global_saved_view,
             "model": model,
             "verbose_name_plural": model._meta.verbose_name_plural,
             "view_action": "list",
@@ -490,6 +493,8 @@ class ObjectEditView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequi
                 "obj_type": self.queryset.model._meta.verbose_name,
                 "form": form,
                 "return_url": self.get_return_url(request, obj),
+                "view_action": "update" if obj.present_in_database else "create",
+                "breadcrumbs": self.get_breadcrumbs(),
                 "editing": obj.present_in_database,
                 **self.get_extra_context(request, obj),
             },
@@ -564,6 +569,8 @@ class ObjectEditView(UIComponentsMixin, GetReturnURLMixin, ObjectPermissionRequi
                 "obj": obj,
                 "obj_type": self.queryset.model._meta.verbose_name,
                 "form": form,
+                "view_action": "update" if obj.present_in_database else "create",
+                "breadcrumbs": self.get_breadcrumbs(),
                 "return_url": self.get_return_url(request, obj),
                 "editing": obj.present_in_database,
                 **self.get_extra_context(request, obj),

nautobot/core/views/mixins.py

@@ -73,6 +73,9 @@ PERMISSIONS_ACTION_MAP = {
     "bulk_update": "change",
     "changelog": "view",
     "notes": "view",
+    "data_compliance": "view",
+    "approve": "change",
+    "deny": "change",
 }
 
 
@@ -402,8 +405,9 @@ class NautobotViewSetMixin(GenericViewSet, UIComponentsMixin, AccessMixin, GetRe
         """
         Resolve the named permissions for a given model (or instance) and a list of actions (e.g. view or add).
 
-        :param model: A model or instance
-        :param actions: A list of actions to perform on the model
+        Args:
+            model (Union[type(Model), Model]): A model or instance
+            actions (List[str]): A list of actions to perform on the model
         """
         model_permissions = []
         for action in actions:
@@ -684,7 +688,10 @@ class NautobotViewSetMixin(GenericViewSet, UIComponentsMixin, AccessMixin, GetRe
             default_tab = "main"
             if hasattr(self, "action") and self.action != "retrieve":
                 default_tab = self.action
-            return {"active_tab": request.GET.get("tab", default_tab)}
+            return {
+                "object_detail_content": getattr(self, "object_detail_content", None),
+                "active_tab": request.GET.get("tab", default_tab),
+            }
         return {}
 
     def get_template_name(self):
@@ -915,35 +922,40 @@ class ObjectListViewMixin(NautobotViewSetMixin, mixins.ListModelMixin):
                 self.filterset_class(),
             )
 
+        # Check if there is a default for this view for this specific user
+        user_default_saved_view = None
+        app_label, model_name = queryset.model._meta.label.split(".")
+        view_name = f"{app_label}:{model_name.lower()}_list"
+        user = request.user
+        if not isinstance(user, AnonymousUser):
+            try:
+                user_default_saved_view_pk = UserSavedViewAssociation.objects.get(
+                    user=user, view_name=view_name
+                ).saved_view.pk
+                # Saved view should either belong to the user or be public
+                user_default_saved_view = SavedView.objects.get(
+                    Q(pk=user_default_saved_view_pk),
+                    Q(owner=user) | Q(is_shared=True),
+                )
+            except ObjectDoesNotExist:
+                pass
+
+        # Check if there is a global default for this view
+        global_saved_view = None
+        try:
+            global_saved_view = SavedView.objects.get(view=view_name, is_global_default=True)
+        except ObjectDoesNotExist:
+            pass
+
         # If the user clicks on the clear view button, we do not check for global or user defaults
         if not skip_user_and_global_default_saved_view and not clear_view and not request.GET.get("saved_view"):
-            # Check if there is a default for this view for this specific user
-            app_label, model_name = queryset.model._meta.label.split(".")
-            view_name = f"{app_label}:{model_name.lower()}_list"
-            user = request.user
-            if not isinstance(user, AnonymousUser):
-                try:
-                    user_default_saved_view_pk = UserSavedViewAssociation.objects.get(
-                        user=user, view_name=view_name
-                    ).saved_view.pk
-                    # Saved view should either belong to the user or be public
-                    SavedView.objects.get(
-                        Q(pk=user_default_saved_view_pk),
-                        Q(owner=user) | Q(is_shared=True),
-                    )
-                    sv_url = reverse("extras:savedview", kwargs={"pk": user_default_saved_view_pk})
-                    return redirect(sv_url)
-                except ObjectDoesNotExist:
-                    pass
+            if user_default_saved_view:
+                return redirect(reverse("extras:savedview", kwargs={"pk": user_default_saved_view.pk}))
 
-            # Check if there is a global default for this view
-            try:
-                global_saved_view = SavedView.objects.get(view=view_name, is_global_default=True)
+            if global_saved_view:
                 return redirect(reverse("extras:savedview", kwargs={"pk": global_saved_view.pk}))
-            except ObjectDoesNotExist:
-                pass
 
-        return Response({})
+        return Response({"user_default_saved_view": user_default_saved_view, "global_saved_view": global_saved_view})
 
 
 class ObjectDestroyViewMixin(NautobotViewSetMixin, mixins.DestroyModelMixin):
@@ -1517,3 +1529,13 @@ class ObjectNotesViewMixin(NautobotViewSetMixin):
             "active_tab": "notes",
         }
         return Response(data)
+
+
+class ObjectDataComplianceViewMixin(NautobotViewSetMixin):
+    """
+    UI Mixin for a DataCompliance to show up for a given object.
+    """
+
+    @drf_action(detail=True)
+    def data_compliance(self, request, *args, **kwargs):
+        return Response({})

nautobot/core/views/renderers.py

@@ -12,7 +12,6 @@ from rest_framework import renderers
 from nautobot.core.constants import MAX_PAGE_SIZE_DEFAULT
 from nautobot.core.forms import (
     restrict_form_fields,
-    SearchForm,
     TableConfigForm,
 )
 from nautobot.core.forms.forms import DynamicFilterFormSet
@@ -102,6 +101,7 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
                     saved_view=self.saved_view,
                     user=request.user,
                     hide_hierarchy_ui=view.hide_hierarchy_ui,
+                    configurable=True,
                 )
                 if "pk" in table.base_columns and (permissions["change"] or permissions["delete"]):
                     table.columns.show("pk")
@@ -206,7 +206,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
         content_type = ContentType.objects.get_for_model(model)
         form = None
         table = None
-        search_form = None
         instance = None
         filter_form = None
         display_filter_params = []
@@ -236,8 +235,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
                     if view.filterset_form_class is not None:
                         filter_form = view.filterset_form_class(view.filter_params, label_suffix="")
                 table = self.construct_table(view, request=request, permissions=permissions)
-                q_placeholder = "Search " + bettertitle(model._meta.verbose_name_plural)
-                search_form = SearchForm(data=view.filter_params, q_placeholder=q_placeholder)
             elif view.action == "destroy":
                 form = form_class(initial=request.GET)
             elif view.action in ["create", "update"]:
@@ -283,7 +280,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
             "form": form,
             "filter_form": filter_form,
             "dynamic_filter_form": self.get_dynamic_filter_form(view, request, filterset_class=view.filterset_class),
-            "search_form": search_form,
             "filter_params": display_filter_params,
             "object": instance,
             "obj": instance,  # NOTE: This context key is deprecated in favor of `object`.
@@ -369,6 +365,8 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
         # See form_valid() for self.action == "bulk_create".
         self.template = data.get("template", view.get_template_name())
 
+        data["request"] = request
+
         return super().render(data, accepted_media_type=accepted_media_type, renderer_context=renderer_context)
 
     @staticmethod

nautobot/core/views/utils.py

@@ -45,7 +45,7 @@ def check_filter_for_display(filters, field_name, values):
     Return any additional context data for the template.
 
     Args:
-        filters (OrderedDict): The output of `.get_filters()` of a desired FilterSet
+        filters (dict): The filters of a desired FilterSet
         field_name (str): The name of the filter to get a label for and lookup values
         values (list[str]): List of strings that may be PKs to look up
 
@@ -282,7 +282,7 @@ def prepare_cloned_fields(instance):
     applicable.
     """
     form_class = get_form_for_model(instance)
-    form = form_class() if form_class is not None else None
+    form = form_class(instance=instance) if form_class is not None else None
     params = []
     for field_name in getattr(instance, "clone_fields", []):
         field = instance._meta.get_field(field_name)
@@ -306,12 +306,17 @@ def prepare_cloned_fields(instance):
         if field_value is False:
             field_value = ""
 
-        # This is likely an m2m field
-        if isinstance(field_value, list):
+        # Handle M2M fields or lists
+        if hasattr(field_value, "all") and callable(field_value.all):
+            # This is a manager for a M2M relationship
+            for related_obj in field_value.all():
+                item_value = getattr(related_obj, "pk", str(related_obj))  # pk or str()
+                params.append((field_name, item_value))
+        # This is likely a list from another type of field
+        elif isinstance(field_value, list):
             for fv in field_value:
                 item_value = getattr(fv, "pk", str(fv))  # pk or str()
                 params.append((field_name, item_value))
-
         # Omit empty values
         elif field_value not in (None, ""):
             params.append((field_name, field_value))

nautobot/core/views/viewsets.py

@@ -11,9 +11,10 @@ class NautobotUIViewSet(
     mixins.ObjectBulkUpdateViewMixin,
     mixins.ObjectChangeLogViewMixin,
     mixins.ObjectNotesViewMixin,
+    mixins.ObjectDataComplianceViewMixin,
 ):
     """
     Nautobot BaseViewSet that is intended for UI use only. It provides default Nautobot functionalities such as
     `create()`, `update()`, `partial_update()`, `bulk_update()`, `destroy()`, `bulk_destroy()`, `retrieve()`
-    `notes()`, `changelog()` and `list()` actions.
+    `notes()`, `changelog()`, `list()`, and `data_compliance()` actions.
     """

nautobot/data_validation/api/__init__.py

@@ -0,0 +1 @@
+"""REST API module for data_validation app."""

nautobot/data_validation/api/serializers.py

@@ -0,0 +1,80 @@
+"""API serializers for data_validation."""
+
+from django.contrib.contenttypes.models import ContentType
+
+from nautobot.apps.api import NautobotModelSerializer, TaggedModelSerializerMixin
+from nautobot.core.api import ContentTypeField
+from nautobot.data_validation.models import (
+    DataCompliance,
+    MinMaxValidationRule,
+    RegularExpressionValidationRule,
+    RequiredValidationRule,
+    UniqueValidationRule,
+)
+from nautobot.extras.utils import FeatureQuery
+
+
+class RegularExpressionValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Serializer for `RegularExpressionValidationRule` objects."""
+
+    content_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
+    )
+
+    class Meta:
+        """Serializer metadata for RegularExpressionValidationRule objects."""
+
+        model = RegularExpressionValidationRule
+        fields = "__all__"
+
+
+class MinMaxValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Serializer for `MinMaxValidationRule` objects."""
+
+    content_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
+    )
+
+    class Meta:
+        """Serializer metadata for MinMaxValidationRule objects."""
+
+        model = MinMaxValidationRule
+        fields = "__all__"
+
+
+class RequiredValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Serializer for `RequiredValidationRule` objects."""
+
+    content_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
+    )
+
+    class Meta:
+        """Serializer metadata for RequiredValidationRule objects."""
+
+        model = RequiredValidationRule
+        fields = "__all__"
+
+
+class UniqueValidationRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """Serializer for `UniqueValidationRule` objects."""
+
+    content_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("custom_validators").get_query()),
+    )
+
+    class Meta:
+        """Serializer metadata for UniqueValidationRule objects."""
+
+        model = UniqueValidationRule
+        fields = "__all__"
+
+
+class DataComplianceSerializer(NautobotModelSerializer):
+    """Serializer for DataCompliance."""
+
+    class Meta:
+        """Meta class for serializer."""
+
+        model = DataCompliance
+        fields = "__all__"

nautobot/data_validation/api/urls.py

@@ -0,0 +1,20 @@
+"""Django API urlpatterns declaration for data_validation app."""
+
+from nautobot.apps.api import OrderedDefaultRouter
+from nautobot.data_validation.api import views
+
+router = OrderedDefaultRouter(view_name="Data Validation Engine")
+
+# Data Compliance
+router.register("data-compliance", views.DataComplianceAPIView)
+# Min/max rules
+router.register("min-max-rules", views.MinMaxValidationRuleViewSet)
+# Regular expression rules
+router.register("regex-rules", views.RegularExpressionValidationRuleViewSet)
+# Required rules
+router.register("required-rules", views.RequiredValidationRuleViewSet)
+# Unique rules
+router.register("unique-rules", views.UniqueValidationRuleViewSet)
+
+app_name = "data_validation-api"
+urlpatterns = router.urls

nautobot/data_validation/api/views.py

@@ -0,0 +1,44 @@
+"""API views for data_validation."""
+
+from nautobot.apps.api import NautobotModelViewSet
+from nautobot.data_validation import filters, models
+from nautobot.data_validation.api import serializers
+
+
+class RegularExpressionValidationRuleViewSet(NautobotModelViewSet):
+    """View to manage regular expression validation rules."""
+
+    queryset = models.RegularExpressionValidationRule.objects.all()
+    serializer_class = serializers.RegularExpressionValidationRuleSerializer
+    filterset_class = filters.RegularExpressionValidationRuleFilterSet
+
+
+class MinMaxValidationRuleViewSet(NautobotModelViewSet):
+    """View to manage min max expression validation rules."""
+
+    queryset = models.MinMaxValidationRule.objects.all()
+    serializer_class = serializers.MinMaxValidationRuleSerializer
+    filterset_class = filters.MinMaxValidationRuleFilterSet
+
+
+class RequiredValidationRuleViewSet(NautobotModelViewSet):
+    """View to manage required field validation rules."""
+
+    queryset = models.RequiredValidationRule.objects.all()
+    serializer_class = serializers.RequiredValidationRuleSerializer
+    filterset_class = filters.RequiredValidationRuleFilterSet
+
+
+class UniqueValidationRuleViewSet(NautobotModelViewSet):
+    """View to manage unique value validation rules."""
+
+    queryset = models.UniqueValidationRule.objects.all()
+    serializer_class = serializers.UniqueValidationRuleSerializer
+    filterset_class = filters.UniqueValidationRuleFilterSet
+
+
+class DataComplianceAPIView(NautobotModelViewSet):
+    """API Views for DataCompliance."""
+
+    queryset = models.DataCompliance.objects.all()
+    serializer_class = serializers.DataComplianceSerializer

nautobot/data_validation/apps.py

@@ -0,0 +1,18 @@
+from nautobot.core.apps import NautobotConfig
+from nautobot.extras.plugins import register_custom_validators
+
+
+class DataValidationEngineConfig(NautobotConfig):
+    default = True
+    name = "nautobot.data_validation"
+    verbose_name = "Data Validation Engine"
+    searchable_models = []
+    base_url = "data-validation"  # used in generate_performance_test_endpoints
+
+    def ready(self):
+        super().ready()
+        from nautobot.data_validation.custom_validators import custom_validators
+
+        register_custom_validators(custom_validators)
+
+        import nautobot.data_validation.signals  # noqa: F401  # unused-import -- but this import installs the signals