nautobot 2.3.15b1__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/extras/migrations/0117_create_job_queue_model.py

@@ -0,0 +1,129 @@
+# Generated by Django 4.2.15 on 2024-08-13 20:36
+
+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.mixins
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tenancy", "0009_update_all_charfields_max_length_to_255"),
+        ("extras", "0116_fix_dynamic_group_group_type_data_migration"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="JobQueue",
+            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)),
+                ("queue_type", models.CharField(max_length=50)),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+                (
+                    "tenant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="job_queues",
+                        to="tenancy.tenant",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.CreateModel(
+            name="JobQueueAssignment",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                (
+                    "job",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="job_queue_assignments",
+                        to="extras.job",
+                    ),
+                ),
+                (
+                    "job_queue",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="job_assignments",
+                        to="extras.jobqueue",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["job", "job_queue"],
+                "unique_together": {("job", "job_queue")},
+            },
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="job_queues",
+            field=models.ManyToManyField(
+                through="extras.JobQueueAssignment", to="extras.jobqueue", related_name="jobs"
+            ),
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="default_job_queue_override",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="default_job_queue",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="extras.jobqueue",
+                related_name="default_for_jobs",
+            ),
+        ),
+        migrations.RenameField(
+            model_name="job",
+            old_name="task_queues_override",
+            new_name="job_queues_override",
+        ),
+        migrations.AddField(
+            model_name="scheduledjob",
+            name="job_queue",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="scheduled_jobs",
+                to="extras.jobqueue",
+            ),
+        ),
+    ]

nautobot/extras/migrations/0118_task_queue_to_job_queue_migration.py

@@ -0,0 +1,78 @@
+# Generated by Django 4.2.15 on 2024-08-20 14:58
+
+from django.db import migrations
+
+from nautobot.extras.choices import JobQueueTypeChoices
+
+
+def migrate_task_queues_to_job_queues(apps, schema):
+    # Get the relevant models
+    Job = apps.get_model("extras", "Job")
+    ScheduledJob = apps.get_model("extras", "ScheduledJob")
+    JobQueue = apps.get_model("extras", "JobQueue")
+
+    # should always create default job queue
+    JobQueue.objects.get_or_create(name="default", defaults={"queue_type": JobQueueTypeChoices.TYPE_CELERY})
+    for job in Job.objects.all():
+        task_queues = job.task_queues
+        if len(task_queues) > 0:
+            default_job_queue, _ = JobQueue.objects.get_or_create(
+                name=task_queues[0], defaults={"queue_type": JobQueueTypeChoices.TYPE_CELERY}
+            )
+        else:
+            default_job_queue = JobQueue.objects.get(name="default")
+        job.default_job_queue = default_job_queue
+        job.save()
+        # Go through each task_queue
+        # make or get the corresponding job_queue object and assign it to the job
+        job_queues = [job.default_job_queue]
+        for task_queue in task_queues[1:]:
+            job_queue, _ = JobQueue.objects.get_or_create(
+                name=task_queue, defaults={"queue_type": JobQueueTypeChoices.TYPE_CELERY}
+            )
+            job_queues.append(job_queue)
+        job.job_queues.set(job_queues)
+
+    for sj in ScheduledJob.objects.all():
+        queue = sj.queue
+        job_queue = None
+        if queue:
+            job_queue, _ = JobQueue.objects.get_or_create(
+                name=queue, defaults={"queue_type": JobQueueTypeChoices.TYPE_CELERY}
+            )
+        sj.job_queue = job_queue
+        sj.save()
+
+
+def reverse_migrate_task_queues_to_job_queues(apps, schema):
+    Job = apps.get_model("extras", "Job")
+    ScheduledJob = apps.get_model("extras", "ScheduledJob")
+    JobQueueAssignment = apps.get_model("extras", "JobQueueAssignment")
+
+    for job in Job.objects.all():
+        queue_names = list(job.job_queues.all().values_list("name", flat=True))
+        job.task_queues = queue_names
+        job.save()
+    JobQueueAssignment.objects.all().delete()
+
+    for sj in ScheduledJob.objects.all():
+        job_queue = sj.job_queue
+        if job_queue:
+            sj.queue = job_queue.name
+        else:
+            sj.queue = ""
+        sj.job_queue = None
+        sj.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0117_create_job_queue_model"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=migrate_task_queues_to_job_queues,
+            reverse_code=reverse_migrate_task_queues_to_job_queues,
+        )
+    ]

nautobot/extras/migrations/0119_remove_task_queues_from_job_and_queue_from_scheduled_job.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.15 on 2024-08-28 15:49
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0118_task_queue_to_job_queue_migration"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="job",
+            name="task_queues",
+        ),
+        migrations.RemoveField(
+            model_name="scheduledjob",
+            name="queue",
+        ),
+        migrations.AlterField(
+            model_name="job",
+            name="default_job_queue",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT, related_name="default_for_jobs", to="extras.jobqueue"
+            ),
+        ),
+    ]

nautobot/extras/migrations/0120_job_is_singleton_job_is_singleton_override.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.16 on 2024-11-11 07:04
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0119_remove_task_queues_from_job_and_queue_from_scheduled_job"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="job",
+            name="is_singleton",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="is_singleton_override",
+            field=models.BooleanField(default=False),
+        ),
+    ]

nautobot/extras/migrations/0121_alter_team_contacts.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.16 on 2024-12-03 15:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0120_job_is_singleton_job_is_singleton_override"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="team",
+            name="contacts",
+            field=models.ManyToManyField(blank=True, related_name="teams", to="extras.contact"),
+        ),
+    ]

nautobot/extras/models/__init__.py

@@ -8,6 +8,8 @@ from .jobs import (
     JobButton,
     JobHook,
     JobLogEntry,
+    JobQueue,
+    JobQueueAssignment,
     JobResult,
     ScheduledJob,
     ScheduledJobs,
@@ -66,6 +68,8 @@ __all__ = (
     "JobButton",
     "JobHook",
     "JobLogEntry",
+    "JobQueue",
+    "JobQueueAssignment",
     "JobResult",
     "MetadataChoice",
     "MetadataType",
@@ -73,8 +77,8 @@ __all__ = (
     "ObjectChange",
     "ObjectMetadata",
     "Relationship",
-    "RelationshipModel",
     "RelationshipAssociation",
+    "RelationshipModel",
     "Role",
     "RoleField",
     "SavedView",

nautobot/extras/models/change_logging.py

@@ -169,14 +169,18 @@ class ObjectChange(BaseModel):
     def get_action_class(self):
         return ObjectChangeActionChoices.CSS_CLASSES.get(self.action)
 
-    def get_next_change(self, user=None):
+    def get_next_change(self, user=None, only=None):
         """Return next change for this changed object, optionally restricting by user view permission"""
         related_changes = self.get_related_changes(user=user)
+        if only:
+            related_changes = related_changes.only(*only)
         return related_changes.filter(time__gt=self.time).order_by("time").first()
 
-    def get_prev_change(self, user=None):
+    def get_prev_change(self, user=None, only=None):
         """Return previous change for this changed object, optionally restricting by user view permission"""
         related_changes = self.get_related_changes(user=user)
+        if only:
+            related_changes = related_changes.only(*only)
         return related_changes.filter(time__lt=self.time).order_by("-time").first()
 
     def get_related_changes(self, user=None, permission="view"):
@@ -207,7 +211,7 @@ class ObjectChange(BaseModel):
         prechange = None
         postchange = None
 
-        prior_change = self.get_prev_change()
+        prior_change = self.get_prev_change(only=["object_data_v2", "object_data"])
 
         if self.action != ObjectChangeActionChoices.ACTION_CREATE and prior_change is not None:
             prechange = prior_change.object_data_v2

nautobot/extras/models/contacts.py

@@ -61,7 +61,7 @@ class Contact(ContactTeamSharedBase):
 class Team(ContactTeamSharedBase):
     """A group of Contacts, usable interchangeably with a single Contact in most cases."""
 
-    contacts = models.ManyToManyField(to=Contact, related_name="teams")
+    contacts = models.ManyToManyField(to=Contact, related_name="teams", blank=True)
 
     class Meta(ContactTeamSharedBase.Meta):
         abstract = False

nautobot/extras/models/customfields.py

@@ -578,7 +578,13 @@ class CustomField(
             )
 
     def to_form_field(
-        self, set_initial=True, enforce_required=True, for_csv_import=False, simple_json_filter=False, label=None
+        self,
+        set_initial=True,
+        enforce_required=True,
+        for_csv_import=False,
+        simple_json_filter=False,
+        label=None,
+        for_filter_form=False,
     ):
         """
         Return a form field suitable for setting a CustomField's value for an object.
@@ -590,6 +596,7 @@ class CustomField(
                 this is *not* used for CSV imports since 2.0, but it *is* used for JSON/YAML import of DeviceTypes.
             simple_json_filter: Return a TextInput widget for JSON filtering instead of the default TextArea widget.
             label: Set the input label manually (if required); otherwise, defaults to field's __str__() implementation.
+            for_filter_form: If True return the relevant form field for filter form
         """
         initial = self.default if set_initial else None
         required = self.required if enforce_required else False
@@ -676,7 +683,7 @@ class CustomField(
             default_choice = self.custom_field_choices.filter(value=self.default).first()
 
             # Set the initial value to the first available choice (if any)
-            if self.type == CustomFieldTypeChoices.TYPE_SELECT:
+            if self.type == CustomFieldTypeChoices.TYPE_SELECT and not for_filter_form:
                 if not required or default_choice is None:
                     choices = add_blank_choice(choices)
                 field_class = CSVChoiceField if for_csv_import else forms.ChoiceField
@@ -704,16 +711,10 @@ class CustomField(
 
     def to_filter_form_field(self, lookup_expr="exact", *args, **kwargs):
         """Return a filter form field suitable for filtering a CustomField's value for an object."""
-        form_field = self.to_form_field(*args, **kwargs)
-        # We would handle type selection differently because:
-        # 1. We'd need to use StaticSelect2Multiple for lookup_type 'exact' because self.type `select` uses StaticSelect2 by default.
-        # 2. Remove the blank choice since StaticSelect2Multiple is always blank and interprets the blank choice as an extra option.
-        # 3. If lookup_type is not the same as exact, use MultiValueCharInput
+        form_field = self.to_form_field(*args, **kwargs, for_filter_form=True)
+        # We would handle type selection differently because: If lookup_type is not the same as exact, use MultiValueCharInput
         if self.type == CustomFieldTypeChoices.TYPE_SELECT:
-            if lookup_expr in ["exact", "contains"]:
-                choices = form_field.choices[1:]
-                form_field.widget = StaticSelect2Multiple(choices=choices)
-            else:
+            if lookup_expr not in ["exact", "contains"]:
                 form_field.widget = MultiValueCharInput()
         return form_field
 

nautobot/extras/models/groups.py

@@ -1,6 +1,7 @@
 """Dynamic Groups Models."""
 
 import logging
+from typing import Optional
 
 from django import forms
 from django.contrib.contenttypes.fields import GenericForeignKey
@@ -116,7 +117,7 @@ class DynamicGroup(PrimaryModel):
         return self._model
 
     @property
-    def filterset_class(self):
+    def filterset_class(self) -> Optional[type[django_filters.FilterSet]]:
         if getattr(self, "_filterset_class", None) is None:
             try:
                 self._filterset_class = get_filterset_for_model(self.model)
@@ -125,7 +126,7 @@ class DynamicGroup(PrimaryModel):
         return self._filterset_class
 
     @property
-    def filterform_class(self):
+    def filterform_class(self) -> Optional[type[forms.Form]]:
         if getattr(self, "_filterform_class", None) is None:
             try:
                 self._filterform_class = get_form_for_model(self.model, form_prefix="Filter")
@@ -134,7 +135,7 @@ class DynamicGroup(PrimaryModel):
         return self._filterform_class
 
     @property
-    def form_class(self):
+    def form_class(self) -> Optional[type[forms.Form]]:
         if getattr(self, "_form_class", None) is None:
             try:
                 self._form_class = get_form_for_model(self.model)
@@ -147,19 +148,19 @@ class DynamicGroup(PrimaryModel):
         """Return all FilterForm fields in a dictionary."""
 
         # Fail gracefully with an empty dict if nothing is working yet.
-        if not self.form_class:
+        if self.form_class is None or self.filterform_class is None or self.filterset_class is None:
             return {}
 
         # Get model form and fields
-        modelform = self.form_class()
+        modelform = self.form_class()  # pylint: disable=not-callable
         modelform_fields = modelform.fields
 
         # Get filter form and fields
-        filterform = self.filterform_class()
+        filterform = self.filterform_class()  # pylint: disable=not-callable
         filterform_fields = filterform.fields
 
         # Get filterset and fields
-        filterset = self.filterset_class()
+        filterset = self.filterset_class()  # pylint: disable=not-callable
         filterset_fields = filterset.filters
 
         # Get dynamic group filter field mappings (if any)
@@ -303,6 +304,7 @@ class DynamicGroup(PrimaryModel):
         # Since associated_object is a GenericForeignKey, we can't just do:
         #     return self.static_group_associations.values_list("associated_object", flat=True)
         return self.model.objects.filter(
+            # pylint: disable=no-member  # false positive about self.static_group_associations
             pk__in=self.static_group_associations(manager="all_objects").values_list("associated_object_id", flat=True)
         )
 
@@ -611,7 +613,7 @@ class DynamicGroup(PrimaryModel):
                 raise ValidationError({"filter": "Filter can only be set for groups of type `dynamic-filter`."})
         else:
             # Validate against the filterset's internal form validation.
-            filterset = self.filterset_class(self.filter)
+            filterset = self.filterset_class(self.filter)  # pylint: disable=not-callable
             if not filterset.is_valid():
                 raise ValidationError(filterset.errors)
 
@@ -725,7 +727,7 @@ class DynamicGroup(PrimaryModel):
         if self.group_type != DynamicGroupTypeChoices.TYPE_DYNAMIC_FILTER:
             raise RuntimeError(f"{self} is not a dynamic-filter group")
 
-        filterset = self.filterset_class(self.filter, self.model.objects.all())
+        filterset = self.filterset_class(self.filter, self.model.objects.all())  # pylint: disable=not-callable
         query = models.Q()
 
         # In this case we want all filters for a group's filter dict in a set intersection (boolean