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

nautobot/extras/models/relationships.py

@@ -1,3 +1,4 @@
+from collections import defaultdict
 import logging
 
 from django import forms
@@ -422,31 +423,38 @@ class RelationshipModel(models.Model):
 class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
     use_in_migrations = True
 
-    def get_for_model(self, model, hidden=None):
+    def get_for_model(self, model, hidden=None, get_queryset=True):
         """
         Return all Relationships assigned to the given model.
 
         Args:
             model (Model): The django model to which relationships are registered
             hidden (bool): Filter based on the value of the hidden flag, or None to not apply this filter
+            get_queryset (bool): Whether to return querysets or object lists.
 
-        Returns a tuple of source and destination scoped relationship querysets.
+        Returns a tuple of source and destination scoped relationship record querysets/lists.
         """
         return (
-            self.get_for_model_source(model, hidden=hidden),
-            self.get_for_model_destination(model, hidden=hidden),
+            self.get_for_model_source(model, hidden=hidden, get_queryset=get_queryset),
+            self.get_for_model_destination(model, hidden=hidden, get_queryset=get_queryset),
         )
 
-    def get_for_model_source(self, model, hidden=None):
+    def get_for_model_source(self, model, hidden=None, get_queryset=True):
         """
         Return all Relationships assigned to the given model for the source side only.
 
         Args:
             model (Model): The django model to which relationships are registered
             hidden (bool): Filter based on the value of the hidden flag, or None to not apply this filter
+            get_queryset (bool): Whether to return a queryset or an object list.
         """
         concrete_model = model._meta.concrete_model
         cache_key = f"{self.get_for_model_source.cache_key_prefix}.{concrete_model._meta.label_lower}.{hidden}"
+        list_cache_key = f"{cache_key}.list"
+        if not get_queryset:
+            listing = cache.get(list_cache_key)
+            if listing is not None:
+                return listing
         queryset = cache.get(cache_key)
         if queryset is None:
             content_type = ContentType.objects.get_for_model(concrete_model)
@@ -456,20 +464,30 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             if hidden is not None:
                 queryset = queryset.filter(source_hidden=hidden)
             cache.set(cache_key, queryset)
+        if not get_queryset:
+            listing = list(queryset)
+            cache.set(list_cache_key, listing)
+            return listing
         return queryset
 
     get_for_model_source.cache_key_prefix = "nautobot.extras.relationship.get_for_model_source"
 
-    def get_for_model_destination(self, model, hidden=None):
+    def get_for_model_destination(self, model, hidden=None, get_queryset=True):
         """
         Return all Relationships assigned to the given model for the destination side only.
 
         Args:
             model (Model): The django model to which relationships are registered
             hidden (bool): Filter based on the value of the hidden flag, or None to not apply this filter
+            get_queryset (bool): Whether to return a queryset or an object list.
         """
         concrete_model = model._meta.concrete_model
         cache_key = f"{self.get_for_model_destination.cache_key_prefix}.{concrete_model._meta.label_lower}.{hidden}"
+        list_cache_key = f"{cache_key}.list"
+        if not get_queryset:
+            listing = cache.get(list_cache_key)
+            if listing is not None:
+                return listing
         queryset = cache.get(cache_key)
         if queryset is None:
             content_type = ContentType.objects.get_for_model(concrete_model)
@@ -481,6 +499,10 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             if hidden is not None:
                 queryset = queryset.filter(destination_hidden=hidden)
             cache.set(cache_key, queryset)
+        if not get_queryset:
+            listing = list(queryset)
+            cache.set(list_cache_key, listing)
+            return listing
         return queryset
 
     get_for_model_destination.cache_key_prefix = "nautobot.extras.relationship.get_for_model_destination"
@@ -495,6 +517,33 @@ class RelationshipManager(BaseManager.from_queryset(RestrictedQuerySet)):
             | Q(destination_type=content_type, required_on=RelationshipRequiredSideChoices.DESTINATION_SIDE_REQUIRED)
         )
 
+    def populate_list_caches(self):
+        """Populate all relevant caches for `get_for_model(..., get_queryset=False)` and related lookups."""
+        queryset = self.all().select_related("source_type", "destination_type")
+        listings = defaultdict(lambda: defaultdict(lambda: defaultdict(list)))
+        for rel in queryset:
+            listings["source"][f"{rel.source_type.app_label}.{rel.source_type.model}"]["None"].append(rel)
+            listings["source"][f"{rel.source_type.app_label}.{rel.source_type.model}"][str(rel.source_hidden)].append(
+                rel
+            )
+            listings["destination"][f"{rel.destination_type.app_label}.{rel.destination_type.model}"]["None"].append(
+                rel
+            )
+            listings["destination"][f"{rel.destination_type.app_label}.{rel.destination_type.model}"][
+                str(rel.destination_hidden)
+            ].append(rel)
+        for ct in ContentType.objects.all():
+            label = f"{ct.app_label}.{ct.model}"
+            for hidden in ["None", "True", "False"]:
+                cache.set(
+                    f"{self.get_for_model_source.cache_key_prefix}.{label}.{hidden}.list",
+                    listings["source"][label][hidden],
+                )
+                cache.set(
+                    f"{self.get_for_model_destination.cache_key_prefix}.{label}.{hidden}.list",
+                    listings["destination"][label][hidden],
+                )
+
 
 class Relationship(
     ChangeLoggedModel,

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 %}

nautobot/extras/templates/extras/customfield_retrieve.html

@@ -0,0 +1,129 @@
+{% 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 %}