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

nautobot/extras/migrations/0109_dynamicgroup_group_type_dynamicgroup_tags_and_more.py

@@ -0,0 +1,108 @@
+# Generated by Django 4.2.13 on 2024-05-30 17:31
+
+import uuid
+
+import django.core.serializers.json
+from django.db import migrations, models
+import django.db.models.deletion
+
+import nautobot.core.models.fields
+import nautobot.extras.models.groups
+import nautobot.extras.models.mixins
+import nautobot.extras.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tenancy", "0009_update_all_charfields_max_length_to_255"),
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("extras", "0108_jobbutton_enabled"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="dynamicgroup",
+            name="group_type",
+            field=models.CharField(default="dynamic-filter", max_length=16),
+        ),
+        migrations.AddField(
+            model_name="dynamicgroup",
+            name="tags",
+            field=nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag"),
+        ),
+        migrations.AddField(
+            model_name="dynamicgroup",
+            name="tenant",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="managed_dynamic_groups",
+                to="tenancy.tenant",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="dynamicgroup",
+            name="content_type",
+            field=models.ForeignKey(
+                limit_choices_to=nautobot.extras.utils.FeatureQuery("dynamic_groups"),
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="dynamic_groups",
+                to="contenttypes.contenttype",
+            ),
+        ),
+        migrations.CreateModel(
+            name="StaticGroupAssociation",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("associated_object_id", models.UUIDField(db_index=True)),
+                (
+                    "associated_object_type",
+                    models.ForeignKey(
+                        limit_choices_to=nautobot.extras.utils.FeatureQuery("dynamic_groups"),
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="static_group_associations",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "dynamic_group",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="static_group_associations",
+                        to="extras.dynamicgroup",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["dynamic_group", "associated_object_type", "associated_object_id"],
+                "indexes": [
+                    models.Index(fields=["dynamic_group", "associated_object_id"], name="extras_sga_double"),
+                    models.Index(
+                        fields=["associated_object_type_id", "associated_object_id"],
+                        name="extras_sga_associated_object",
+                    ),
+                ],
+                "unique_together": {("dynamic_group", "associated_object_type", "associated_object_id")},
+            },
+            bases=(
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+            managers=[
+                ("objects", nautobot.extras.models.groups.StaticGroupAssociationDefaultManager()),
+                ("all_objects", nautobot.extras.models.groups.StaticGroupAssociationManager()),
+            ],
+        ),
+    ]

nautobot/extras/migrations/0110_alter_configcontext_cluster_groups_and_more.py

@@ -0,0 +1,111 @@
+# Generated by Django 4.2.9 on 2024-01-17 18:52
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+import nautobot.extras.models.models
+import nautobot.extras.models.roles
+import nautobot.extras.models.statuses
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("dcim", "0060_alter_cable_status_alter_consoleport__path_and_more"),
+        ("virtualization", "0026_change_virtualmachine_primary_ip_fields"),
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("tenancy", "0008_tagsfield"),
+        ("extras", "0109_dynamicgroup_group_type_dynamicgroup_tags_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="configcontext",
+            name="cluster_groups",
+            field=models.ManyToManyField(blank=True, related_name="+", to="virtualization.clustergroup"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="clusters",
+            field=models.ManyToManyField(blank=True, related_name="+", to="virtualization.cluster"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="device_redundancy_groups",
+            field=models.ManyToManyField(blank=True, related_name="+", to="dcim.deviceredundancygroup"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="device_types",
+            field=models.ManyToManyField(blank=True, related_name="+", to="dcim.devicetype"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="dynamic_groups",
+            field=models.ManyToManyField(
+                blank=True,
+                limit_choices_to=nautobot.extras.models.models.limit_dynamic_group_choices,
+                related_name="+",
+                to="extras.dynamicgroup",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="locations",
+            field=models.ManyToManyField(blank=True, related_name="+", to="dcim.location"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="platforms",
+            field=models.ManyToManyField(blank=True, related_name="+", to="dcim.platform"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="roles",
+            field=models.ManyToManyField(blank=True, related_name="+", to="extras.role"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="tags",
+            field=models.ManyToManyField(blank=True, related_name="+", to="extras.tag"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="tenant_groups",
+            field=models.ManyToManyField(blank=True, related_name="+", to="tenancy.tenantgroup"),
+        ),
+        migrations.AlterField(
+            model_name="configcontext",
+            name="tenants",
+            field=models.ManyToManyField(blank=True, related_name="+", to="tenancy.tenant"),
+        ),
+        migrations.AlterField(
+            model_name="contactassociation",
+            name="role",
+            field=nautobot.extras.models.roles.RoleField(on_delete=django.db.models.deletion.PROTECT, to="extras.role"),
+        ),
+        migrations.AlterField(
+            model_name="contactassociation",
+            name="status",
+            field=nautobot.extras.models.statuses.StatusField(
+                on_delete=django.db.models.deletion.PROTECT, to="extras.status"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="taggeditem",
+            name="content_type",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="%(app_label)s_%(class)s_tagged_items",
+                to="contenttypes.contenttype",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="taggeditem",
+            name="tag",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="%(app_label)s_%(class)s_items",
+                to="extras.tag",
+            ),
+        ),
+    ]

nautobot/extras/migrations/0111_metadata.py

@@ -0,0 +1,162 @@
+# Generated by Django 4.2.13 on 2024-06-26 15:10
+
+import uuid
+
+import django.core.serializers.json
+from django.db import migrations, models
+import django.db.models.deletion
+
+import nautobot.core.models.fields
+import nautobot.extras.models.metadata
+import nautobot.extras.models.mixins
+import nautobot.extras.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("extras", "0110_alter_configcontext_cluster_groups_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="MetadataType",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                ("data_type", models.CharField(max_length=50)),
+                (
+                    "content_types",
+                    models.ManyToManyField(
+                        limit_choices_to=nautobot.extras.utils.FeatureQuery("metadata"),
+                        related_name="metadata_types",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+            managers=[
+                ("objects", nautobot.extras.models.metadata.MetadataTypeManager()),
+            ],
+        ),
+        migrations.CreateModel(
+            name="ObjectMetadata",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "scoped_fields",
+                    nautobot.core.models.fields.JSONArrayField(base_field=models.CharField(max_length=255), blank=True),
+                ),
+                ("_value", models.JSONField(blank=True, null=True)),
+                ("assigned_object_id", models.UUIDField(db_index=True)),
+                (
+                    "assigned_object_type",
+                    models.ForeignKey(
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "contact",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="object_metadata",
+                        to="extras.contact",
+                    ),
+                ),
+                (
+                    "metadata_type",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="object_metadata",
+                        to="extras.metadatatype",
+                    ),
+                ),
+                (
+                    "team",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="object_metadata",
+                        to="extras.team",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["metadata_type"],
+                "verbose_name_plural": "object metadata",
+                "indexes": [
+                    models.Index(fields=["assigned_object_type", "assigned_object_id"], name="assigned_object"),
+                    models.Index(
+                        fields=["assigned_object_type", "assigned_object_id", "contact"], name="assigned_object_contact"
+                    ),
+                    models.Index(
+                        fields=["assigned_object_type", "assigned_object_id", "team"], name="assigned_object_team"
+                    ),
+                ],
+            },
+            managers=[
+                ("objects", nautobot.extras.models.metadata.ObjectMetadataManager()),
+            ],
+        ),
+        migrations.CreateModel(
+            name="MetadataChoice",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                ("value", models.CharField(max_length=255)),
+                ("weight", models.PositiveSmallIntegerField(default=100)),
+                (
+                    "metadata_type",
+                    models.ForeignKey(
+                        limit_choices_to=models.Q(("data_type__in", ["select", "multi-select"])),
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="choices",
+                        to="extras.metadatatype",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["metadata_type", "weight", "value"],
+                "unique_together": {("metadata_type", "value")},
+            },
+        ),
+    ]

nautobot/extras/migrations/0112_dynamic_group_group_type_data_migration.py

@@ -0,0 +1,28 @@
+from django.db import migrations
+
+from nautobot.extras.choices import DynamicGroupTypeChoices
+
+
+def set_dynamic_group_group_types(apps, schema_editor):
+    """Set dynamic group group_type values appropriately."""
+    DynamicGroup = apps.get_model("extras", "DynamicGroup")
+
+    # The group_type field defaults to TYPE_DYNAMIC_FILTER
+    # There are no preexisting TYPE_STATIC groups as that's a new feature
+    # Any group that has children should be converted to TYPE_DYNAMIC_SET
+    DynamicGroup.objects.filter(children__isnull=False).distinct().update(
+        group_type=DynamicGroupTypeChoices.TYPE_DYNAMIC_SET
+    )
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0111_metadata"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=set_dynamic_group_group_types,
+            reverse_code=migrations.operations.special.RunPython.noop,
+        ),
+    ]

nautobot/extras/migrations/0113_saved_views.py

@@ -0,0 +1,77 @@
+# Generated by Django 4.2.14 on 2024-07-15 19:26
+
+import uuid
+
+from django.conf import settings
+import django.core.serializers.json
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("extras", "0112_dynamic_group_group_type_data_migration"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SavedView",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                ("name", models.CharField(max_length=255)),
+                ("view", models.CharField(max_length=255)),
+                (
+                    "config",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("is_global_default", models.BooleanField(default=False)),
+                ("is_shared", models.BooleanField(default=True)),
+                ("owner", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                "verbose_name": "saved view",
+                "verbose_name_plural": "saved views",
+                "ordering": ["owner", "view", "name"],
+                "unique_together": {("owner", "name", "view")},
+            },
+        ),
+        migrations.CreateModel(
+            name="UserSavedViewAssociation",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("view_name", models.CharField(max_length=255)),
+                (
+                    "saved_view",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="user_assignments",
+                        to="extras.savedview",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="saved_view_assignments",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("user", "view_name")},
+            },
+        ),
+    ]

nautobot/extras/models/__init__.py

@@ -2,7 +2,7 @@ from .change_logging import ChangeLoggedModel, ObjectChange
 from .contacts import Contact, ContactAssociation, Team
 from .customfields import ComputedField, CustomField, CustomFieldChoice, CustomFieldModel
 from .datasources import GitRepository
-from .groups import DynamicGroup, DynamicGroupMembership
+from .groups import DynamicGroup, DynamicGroupMembership, StaticGroupAssociation
 from .jobs import (
     Job,
     JobButton,
@@ -12,6 +12,8 @@ from .jobs import (
     ScheduledJob,
     ScheduledJobs,
 )
+from .metadata import MetadataChoice, MetadataType, ObjectMetadata
+from .mixins import ContactMixin, DynamicGroupMixin, DynamicGroupsModelMixin, SavedViewMixin
 from .models import (
     ConfigContext,
     ConfigContextModel,
@@ -25,6 +27,8 @@ from .models import (
     HealthCheckTestModel,
     ImageAttachment,
     Note,
+    SavedView,
+    UserSavedViewAssociation,
     Webhook,
 )
 from .relationships import Relationship, RelationshipAssociation, RelationshipModel
@@ -41,12 +45,15 @@ __all__ = (
     "ConfigContextSchema",
     "Contact",
     "ContactAssociation",
+    "ContactMixin",
     "CustomField",
     "CustomFieldChoice",
     "CustomFieldModel",
     "CustomLink",
     "DynamicGroup",
     "DynamicGroupMembership",
+    "DynamicGroupMixin",  # deprecated
+    "DynamicGroupsModelMixin",
     "ExportTemplate",
     "ExternalIntegration",
     "FileAttachment",
@@ -60,23 +67,30 @@ __all__ = (
     "JobHook",
     "JobLogEntry",
     "JobResult",
+    "MetadataChoice",
+    "MetadataType",
     "Note",
     "ObjectChange",
+    "ObjectMetadata",
     "Relationship",
     "RelationshipModel",
     "RelationshipAssociation",
     "Role",
     "RoleField",
+    "SavedView",
+    "SavedViewMixin",
     "ScheduledJob",
     "ScheduledJobs",
     "Secret",
     "SecretsGroup",
     "SecretsGroupAssociation",
+    "StaticGroupAssociation",
     "Status",
     "StatusField",
     "StatusModel",
     "Tag",
     "TaggedItem",
     "Team",
+    "UserSavedViewAssociation",
     "Webhook",
 )

nautobot/extras/models/change_logging.py

@@ -33,10 +33,10 @@ class ChangeLoggedModel(models.Model):
 
     def to_objectchange(self, action, *, related_object=None, object_data_extra=None, object_data_exclude=None):
         """
-        Return a new ObjectChange representing a change made to this object. This will typically be called automatically
-        by ChangeLoggingMiddleware.
-        """
+        Return a new ObjectChange representing a change made to this object, or None if the object shouldn't be logged.
 
+        This will typically be called automatically by ChangeLoggingMiddleware.
+        """
         return ObjectChange(
             changed_object=self,
             object_repr=str(self)[:CHANGELOG_MAX_OBJECT_REPR],

nautobot/extras/models/contacts.py

@@ -91,6 +91,10 @@ class ContactAssociation(OrganizationalModel):
     role = RoleField(blank=False, null=False)
     status = StatusField(blank=False, null=False)
 
+    is_contact_associable_model = False
+    is_dynamic_group_associable_model = False
+    is_saved_view_model = False
+
     class Meta:
         unique_together = (
             ("contact", "associated_object_type", "associated_object_id", "role"),

nautobot/extras/models/customfields.py

@@ -38,7 +38,7 @@ from nautobot.core.templatetags.helpers import render_markdown
 from nautobot.core.utils.data import render_jinja2
 from nautobot.extras.choices import CustomFieldFilterLogicChoices, CustomFieldTypeChoices
 from nautobot.extras.models import ChangeLoggedModel
-from nautobot.extras.models.mixins import NotesMixin
+from nautobot.extras.models.mixins import ContactMixin, DynamicGroupsModelMixin, NotesMixin, SavedViewMixin
 from nautobot.extras.tasks import delete_custom_field_data, update_custom_field_choice_data
 from nautobot.extras.utils import check_if_key_is_graphql_safe, extras_features, FeatureQuery
 
@@ -65,7 +65,14 @@ class ComputedFieldManager(BaseManager.from_queryset(RestrictedQuerySet)):
 
 
 @extras_features("graphql")
-class ComputedField(BaseModel, ChangeLoggedModel, NotesMixin):
+class ComputedField(
+    ContactMixin,
+    ChangeLoggedModel,
+    DynamicGroupsModelMixin,
+    NotesMixin,
+    SavedViewMixin,
+    BaseModel,
+):
     """
     Read-only rendered fields driven by a Jinja2 template that are applied to objects within a ContentType.
     """
@@ -332,7 +339,14 @@ class CustomFieldManager(BaseManager.from_queryset(RestrictedQuerySet)):
 
 
 @extras_features("webhooks")
-class CustomField(BaseModel, ChangeLoggedModel, NotesMixin):
+class CustomField(
+    ContactMixin,
+    ChangeLoggedModel,
+    DynamicGroupsModelMixin,
+    NotesMixin,
+    SavedViewMixin,
+    BaseModel,
+):
     content_types = models.ManyToManyField(
         to=ContentType,
         related_name="custom_fields",
@@ -760,6 +774,7 @@ class CustomFieldChoice(BaseModel, ChangeLoggedModel):
     weight = models.PositiveSmallIntegerField(default=100, help_text="Higher weights appear later in the list")
 
     documentation_static_path = "docs/user-guide/platform-functionality/customfield.html"
+    is_metadata_associable_model = False
 
     class Meta:
         ordering = ["custom_field", "weight", "value"]