nautobot 2.0.0a2__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/extras/filters/__init__.py

@@ -162,7 +162,7 @@ class ComputedFieldFilterSet(BaseFilterSet):
         model = ComputedField
         fields = (
             "content_type",
-            "slug",
+            "key",
             "template",
             "fallback_value",
             "weight",
@@ -217,7 +217,8 @@ class ConfigContextFilterSet(BaseFilterSet):
     platform = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="platforms",
         queryset=Platform.objects.all(),
-        label="Platform (ID or slug)",
+        to_field_name="name",
+        label="Platform (ID or name)",
     )
     cluster_group_id = django_filters.ModelMultipleChoiceFilter(
         field_name="cluster_groups",
@@ -227,7 +228,8 @@ class ConfigContextFilterSet(BaseFilterSet):
     cluster_group = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="cluster_groups",
         queryset=ClusterGroup.objects.all(),
-        label="Cluster group (ID or slug)",
+        to_field_name="name",
+        label="Cluster group (ID or name)",
     )
     cluster_id = django_filters.ModelMultipleChoiceFilter(
         field_name="clusters",
@@ -242,7 +244,8 @@ class ConfigContextFilterSet(BaseFilterSet):
     tenant_group = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="tenant_groups",
         queryset=TenantGroup.objects.all(),
-        label="Tenant group (ID or slug)",
+        label="Tenant group (ID or name)",
+        to_field_name="name",
     )
     tenant_id = django_filters.ModelMultipleChoiceFilter(
         field_name="tenants",
@@ -252,13 +255,14 @@ class ConfigContextFilterSet(BaseFilterSet):
     tenant = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="tenants",
         queryset=Tenant.objects.all(),
-        label="Tenant (ID or slug)",
+        label="Tenant (ID or name)",
+        to_field_name="name",
     )
     device_redundancy_group = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="device_redundancy_groups",
         queryset=DeviceRedundancyGroup.objects.all(),
-        to_field_name="slug",
-        label="Device Redundancy Group (slug or PK)",
+        to_field_name="name",
+        label="Device Redundancy Group (name or PK)",
     )
     tag = django_filters.ModelMultipleChoiceFilter(
         field_name="tags__slug",
@@ -275,7 +279,8 @@ class ConfigContextFilterSet(BaseFilterSet):
         if settings.CONFIG_CONTEXT_DYNAMIC_GROUPS_ENABLED:
             self.filters["dynamic_groups"] = NaturalKeyOrPKMultipleChoiceFilter(
                 queryset=DynamicGroup.objects.all(),
-                label="Dynamic Groups (slug or ID)",
+                label="Dynamic Groups (name or ID)",
+                to_field_name="name",
             )
 
     class Meta:
@@ -418,7 +423,6 @@ class DynamicGroupFilterSet(NautobotFilterSet):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
             "description": "icontains",
             "content_type__app_label": "icontains",
             "content_type__model": "icontains",
@@ -428,7 +432,7 @@ class DynamicGroupFilterSet(NautobotFilterSet):
 
     class Meta:
         model = DynamicGroup
-        fields = ("id", "name", "slug", "description")
+        fields = ("id", "name", "description")
 
 
 class DynamicGroupMembershipFilterSet(NautobotFilterSet):
@@ -436,18 +440,18 @@ class DynamicGroupMembershipFilterSet(NautobotFilterSet):
         filter_predicates={
             "operator": "icontains",
             "group__name": "icontains",
-            "group__slug": "icontains",
             "parent_group__name": "icontains",
-            "parent_group__slug": "icontains",
         },
     )
     group = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=DynamicGroup.objects.all(),
-        label="Group (slug or ID)",
+        label="Group (name or ID)",
+        to_field_name="name",
     )
     parent_group = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=DynamicGroup.objects.all(),
-        label="Parent Group (slug or ID)",
+        label="Parent Group (name or ID)",
+        to_field_name="name",
     )
 
     class Meta:
@@ -498,7 +502,8 @@ class GitRepositoryFilterSet(NautobotFilterSet):
     )
     secrets_group = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=SecretsGroup.objects.all(),
-        label="Secrets group (ID or slug)",
+        label="Secrets group (ID or name)",
+        to_field_name="name",
     )
 
     class Meta:
@@ -515,14 +520,15 @@ class GraphQLQueryFilterSet(BaseFilterSet):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
             "query": "icontains",
         },
     )
 
     class Meta:
         model = GraphQLQuery
-        fields = ["name", "slug"]
+        fields = [
+            "name",
+        ]
 
 
 #
@@ -547,7 +553,6 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
             "grouping": "icontains",
             "description": "icontains",
         },
@@ -557,17 +562,15 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
         model = Job
         fields = [
             "id",
-            "source",
             "module_name",
             "job_class_name",
-            "slug",
             "name",
             "grouping",
             "installed",
             "enabled",
             "has_sensitive_variables",
             "approval_required",
-            "commit_default",
+            "dryrun_default",
             "hidden",
             "read_only",
             "is_job_hook_receiver",
@@ -578,9 +581,8 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "name_override",
             "approval_required_override",
             "description_override",
-            "commit_default_override",
+            "dryrun_default_override",
             "hidden_override",
-            "read_only_override",
             "soft_time_limit_override",
             "time_limit_override",
             "has_sensitive_variables_override",
@@ -589,13 +591,14 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
 
 
 class JobHookFilterSet(BaseFilterSet):
-    q = SearchFilter(filter_predicates={"name": "icontains", "slug": "icontains"})
+    q = SearchFilter(filter_predicates={"name": "icontains"})
     content_types = ContentTypeMultipleChoiceFilter(
         choices=ChangeLoggedModelsQuery().get_choices,
     )
     job = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="name",
         queryset=Job.objects.all(),
-        label="Job (slug or ID)",
+        label="Job (name or ID)",
     )
 
     class Meta:
@@ -605,7 +608,6 @@ class JobHookFilterSet(BaseFilterSet):
             "content_types",
             "enabled",
             "job",
-            "slug",
             "type_create",
             "type_update",
             "type_delete",
@@ -621,21 +623,21 @@ class JobResultFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
         },
     )
     job_model = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="name",
         queryset=Job.objects.all(),
-        label="Job (ID or slug)",
+        label="Job (name or ID)",
     )
     job_model_id = django_filters.ModelMultipleChoiceFilter(
         queryset=Job.objects.all(),
         label="Job (ID) - Deprecated (use job_model filter)",
     )
-    obj_type = ContentTypeFilter()
     date_created = django_filters.DateTimeFilter()
     date_done = django_filters.DateTimeFilter()
     status = django_filters.MultipleChoiceFilter(choices=JobResultStatusChoices, null_value=None)
 
     class Meta:
         model = JobResult
-        fields = ["id", "date_created", "date_done", "name", "status", "user", "obj_type"]
+        fields = ["id", "date_created", "date_done", "name", "status", "user"]
 
 
 class JobLogEntryFilterSet(BaseFilterSet):
@@ -661,9 +663,9 @@ class ScheduledJobFilterSet(BaseFilterSet):
         },
     )
     job_model = NaturalKeyOrPKMultipleChoiceFilter(
-        field_name="job_model__slug",
+        to_field_name="name",
         queryset=Job.objects.all(),
-        label="Job (ID or slug)",
+        label="Job (name or ID)",
     )
     job_model_id = django_filters.ModelMultipleChoiceFilter(
         queryset=Job.objects.all(),
@@ -692,7 +694,11 @@ class JobButtonFilterSet(BaseFilterSet):
         },
     )
     content_types = ContentTypeFilter()
-    job = NaturalKeyOrPKMultipleChoiceFilter(queryset=Job.objects.all(), label="Job (slug or ID)")
+    job = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="name",
+        queryset=Job.objects.all(),
+        label="Job (name or ID)",
+    )
 
     class Meta:
         model = JobButton
@@ -787,7 +793,7 @@ class ObjectChangeFilterSet(BaseFilterSet):
 class RelationshipFilterSet(BaseFilterSet):
     q = SearchFilter(
         filter_predicates={
-            "name": "icontains",
+            "label": "icontains",
             "description": "icontains",
         }
     )
@@ -799,15 +805,15 @@ class RelationshipFilterSet(BaseFilterSet):
 
     class Meta:
         model = Relationship
-        fields = ["id", "name", "slug", "type", "source_type", "destination_type"]
+        fields = ["id", "label", "key", "type", "source_type", "destination_type"]
 
 
 class RelationshipAssociationFilterSet(BaseFilterSet):
     relationship = django_filters.ModelMultipleChoiceFilter(
-        field_name="relationship__slug",
+        field_name="relationship__key",
         queryset=Relationship.objects.all(),
-        to_field_name="slug",
-        label="Relationship (slug)",
+        to_field_name="key",
+        label="Relationship (key)",
     )
     source_type = ContentTypeMultipleChoiceFilter(choices=FeatureQuery("relationships").get_choices, conjoined=False)
     destination_type = ContentTypeMultipleChoiceFilter(
@@ -847,7 +853,6 @@ class SecretFilterSet(
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
         },
     )
     # TODO(Glenn): dynamic choices needed. The issue being that secrets providers are Python
@@ -856,7 +861,7 @@ class SecretFilterSet(
 
     class Meta:
         model = Secret
-        fields = ("id", "name", "slug", "provider", "created", "last_updated", "tags")
+        fields = ("id", "name", "provider", "created", "last_updated", "tags")
 
 
 class SecretsGroupFilterSet(
@@ -869,13 +874,12 @@ class SecretsGroupFilterSet(
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
         },
     )
 
     class Meta:
         model = SecretsGroup
-        fields = ("id", "name", "slug", "created", "last_updated")
+        fields = ("id", "name", "created", "last_updated")
 
 
 class SecretsGroupAssociationFilterSet(BaseFilterSet):
@@ -883,7 +887,8 @@ class SecretsGroupAssociationFilterSet(BaseFilterSet):
 
     secrets_group = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=SecretsGroup.objects.all(),
-        label="Secrets Group (ID or slug)",
+        label="Secrets Group (ID or name)",
+        to_field_name="name",
     )
     secret_id = django_filters.ModelMultipleChoiceFilter(
         queryset=Secret.objects.all(),
@@ -891,7 +896,8 @@ class SecretsGroupAssociationFilterSet(BaseFilterSet):
     )
     secret = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Secret.objects.all(),
-        label="Secret (ID or slug)",
+        label="Secret (ID or name)",
+        to_field_name="name",
     )
     access_type = django_filters.MultipleChoiceFilter(choices=SecretsGroupAccessTypeChoices)
     secret_type = django_filters.MultipleChoiceFilter(choices=SecretsGroupSecretTypeChoices)
@@ -912,7 +918,6 @@ class StatusFilterSet(NautobotFilterSet):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
             "content_types__model": "icontains",
         },
     )
@@ -927,7 +932,6 @@ class StatusFilterSet(NautobotFilterSet):
             "content_types",
             "color",
             "name",
-            "slug",
             "created",
             "last_updated",
         ]
@@ -992,7 +996,6 @@ class RoleFilterSet(NautobotFilterSet):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
-            "slug": "icontains",
             "content_types__model": "icontains",
         },
     )
@@ -1013,7 +1016,6 @@ class RoleFilterSet(NautobotFilterSet):
             "content_types",
             "color",
             "name",
-            "slug",
             "weight",
             "created",
             "last_updated",

nautobot/extras/filters/mixins.py

@@ -45,7 +45,8 @@ class ConfigContextRoleFilter(NaturalKeyOrPKMultipleChoiceFilter):
     def __init__(self, *args, **kwargs):
         kwargs.setdefault("field_name", "roles")
         kwargs.setdefault("queryset", Role.objects.get_for_models([Device, VirtualMachine]))
-        kwargs.setdefault("label", "Role (slug or ID)")
+        kwargs.setdefault("label", "Role (name or ID)")
+        kwargs.setdefault("to_field_name", "name")
 
         super().__init__(*args, **kwargs)
 
@@ -253,10 +254,10 @@ class RelationshipModelFilterSetMixin(django_filters.FilterSet):
             peer_side = RelationshipSideChoices.OPPOSITE[side]
 
             # If this model is on the "source" side of the relationship, then the field will be named
-            # "cr_<relationship-slug>__destination" since it's used to pick the destination object(s).
-            # If we're on the "destination" side, the field will be "cr_<relationship-slug>__source".
-            # For a symmetric relationship, both sides are "peer", so the field will be "cr_<relationship-slug>__peer"
-            field_name = f"cr_{relationship.slug}__{peer_side}"
+            # "cr_<relationship_key>__destination" since it's used to pick the destination object(s).
+            # If we're on the "destination" side, the field will be "cr_<relationship_key>__source".
+            # For a symmetric relationship, both sides are "peer", so the field will be "cr_<relationship_key>__peer"
+            field_name = f"cr_{relationship.key}__{peer_side}"
 
             if field_name in self.relationships:
                 # This is a symmetric relationship that we already processed from the opposing "initial_side".
@@ -291,7 +292,8 @@ class RoleFilter(NaturalKeyOrPKMultipleChoiceFilter):
     def __init__(self, *args, **kwargs):
         kwargs.setdefault("field_name", "role")
         kwargs.setdefault("queryset", Role.objects.all())
-        kwargs.setdefault("label", "Role (slug or ID)")
+        kwargs.setdefault("to_field_name", "name")
+        kwargs.setdefault("label", "Role (name or ID)")
 
         super().__init__(*args, **kwargs)
 
@@ -317,7 +319,7 @@ class StatusFilter(django_filters.ModelMultipleChoiceFilter):
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs["to_field_name"] = "slug"
+        kwargs["to_field_name"] = "name"
         super().__init__(*args, **kwargs)
 
     def get_queryset(self, request):
@@ -326,7 +328,7 @@ class StatusFilter(django_filters.ModelMultipleChoiceFilter):
 
     def get_filter_predicate(self, value):
         """Always use the field's name and the `to_field_name` attribute as predicate."""
-        # e.g. `status__slug`
+        # e.g. `status__name`
         to_field_name = self.field.to_field_name
         name = f"{self.field_name}__{to_field_name}"
         # Sometimes the incoming value is an instance. This block of logic comes from the base