nautobot 2.4.14__py3-none-any.whl → 2.4.15__py3-none-any.whl

nautobot/extras/filters/mixins.py

@@ -1,5 +1,7 @@
 from django.contrib.contenttypes.models import ContentType
 from django.db.models import Model, Q
+from django.utils.encoding import force_str
+from django.utils.text import capfirst
 import django_filters
 from django_filters.constants import EMPTY_VALUES
 from django_filters.utils import verbose_lookup_expr
@@ -131,11 +133,21 @@ class CustomFieldModelFilterSetMixin(django_filters.FilterSet):
         # Create new filters for each lookup expression in the map
         for lookup_name, lookup_expr in lookup_map.items():
             new_filter_name = f"{filter_name}__{lookup_name}"
+
+            # Based on logic in BaseFilterSet._generate_lookup_expression_filters
+            verbose_expression = (
+                ["exclude", custom_field.label] if lookup_name.startswith("n") else [custom_field.label]
+            )
+            if isinstance(lookup_expr, str):
+                verbose_expression.append(verbose_lookup_expr(lookup_expr))
+            verbose_expression = [force_str(part) for part in verbose_expression if part]
+            label = capfirst(" ".join(verbose_expression))
+
             new_filter = filter_type(
                 field_name=custom_field.key,
                 lookup_expr=lookup_expr,
                 custom_field=custom_field,
-                label=f"{custom_field.label} ({verbose_lookup_expr(lookup_expr)})",
+                label=label,
                 exclude=lookup_name.startswith("n"),
             )
 
@@ -297,6 +309,7 @@ class RoleModelFilterSetMixin(django_filters.FilterSet):
                 field_name="role",
                 query_params={"content_types": [cls._meta.model._meta.label_lower]},
             )
+            cls.declared_filters["role"] = filters["role"]  # pylint: disable=no-member
 
         return filters
 
@@ -326,5 +339,6 @@ class StatusModelFilterSetMixin(django_filters.FilterSet):
                 field_name="status",
                 query_params={"content_types": [cls._meta.model._meta.label_lower]},
             )
+            cls.declared_filters["status"] = filters["status"]  # pylint: disable=no-member
 
         return filters

nautobot/extras/forms/__init__.py

@@ -12,5 +12,6 @@ from .contacts import (
     TeamFilterForm,
     TeamForm,
 )
-from .forms import *  # noqa: F403  # undefined-local-with-import-star
+
 from .mixins import *  # noqa: F403  # undefined-local-with-import-star
+from .forms import *  # noqa: F403  # undefined-local-with-import-star

nautobot/extras/forms/forms.py

@@ -43,6 +43,7 @@ from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
     ButtonClassChoices,
+    CustomFieldFilterLogicChoices,
     DynamicGroupTypeChoices,
     JobExecutionType,
     JobQueueTypeChoices,
@@ -134,6 +135,7 @@ __all__ = (
     "ConfigContextSchemaForm",
     "CustomFieldBulkCreateForm",  # 2.0 TODO remove this deprecated class
     "CustomFieldBulkDeleteForm",
+    "CustomFieldBulkEditForm",
     "CustomFieldChoiceFormSet",
     "CustomFieldFilterForm",
     "CustomFieldForm",
@@ -465,6 +467,66 @@ class CustomFieldDescriptionField(CommentField):
         return "Also used as the help text when editing models using this custom field.<br>" + super().default_helptext
 
 
+class CustomFieldBulkEditForm(BootstrapMixin, NoteModelBulkEditFormMixin):
+    pk = forms.ModelMultipleChoiceField(queryset=CustomField.objects.all(), widget=forms.MultipleHiddenInput)
+    grouping = forms.CharField(
+        required=False,
+        max_length=CHARFIELD_MAX_LENGTH,
+        label="Grouping",
+        help_text="Human-readable grouping that this custom field belongs to.",
+    )
+    description = forms.CharField(
+        required=False,
+        max_length=CHARFIELD_MAX_LENGTH,
+        label="Description",
+        help_text="A helpful description for this field.",
+    )
+    required = forms.NullBooleanField(
+        required=False,
+        widget=BulkEditNullBooleanSelect,
+        label="Required",
+        help_text="If true, this field is required when creating new objects or editing an existing object.",
+    )
+    filter_logic = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(CustomFieldFilterLogicChoices.CHOICES),
+        label="Filter logic",
+        help_text="Loose matches any instance of a given string; Exact matches the entire field.",
+    )
+    weight = forms.IntegerField(
+        required=False, label="Weight", help_text="Fields with higher weights appear lower in a form."
+    )
+    advanced_ui = forms.NullBooleanField(
+        required=False,
+        widget=BulkEditNullBooleanSelect,
+        label="Move to Advanced tab",
+        help_text="Hide this field from the object's primary information tab. It will appear in the 'Advanced' tab instead.",
+    )
+    add_content_types = MultipleContentTypeField(
+        limit_choices_to=FeatureQuery("custom_fields"), required=False, label="Add Content Types"
+    )
+    remove_content_types = MultipleContentTypeField(
+        limit_choices_to=FeatureQuery("custom_fields"), required=False, label="Remove Content Types"
+    )
+
+    class Meta:
+        model = CustomField
+        fields = (
+            "grouping",
+            "description",
+            "required",
+            "filter_logic",
+            "weight",
+            "advanced_ui",
+            "add_content_types",
+            "remove_content_types",
+        )
+        nullable_fields = [
+            "grouping",
+            "description",
+        ]
+
+
 class CustomFieldForm(BootstrapMixin, forms.ModelForm):
     label = forms.CharField(
         required=True, max_length=CHARFIELD_MAX_LENGTH, help_text="Name of the field as displayed to users."

nautobot/extras/managers.py

@@ -111,10 +111,13 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
         except Job.DoesNotExist:
             pass
 
+        if "date_started" in kwargs:
+            fields["date_started"] = kwargs["date_started"]
+
         obj, created = self.using(using).get_or_create(id=task_id, defaults=fields)
 
         if not created:
-            # Make sure `date_done` is allowed to stay null until the task reacheas a ready state.
+            # Make sure `date_done` is allowed to stay null until the task reaches a ready state.
             #
             # Default behavior in `django-celery-results` has this field as a
             # `DateField(auto_now=True)` which just automatically updates the `date_done` field on every

nautobot/extras/migrations/0125_jobresult_date_started.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.23 on 2025-08-11 16:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("django_celery_results", "0012_taskresult_date_started"),
+        ("extras", "0124_add_joblogentry_index"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="jobresult",
+            name="date_started",
+            field=models.DateTimeField(blank=True, db_index=True, null=True),
+        ),
+    ]

nautobot/extras/models/customfields.py

@@ -514,8 +514,7 @@ class CustomField(
         blank=True,
         null=True,
         help_text=(
-            "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "
-            '"Foo").'
+            'Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").'
         ),
     )
     weight = models.PositiveSmallIntegerField(

nautobot/extras/models/datasources.py

@@ -100,8 +100,7 @@ class GitRepository(PrimaryModel):
 
         if self.present_in_database and self.slug != self.__initial_slug:
             raise ValidationError(
-                f"Slug cannot be changed once set. Current slug is {self.__initial_slug}, "
-                f"requested slug is {self.slug}"
+                f"Slug cannot be changed once set. Current slug is {self.__initial_slug}, requested slug is {self.slug}"
             )
 
         if not self.present_in_database:

nautobot/extras/models/jobs.py

@@ -650,6 +650,7 @@ class JobResult(BaseModel, CustomFieldModel):
         help_text="Registered name of the Celery task for this job. Internal use only.",
     )
     date_created = models.DateTimeField(auto_now_add=True, db_index=True)
+    date_started = models.DateTimeField(null=True, blank=True, db_index=True)
     date_done = models.DateTimeField(null=True, blank=True, db_index=True)
     user = models.ForeignKey(
         to=settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, related_name="+", blank=True, null=True
@@ -714,7 +715,7 @@ class JobResult(BaseModel, CustomFieldModel):
     natural_key_field_names = ["id"]
 
     def __str__(self):
-        return f"{self.name} started at {self.date_created} ({self.status})"
+        return f"{self.name} created at {self.date_created} ({self.status})"
 
     def as_dict(self):
         """This is required by the django-celery-results DB backend."""
@@ -736,7 +737,8 @@ class JobResult(BaseModel, CustomFieldModel):
         if not self.date_done:
             return None
 
-        duration = self.date_done - self.date_created
+        # Older records may not have a date_started value, so we use date_created as a fallback.
+        duration = self.date_done - (self.date_started or self.date_created)
         minutes, seconds = divmod(duration.total_seconds(), 60)
 
         return f"{int(minutes)} minutes, {seconds:.2f} seconds"
@@ -754,7 +756,8 @@ class JobResult(BaseModel, CustomFieldModel):
             # Only add metrics if we have a related job model. If we are moving to a terminal state we should always
             # have a related job model, so this shouldn't be too tight of a restriction.
             if self.job_model:
-                duration = self.date_done - self.date_created
+                # Older records may not have a date_started value, so we use date_created as a fallback.
+                duration = self.date_done - (self.date_started or self.date_created)
                 JOB_RESULT_METRIC.labels(self.job_model.grouping, self.job_model.name, status).observe(
                     duration.total_seconds()
                 )
@@ -884,6 +887,7 @@ class JobResult(BaseModel, CustomFieldModel):
             # synchronous tasks are run before the JobResult is saved, so any fields required by
             # the job must be added before calling `apply()`
             job_result.celery_kwargs = job_celery_kwargs
+            job_result.date_started = timezone.now()
             job_result.save()
 
             # setup synchronous task logging

nautobot/extras/plugins/views.py

@@ -16,6 +16,8 @@ import yaml
 
 from nautobot.core.api.views import AuthenticatedAPIRootView, NautobotAPIVersionMixin
 from nautobot.core.forms import TableConfigForm
+from nautobot.core.ui.breadcrumbs import Breadcrumbs, ViewNameBreadcrumbItem
+from nautobot.core.ui.titles import Titles
 from nautobot.core.views.generic import GenericView
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.extras.plugins.tables import InstalledAppsTable
@@ -84,6 +86,10 @@ class InstalledAppsView(GenericView):
     """
 
     table = InstalledAppsTable
+    breadcrumbs = Breadcrumbs(
+        items={"generic": [ViewNameBreadcrumbItem(view_name="apps:apps_list", label="Installed Apps")]}
+    )
+    view_titles = Titles(titles={"generic": "Installed Apps"})
 
     def get(self, request):
         marketplace_data = load_marketplace_data()
@@ -123,6 +129,9 @@ class InstalledAppsView(GenericView):
                 "filter_form": None,
                 "app_icons": app_icons,
                 "display": display,
+                "view_action": "generic",
+                "breadcrumbs": self.breadcrumbs,
+                "view_titles": self.view_titles,
             },
         )
 
@@ -228,6 +237,11 @@ class MarketplaceView(GenericView):
     View for listing all available Apps.
     """
 
+    breadcrumbs = Breadcrumbs(
+        items={"generic": [ViewNameBreadcrumbItem(view_name="apps:apps_marketplace", label="Apps Marketplace")]}
+    )
+    view_titles = Titles(titles={"generic": "Apps Marketplace"})
+
     def get(self, request):
         marketplace_data = load_marketplace_data()
 
@@ -240,4 +254,13 @@ class MarketplaceView(GenericView):
                     marketplace_app["installed"] = True
                     break
 
-        return render(request, "extras/marketplace.html", {"apps": marketplace_data["apps"]})
+        return render(
+            request,
+            "extras/marketplace.html",
+            {
+                "apps": marketplace_data["apps"],
+                "view_action": "generic",
+                "breadcrumbs": self.breadcrumbs,
+                "view_titles": self.view_titles,
+            },
+        )

nautobot/extras/secrets/__init__.py

@@ -65,7 +65,7 @@ def register_secrets_provider(provider):
     if provider.slug in registry["secrets_providers"]:
         raise KeyError(
             f'Cannot register {provider} as slug "{provider.slug}" is already registered '
-            f'by {registry["secrets_providers"][provider.slug]}'
+            f"by {registry['secrets_providers'][provider.slug]}"
         )
     registry["secrets_providers"][provider.slug] = provider
 

nautobot/extras/tables.py

@@ -890,6 +890,8 @@ class JobResultTable(BaseTable):
     pk = ToggleColumn()
     job_model = tables.Column(linkify=True)
     date_created = tables.DateTimeColumn(linkify=True, format=settings.SHORT_DATETIME_FORMAT)
+    date_started = tables.DateTimeColumn(linkify=True, format=settings.SHORT_DATETIME_FORMAT)
+    date_done = tables.DateTimeColumn(linkify=True, format=settings.SHORT_DATETIME_FORMAT)
     status = tables.TemplateColumn(
         template_code="{% include 'extras/inc/job_label.html' with result=record %}",
     )
@@ -961,6 +963,8 @@ class JobResultTable(BaseTable):
         fields = (
             "pk",
             "date_created",
+            "date_started",
+            "date_done",
             "name",
             "job_model",
             "scheduled_job",
@@ -1193,6 +1197,11 @@ class ObjectChangeTable(BaseTable):
             "request_id",
         )
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # The `object_repr` column also uses the `changed_object` generic-foreign-key value
+        self.add_conditional_prefetch("object_repr", "changed_object")
+
 
 #
 # Relationship

nautobot/extras/templates/extras/customfield.html

@@ -1,129 +1,2 @@
-{% extends 'generic/object_retrieve.html' %}
-{% load buttons %}
-{% load helpers %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Custom Field</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Label</td>
-                        <td>{{ object.label }}</td>
-                    </tr>
-                    <tr>
-                        <td>Key</td>
-                        <td>{{ object.key }}</td>
-                    </tr>
-                    <tr>
-                        <td>Type</td>
-                        <td>{{ object.type | capfirst }}</td>
-                    </tr>
-                    <tr>
-                        <td>Weight</td>
-                        <td>{{ object.weight }}</td>
-                    </tr>
-                    <tr>
-                        <td>Grouping</td>
-                        <td>{{ object.grouping | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Description</td>
-                        <td>{{ object.description | render_markdown | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Required</td>
-                        <td>{{ object.required | render_boolean }}</td>
-                    </tr>
-                    <tr>
-                        <td>Default</td>
-                        <td>
-                            {% if object.type == "markdown" %}
-                                {{ object.default | render_markdown | placeholder }}
-                            {% elif object.type == "json" and object.default is not None %}
-                                <pre>{{ object.default | render_json }}</pre>
-                            {% else %}
-                                {{ object.default | placeholder }}
-                            {% endif %}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Filter Logic</td>
-                        <td>{{ object.filter_logic | capfirst }}</td>
-                    </tr>
-                    <tr>
-                        <td>Move to Advanced Tab</td>
-                        <td>{{ object.advanced_ui | render_boolean }}</td>
-                    </tr>
-                </table>
-            </div>
-            {% if object.custom_field_choices.exists %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Custom Field Choices</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <thead>
-                        <tr>
-                            <th>Value</th>
-                            <th>Weight</th>
-                        </tr>
-                    </thead>
-                    <tbody>
-                    {% for choice in object.custom_field_choices.all %}
-                        <tr>
-                            <td>{{ choice.value }}</td>
-                            <td>{{ choice.weight }}</td>
-                        </tr>
-                    {% endfor %}
-                    </tbody>
-                </table>
-            </div>
-            {% endif %}
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Assignment</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Content Types</td>
-                        <td>
-                            <ul>
-                                {% for ct in object.content_types.all %}
-                                    <li>{{ ct }}</li>
-                                {% endfor %}
-                            </ul>
-                        </td>
-                    </tr>
-                </table>
-            </div>
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Validation Rules</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Minimum Value/Length</td>
-                        <td>{{ object.validation_minimum | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Maximum Value/Length</td>
-                        <td>{{ object.validation_maximum | placeholder }}</td>
-                    </tr>
-                    <tr>
-                        <td>Validation Regex</td>
-                        <td>
-                            {% if object.validation_regex %}
-                                <code>{{ object.validation_regex | placeholder }}</code>
-                            {% else %}
-                                {{ object.validation_regex | placeholder }}
-                            {% endif %}
-                        </td>
-                    </tr>
-                </table>
-            </div>
-{% endblock content_right_page %}
+{% extends 'extras/customfield_retrieve.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/extras/templates/extras/customfield_edit.html

@@ -1,108 +1,2 @@
-{% extends 'generic/object_create.html' %}
-{% load static %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Custom Field</strong></div>
-        <div class="panel-body">
-            {% render_field form.label %}
-            {% render_field form.grouping %}
-            {% render_field form.key %}
-            {% render_field form.type %}
-            {% render_field form.weight %}
-            {% render_field form.description %}
-            {% render_field form.required %}
-            {% render_field form.default %}
-            {% render_field form.filter_logic %}
-            {% render_field form.advanced_ui %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Assignment</strong></div>
-        <div class="panel-body">
-            {% render_field form.content_types %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Validation Rules</strong></div>
-        <div class="panel-body">
-            {% render_field form.validation_minimum %}
-            {% render_field form.validation_maximum %}
-            {% render_field form.validation_regex %}
-        </div>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Custom Field Choices</strong></div>
-        <div class="panel-body">
-            {% if choices.errors %}
-                <div class="text-danger">
-                    Please correct the error(s) below:
-
-                    {% for choice in choices.forms %}
-                        {% if choice.errors %}
-                            {% for error in choice.errors.values %}{{ error }}{% endfor %}
-                        {% endif %}
-                    {% endfor %}
-                </div>
-            {% endif %}
-            {{ choices.non_field_errors }}
-            <table class="table" id="custom-field-choices">
-              {{ choices.management_form }}
-              {% for choice in choices.forms %}
-                    {% if forloop.first %}
-                        <thead>
-                        <tr>
-                            {% for field in choice.visible_fields %}
-                                <th>{{ field.label|capfirst }}</th>
-                            {% endfor %}
-                        </tr>
-                        </thead>
-                    {% endif %}
-                    <tr class="formset_row-{{ choices.prefix }}">
-                        {% for field in choice.visible_fields %}
-                            <td>
-                                {# Include the hidden fields in the form #}
-                                {% if forloop.first %}
-                                    {% for hidden in choice.hidden_fields %}
-                                        {{ hidden }}
-                                    {% endfor %}
-                                {% endif %}
-                                {{ field }}
-                                {% if field.errors %}
-                                    <ul>
-                                        {% for error in field.errors %}
-                                            {# Embed an HTML comment indicating the error for extraction by tests #}
-                                            <!-- FORM-ERROR {{ field.name }}: {{ error }} -->
-                                            <li class="text-danger">{{ error }}</li>
-                                        {% endfor %}
-                                    </ul>
-                                {% endif %}
-                            </td>
-                        {% endfor %}
-                    </tr>
-               {% endfor %}
-            </table>
-        </div>
-    </div>
-    {% include 'inc/extras_features_edit_form_fields.html' %}
-
-{% endblock form %}
-
-{% block javascript %}
-{{ block.super }}
-<script src="{% static 'jquery/jquery.formset.js' %}"></script>
-<script type="text/javascript">
-    const slugify_prefer_underscores = true; // Custom fields work better in GraphQL (etc.) with underscore-based slugs
-    $('.formset_row-{{ choices.prefix }}').formset({
-        addText: '<span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add another Custom Field Choice',
-        addCssClass: 'btn btn-primary add-row',
-        deleteText: '<span class="mdi mdi-trash-can-outline" aria-hidden="true"></span>',
-        deleteCssClass: 'btn btn-danger delete-row',
-        prefix: '{{ choices.prefix }}',
-        formCssClass: 'dynamic-formset-{{ choices.prefix }}',
-        keepFieldValues: 'input[type="number"]',
-        added: jsify_form
-    });
-</script>
-{% endblock javascript %}
+{% extends 'extras/customfield_update.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}