nautobot 2.2.9__py3-none-any.whl → 2.3.0__py3-none-any.whl

nautobot/extras/filters/__init__.py

@@ -23,6 +23,7 @@ from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
     JobResultStatusChoices,
+    MetadataTypeDataTypeChoices,
     RelationshipTypeChoices,
     SecretsGroupAccessTypeChoices,
     SecretsGroupSecretTypeChoices,
@@ -72,21 +73,32 @@ from nautobot.extras.models import (
     JobHook,
     JobLogEntry,
     JobResult,
+    MetadataChoice,
+    MetadataType,
     Note,
     ObjectChange,
+    ObjectMetadata,
     Relationship,
     RelationshipAssociation,
     Role,
+    SavedView,
     ScheduledJob,
     Secret,
     SecretsGroup,
     SecretsGroupAssociation,
+    StaticGroupAssociation,
     Status,
     Tag,
     Team,
+    UserSavedViewAssociation,
     Webhook,
 )
-from nautobot.extras.utils import ChangeLoggedModelsQuery, FeatureQuery, RoleModelsQuery, TaggableClassesQuery
+from nautobot.extras.utils import (
+    ChangeLoggedModelsQuery,
+    FeatureQuery,
+    RoleModelsQuery,
+    TaggableClassesQuery,
+)
 from nautobot.tenancy.models import Tenant, TenantGroup
 from nautobot.virtualization.models import Cluster, ClusterGroup
 
@@ -123,6 +135,8 @@ __all__ = (
     "JobResultFilterSet",
     "LocalContextFilterSet",
     "LocalContextModelFilterSetMixin",
+    "MetadataTypeFilterSet",
+    "MetadataChoiceFilterSet",
     "NautobotFilterSet",
     "NoteFilterSet",
     "ObjectChangeFilterSet",
@@ -348,6 +362,7 @@ class ContentTypeFilterSet(BaseFilterSet):
     has_serializer = django_filters.BooleanFilter(
         method="_has_serializer", label="A REST API serializer exists for this type"
     )
+    feature = django_filters.CharFilter(method="_feature", label="Objects of this type support the named feature")
 
     class Meta:
         model = ContentType
@@ -392,6 +407,9 @@ class ContentTypeFilterSet(BaseFilterSet):
         else:
             return queryset.exclude(pk__in=ct_pks)
 
+    def _feature(self, queryset, name, value):
+        return queryset.filter(FeatureQuery(value).get_query())
+
 
 # TODO: remove in 2.2
 @class_deprecated_in_favor_of(CustomFieldModelFilterSetMixin)
@@ -565,8 +583,11 @@ class CustomLinkFilterSet(BaseFilterSet):
 # Dynamic Groups
 #
 
+# Must be imported **after* NautobotFilterSet class is defined to avoid a circular import loop.
+from nautobot.tenancy.filters.mixins import TenancyModelFilterSetMixin  # noqa: E402
+
 
-class DynamicGroupFilterSet(NautobotFilterSet):
+class DynamicGroupFilterSet(TenancyModelFilterSetMixin, NautobotFilterSet):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
@@ -576,10 +597,14 @@ class DynamicGroupFilterSet(NautobotFilterSet):
         },
     )
     content_type = ContentTypeMultipleChoiceFilter(choices=FeatureQuery("dynamic_groups").get_choices, conjoined=False)
+    member_id = MultiValueUUIDFilter(
+        field_name="static_group_associations__associated_object_id",
+        label="Group member ID",
+    )
 
     class Meta:
         model = DynamicGroup
-        fields = ("id", "name", "description")
+        fields = ("id", "name", "description", "group_type", "tags")
 
 
 class DynamicGroupMembershipFilterSet(NautobotFilterSet):
@@ -606,6 +631,67 @@ class DynamicGroupMembershipFilterSet(NautobotFilterSet):
         fields = ("id", "group", "parent_group", "operator", "weight")
 
 
+class SavedViewFilterSet(BaseFilterSet):
+    q = SearchFilter(filter_predicates={"name": "icontains", "owner__username": "icontains"})
+    owner = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="username",
+        queryset=get_user_model().objects.all(),
+        label="Owner (ID or name)",
+    )
+
+    class Meta:
+        model = SavedView
+        fields = [
+            "id",
+            "owner",
+            "name",
+            "view",
+            "is_global_default",
+            "is_shared",
+        ]
+
+
+class UserSavedViewAssociationFilterSet(NautobotFilterSet):
+    saved_view = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=SavedView.objects.all(),
+        to_field_name="name",
+        label="Saved View (ID or name)",
+    )
+    user = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="username",
+        queryset=get_user_model().objects.all(),
+        label="User (ID or username)",
+    )
+
+    class Meta:
+        model = UserSavedViewAssociation
+        fields = ["id", "saved_view", "user", "view_name"]
+
+
+class StaticGroupAssociationFilterSet(NautobotFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "dynamic_group__name": "icontains",
+            "dynamic_group__description": "icontains",
+            "associated_object_type__app_label": "icontains",
+            "associated_object_type__model": "icontains",
+        }
+    )
+
+    dynamic_group = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=DynamicGroup.objects.all(),
+        to_field_name="name",
+        label="Dynamic group (name or ID)",
+    )
+    associated_object_type = ContentTypeMultipleChoiceFilter(
+        choices=FeatureQuery("dynamic_groups").get_choices, conjoined=False
+    )
+
+    class Meta:
+        model = StaticGroupAssociation
+        fields = "__all__"
+
+
 #
 # Export Templates
 #
@@ -923,6 +1009,91 @@ class LocalContextFilterSet(LocalContextModelFilterSetMixin):
     pass
 
 
+#
+# Metadata
+#
+
+
+class MetadataTypeFilterSet(NautobotFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "name": "icontains",
+            "description": "icontains",
+        },
+    )
+    content_types = ContentTypeMultipleChoiceFilter(
+        choices=FeatureQuery("metadata").get_choices,
+    )
+
+    class Meta:
+        model = MetadataType
+        fields = "__all__"
+
+
+class MetadataChoiceFilterSet(BaseFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "value": "icontains",
+        },
+    )
+
+    metadata_type = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=MetadataType.objects.filter(
+            data_type__in=[MetadataTypeDataTypeChoices.TYPE_SELECT, MetadataTypeDataTypeChoices.TYPE_MULTISELECT]
+        ),
+        label="Metadata type (name or ID)",
+    )
+
+    class Meta:
+        model = MetadataChoice
+        fields = "__all__"
+
+
+class ObjectMetadataFilterSet(NautobotFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "_value": "icontains",
+            "metadata_type__name": "icontains",
+            "contact__name": "icontains",
+            "team__name": "icontains",
+        },
+    )
+    contact = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=Contact.objects.all(),
+        to_field_name="name",
+        label="Contact (name or ID)",
+    )
+    team = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=Team.objects.all(),
+        to_field_name="name",
+        label="Team (name or ID)",
+    )
+    metadata_type = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=MetadataType.objects.all(),
+        label="Metadata type (name or ID)",
+    )
+    assigned_object_type = ContentTypeMultipleChoiceFilter(
+        choices=FeatureQuery("metadata").get_choices,
+    )
+    value = django_filters.Filter(field_name="_value", method="filter_value")
+
+    class Meta:
+        model = ObjectMetadata
+        fields = "__all__"
+
+    def filter_value(self, queryset, name, value):
+        value = value.strip()
+        query = Q(_value__icontains=value)
+        if not value:
+            return queryset
+        return queryset.filter(query)
+
+
+#
+# Notes
+#
+
+
 class NoteFilterSet(BaseFilterSet):
     q = SearchFilter(
         filter_predicates={

nautobot/extras/filters/mixins.py

@@ -1,6 +1,7 @@
 from django.contrib.contenttypes.models import ContentType
-from django.db.models import Q
+from django.db.models import Model, Q
 import django_filters
+from django_filters.constants import EMPTY_VALUES
 from django_filters.utils import verbose_lookup_expr
 
 from nautobot.core.constants import (
@@ -33,7 +34,6 @@ from nautobot.extras.models import (
     ConfigContextSchema,
     CustomField,
     Relationship,
-    RelationshipAssociation,
     Role,
     Status,
 )
@@ -177,49 +177,32 @@ class RelationshipFilter(django_filters.ModelMultipleChoiceFilter):
         self.side = side
         super().__init__(queryset=queryset, *args, **kwargs)
 
-    def filter(self, qs, value):
-        value = [entry.id for entry in value]
-        # Check if value is empty or a DynamicChoiceField that is empty.
-        if not value or "" in value:
-            # if value is empty we return the entire unmodified queryset
-            return qs
-        else:
-            if self.side == "source":
-                values = RelationshipAssociation.objects.filter(
-                    destination_id__in=value,
-                    source_type=self.relationship.source_type,
-                    relationship=self.relationship,
-                ).values_list("source_id", flat=True)
-            elif self.side == "destination":
-                values = RelationshipAssociation.objects.filter(
-                    source_id__in=value,
-                    destination_type=self.relationship.destination_type,
-                    relationship=self.relationship,
-                ).values_list("destination_id", flat=True)
-            else:
-                destinations = RelationshipAssociation.objects.filter(
-                    source_id__in=value,
-                    destination_type=self.relationship.destination_type,
-                    relationship=self.relationship,
-                ).values_list("destination_id", flat=True)
+    def generate_query(self, value, **kwargs):
+        query = Q()
 
-                sources = RelationshipAssociation.objects.filter(
-                    destination_id__in=value,
-                    source_type=self.relationship.source_type,
-                    relationship=self.relationship,
-                ).values_list("source_id", flat=True)
+        value = [v.pk if isinstance(v, Model) else v for v in value]
 
-                values = list(destinations) + list(sources)
+        if self.side in (RelationshipSideChoices.SIDE_SOURCE, RelationshipSideChoices.SIDE_PEER):
+            query |= Q(
+                source_for_associations__relationship=self.relationship.id,
+                source_for_associations__destination_id__in=value,
+            )
+        if self.side in (RelationshipSideChoices.SIDE_DESTINATION, RelationshipSideChoices.SIDE_PEER):
+            query |= Q(
+                destination_for_associations__relationship=self.relationship.id,
+                destination_for_associations__source_id__in=value,
+            )
+        return query
 
-            # ModelMultipleChoiceFilters always have `distinct=True` so we must make sure that the
-            # unioned queryset is also distinct. We also need to conditionally check if the incoming
-            # `qs` is distinct in the case that a caller is manually passing in a queryset that may
-            # not be distinct. (Ref: https://github.com/nautobot/nautobot/issues/2963)
-            union_qs = self.get_method(self.qs)(Q(id__in=values))
-            if qs.query.distinct:
-                union_qs = union_qs.distinct()
+    def filter(self, qs, value):
+        if not value or any(v in EMPTY_VALUES for v in value):
+            return qs
 
-            return qs & union_qs
+        query = self.generate_query(value)
+        result = self.get_method(qs)(query)
+        if self.distinct:
+            result = result.distinct()
+        return result
 
 
 class RelationshipModelFilterSetMixin(django_filters.FilterSet):
@@ -303,7 +286,17 @@ class RoleModelFilterSetMixin(django_filters.FilterSet):
     Mixin to add a `role` filter field to a FilterSet.
     """
 
-    role = RoleFilter()
+    @classmethod
+    def get_filters(cls):
+        filters = super().get_filters()
+
+        if cls._meta.model is not None:
+            filters["role"] = RoleFilter(
+                field_name="role",
+                query_params={"content_types": [cls._meta.model._meta.label_lower]},
+            )
+
+        return filters
 
 
 class StatusFilter(NaturalKeyOrPKMultipleChoiceFilter):
@@ -322,4 +315,14 @@ class StatusModelFilterSetMixin(django_filters.FilterSet):
     Mixin to add a `status` filter field to a FilterSet.
     """
 
-    status = StatusFilter()
+    @classmethod
+    def get_filters(cls):
+        filters = super().get_filters()
+
+        if cls._meta.model is not None:
+            filters["status"] = StatusFilter(
+                field_name="status",
+                query_params={"content_types": [cls._meta.model._meta.label_lower]},
+            )
+
+        return filters

nautobot/extras/forms/base.py

@@ -1,9 +1,11 @@
 from nautobot.core.forms import BootstrapMixin
 
 from .mixins import (
+    ContactTeamModelFilterFormMixin,
     CustomFieldModelBulkEditFormMixin,
     CustomFieldModelFilterFormMixin,
     CustomFieldModelFormMixin,
+    DynamicGroupModelFormMixin,
     NoteModelBulkEditFormMixin,
     NoteModelFormMixin,
     RelationshipModelBulkEditFormMixin,
@@ -23,7 +25,14 @@ __all__ = (
 #
 
 
-class NautobotModelForm(BootstrapMixin, CustomFieldModelFormMixin, RelationshipModelFormMixin, NoteModelFormMixin):
+class NautobotModelForm(
+    BootstrapMixin,
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    CustomFieldModelFormMixin,
+    DynamicGroupModelFormMixin,
+    NoteModelFormMixin,
+    RelationshipModelFormMixin,
+):
     """
     This class exists to combine common functionality and is used to inherit from throughout the
     codebase where all of BootstrapMixin, CustomFieldModelFormMixin, RelationshipModelFormMixin, and
@@ -31,15 +40,25 @@ class NautobotModelForm(BootstrapMixin, CustomFieldModelFormMixin, RelationshipM
     """
 
 
-class NautobotFilterForm(BootstrapMixin, CustomFieldModelFilterFormMixin, RelationshipModelFilterFormMixin):
+class NautobotFilterForm(
+    BootstrapMixin,
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    ContactTeamModelFilterFormMixin,
+    CustomFieldModelFilterFormMixin,
+    RelationshipModelFilterFormMixin,
+):
     """
     This class exists to combine common functionality and is used to inherit from throughout the
-    codebase where all three of BootstrapMixin, CustomFieldModelFilterFormMixin and RelationshipModelFilterFormMixin are
-    needed.
+    codebase where all of ContactTeamModelFilterFormMixin, CustomFieldModelFilterFormMixin, and
+    RelationshipModelFilterFormMixin are needed.
     """
 
 
 class NautobotBulkEditForm(
-    BootstrapMixin, CustomFieldModelBulkEditFormMixin, RelationshipModelBulkEditFormMixin, NoteModelBulkEditFormMixin
+    BootstrapMixin,
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    CustomFieldModelBulkEditFormMixin,
+    NoteModelBulkEditFormMixin,
+    RelationshipModelBulkEditFormMixin,
 ):
     """Base class for bulk-edit forms for models that support relationships, custom fields and notes."""