nautobot 2.2.2__py3-none-any.whl → 2.2.4__py3-none-any.whl

nautobot/core/templates/admin/base.html

@@ -56,7 +56,7 @@
     {% if not is_popup %}
         {% if "BANNER_TOP"|settings_or_config %}
             <div class="alert alert-info text-center" role="alert">
-                {{ "BANNER_TOP"|settings_or_config|safe }}
+                {{ "BANNER_TOP"|settings_or_config|render_markdown }}
             </div>
         {% endif %}
         {% if settings.MAINTENANCE_MODE %}
@@ -107,7 +107,7 @@
     <div class="push"></div>
     {% if "BANNER_BOTTOM"|settings_or_config %}
         <div class="alert alert-info text-center banner-bottom" role="alert">
-                {{ "BANNER_BOTTOM"|settings_or_config|safe }}
+                {{ "BANNER_BOTTOM"|settings_or_config|render_markdown }}
         </div>
     {% endif %}
 </div>

nautobot/core/templates/base_django.html

@@ -16,7 +16,7 @@
         {% if request.user.is_authenticated %}
             {% if "BANNER_TOP"|settings_or_config %}
                 <div class="alert alert-info text-center" role="alert">
-                    {{ "BANNER_TOP"|settings_or_config|safe }}
+                    {{ "BANNER_TOP"|settings_or_config|render_markdown }}
                 </div>
             {% endif %}
         {% endif %}
@@ -42,7 +42,7 @@
         {% if request.user.is_authenticated %}
             {% if "BANNER_BOTTOM"|settings_or_config %}
                 <div class="alert alert-info text-center banner-bottom" role="alert">
-                    {{ "BANNER_BOTTOM"|settings_or_config|safe }}
+                    {{ "BANNER_BOTTOM"|settings_or_config|render_markdown }}
                 </div>
             {% endif %}
         {% endif %}

nautobot/core/templates/buttons/export.html

@@ -1,60 +1,60 @@
 {% if export_url %}
     {% if export_templates or include_yaml_option %}
-        <form style="display: inline-block" action="{{ export_url }}" method="post">
-            {% csrf_token %}
-            <input type="hidden" name="content_type" value="{{ content_type.pk }}">
-            <input type="hidden" name="query_string" value="{{ query_string }}">
-            <input type="hidden" name="export_format"
-                   value="{% if include_yaml_option %}yaml{% else %}csv{% endif %}">
-            <input type="hidden" name="_schedule_type" value="immediately">
-            <div class="btn-group">
-                <button type="submit" class="btn btn-success">
-                    <span class="mdi mdi-database-export" aria-hidden="true"></span>
-                    Export
-                </button>
-                <button type="button" class="btn btn-success dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-                    <span class="caret"></span>
-                    <span class="sr-only">Toggle Dropdown</span>
-                </button>
-                <ul class="dropdown-menu dropdown-menu-right">
-                    {% if include_yaml_option %}
-                        <li>
-                            <button type="submit" class="btn btn-link">YAML format</button>
-                        </li>
+        <div class="btn-group">
+            <button type="submit" class="btn btn-success" form="export_default">
+                <span class="mdi mdi-database-export" aria-hidden="true"></span>
+                Export
+            </button>
+            <form id="export_default" style="display: inline-block" action="{{ export_url }}" method="post">
+                {% csrf_token %}
+                <input type="hidden" name="content_type" value="{{ content_type.pk }}">
+                <input type="hidden" name="query_string" value="{{ query_string }}">
+                <input type="hidden" name="export_format"
+                       value="{% if include_yaml_option %}yaml{% else %}csv{% endif %}">
+                <input type="hidden" name="_schedule_type" value="immediately">
+            </form>
+            <button type="button" class="btn btn-success dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                <span class="caret"></span>
+                <span class="sr-only">Toggle Dropdown</span>
+            </button>
+            <ul class="dropdown-menu dropdown-menu-right">
+                {% if include_yaml_option %}
+                    <li>
+                        <button type="submit" class="btn btn-link" form="export_default">YAML format</button>
+                    </li>
+                    <li>
+                        <form action="{{ export_url }}" method="post">
+                            {% csrf_token %}
+                            <input type="hidden" name="content_type" value="{{ content_type.pk }}">
+                            <input type="hidden" name="query_string" value="{{ query_string }}">
+                            <input type="hidden" name="_schedule_type" value="immediately">
+                            <button type="submit" class="btn btn-link">CSV format</button>
+                        </form>
+                    </li>
+                {% else %}
+                    <li>
+                        <button type="submit" class="btn btn-link" form="export_default">CSV format</button>
+                    </li>
+                {% endif %}
+                {% if export_templates %}
+                    <li class="divider"></li>
+                    {% for et in export_templates %}
                         <li>
                             <form action="{{ export_url }}" method="post">
                                 {% csrf_token %}
                                 <input type="hidden" name="content_type" value="{{ content_type.pk }}">
+                                <input type="hidden" name="export_template" value="{{ et.pk }}">
                                 <input type="hidden" name="query_string" value="{{ query_string }}">
                                 <input type="hidden" name="_schedule_type" value="immediately">
-                                <button type="submit" class="btn btn-link">CSV format</button>
+                                <button type="submit" class="btn btn-link"
+                                    {% if et.description %}title="{{ et.description }}"{% endif %}
+                                >{{ et.name }}</button>
                             </form>
                         </li>
-                    {% else %}
-                        <li>
-                            <button type="submit" class="btn btn-link">CSV format</button>
-                        </li>
-                    {% endif %}
-                    {% if export_templates %}
-                        <li class="divider"></li>
-                        {% for et in export_templates %}
-                            <li>
-                                <form action="{{ export_url }}" method="post">
-                                    {% csrf_token %}
-                                    <input type="hidden" name="content_type" value="{{ content_type.pk }}">
-                                    <input type="hidden" name="export_template" value="{{ et.pk }}">
-                                    <input type="hidden" name="query_string" value="{{ query_string }}">
-                                    <input type="hidden" name="_schedule_type" value="immediately">
-                                    <button type="submit" class="btn btn-link"
-                                        {% if et.description %}title="{{ et.description }}"{% endif %}
-                                    >{{ et.name }}</button>
-                                </form>
-                            </li>
-                        {% endfor %}
-                    {% endif %}
-                </ul>
-            </div>
-        </form>
+                    {% endfor %}
+                {% endif %}
+            </ul>
+        </div>
     {% else %}
         <form style="display: inline-block" action="{{ export_url }}" method="post">
             {% csrf_token %}

nautobot/core/templates/generic/object_list.html

@@ -74,7 +74,7 @@
                     class="remove-filter-param"
                     title="Remove all items"
                     data-field-type="parent"
-                    data-field-value={{ field.name }}
+                    data-field-value="{{ field.name }}"
             >×</span>
             <ul class="filter-selection-rendered">
                 {% for value in field.values %}
@@ -85,8 +85,8 @@
                     <span
                             class="filter-selection-choice-remove remove-filter-param"
                             data-field-type="child"
-                            data-field-parent={{ field.name }}
-                            data-field-value={{ value.name }}
+                            data-field-parent="{{ field.name }}"
+                            data-field-value="{{ value.name }}"
                     >×</span>{{ value.display }}
                 </li>
                 {% endfor %}

nautobot/core/templates/inc/javascript.html

@@ -40,3 +40,6 @@
     hljs.configure({ cssSelector: '.language-graphql, .language-json, .language-xml, .language-yaml' });
     hljs.highlightAll();
 </script>
+{% if settings.BRANDING_FILEPATHS.javascript %}
+<script src="{% custom_branding_or_static 'javascript' None %}"></script>
+{% endif %}

nautobot/core/templates/inc/media.html

@@ -34,6 +34,9 @@
     <link rel="stylesheet" id="base-theme"
           href="{% versioned_static 'css/base.css' %}"
           onerror="window.location='{% url 'media_failure' %}?filename=css/base.css'">
+    {% if settings.BRANDING_FILEPATHS.css %}
+    <link rel="stylesheet" id="custom-css" href="{% custom_branding_or_static 'css' None %}">
+    {% endif %}
     <link rel="apple-touch-icon" sizes="180x180" href="{% custom_branding_or_static 'icon_180' 'img/nautobot_icon_180x180.png' %}">
     <link rel="icon" type="image/png" sizes="32x32" href="{% custom_branding_or_static 'icon_32' 'img/nautobot_icon_32x32.png' %}">
     <link rel="icon" type="image/png" sizes="16x16" href="{% custom_branding_or_static 'icon_16' 'img/nautobot_icon_16x16.png' %}">

nautobot/core/templates/login.html

@@ -53,8 +53,8 @@
 <div class="row" style="margin-top: {% if 'BANNER_LOGIN'|settings_or_config %}100{% else %}150{% endif %}px;">
     <div class="col-sm-4 col-sm-offset-4">
         {% if "BANNER_LOGIN"|settings_or_config %}
-            <div style="margin-bottom: 25px">
-                {{ "BANNER_LOGIN"|settings_or_config|safe }}
+            <div class="alert alert-info text-center" role="alert">
+                {{ "BANNER_LOGIN"|settings_or_config|render_markdown }}
             </div>
         {% endif %}
         {% if form.non_field_errors %}

nautobot/core/templates/nautobot_config.py.j2

@@ -248,6 +248,8 @@ SECRET_KEY = os.getenv("NAUTOBOT_SECRET_KEY", "{{ secret_key }}")
 #         "NAUTOBOT_BRANDING_FILEPATHS_HEADER_BULLET", None
 #     ),  # bullet image used for various view headers
 #     "nav_bullet": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_NAV_BULLET", None),  # bullet image used for nav menu headers
+#     "css": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_CSS", None),  # Custom global CSS
+#     "javascript": os.getenv("NAUTOBOT_BRANDING_FILEPATHS_JAVASCRIPT", None),  # Custom global JavaScript
 # }
 
 # Prepended to CSV, YAML and export template filenames (i.e. `nautobot_device.yml`)

nautobot/core/templatetags/helpers.py

@@ -8,7 +8,7 @@ from django.conf import settings
 from django.contrib.staticfiles.finders import find
 from django.templatetags.static import static, StaticNode
 from django.urls import NoReverseMatch, reverse
-from django.utils.html import format_html
+from django.utils.html import format_html, format_html_join
 from django.utils.safestring import mark_safe
 from django.utils.text import slugify as django_slugify
 from django_jinja import library
@@ -71,14 +71,7 @@ def hyperlinked_object(value, field="display"):
         >>> hyperlinked_object(location, "name")
         '<a href="/dcim/locations/leaf/">Leaf</a>'
     """
-    if value is None:
-        return placeholder(value)
-    display = getattr(value, field) if hasattr(value, field) else str(value)
-    if hasattr(value, "get_absolute_url"):
-        if hasattr(value, "description") and value.description:
-            return format_html('<a href="{}" title="{}">{}</a>', value.get_absolute_url(), value.description, display)
-        return format_html('<a href="{}">{}</a>', value.get_absolute_url(), display)
-    return format_html("{}", display)
+    return _build_hyperlink(value, field)
 
 
 @library.filter()
@@ -822,3 +815,67 @@ def queryset_to_pks(obj):
     result = list(obj.values_list("pk", flat=True)) if obj else []
     result = [str(entry) for entry in result]
     return ",".join(result)
+
+
+@library.filter()
+@register.filter()
+def hyperlinked_object_target_new_tab(value, field="display"):
+    """Render and link to a Django model instance, if any, or render a placeholder if not.
+
+    Similar to the hyperlinked_object filter, but passes attributes needed to open the link in new tab.
+
+    Uses the specified object field if available, otherwise uses the string representation of the object.
+    If the object defines `get_absolute_url()` this will be used to hyperlink the displayed object;
+    additionally if there is an `object.description` this will be used as the title of the hyperlink.
+
+    Args:
+        value (Union[django.db.models.Model, None]): Instance of a Django model or None.
+        field (Optional[str]): Name of the field to use for the display value. Defaults to "display".
+
+    Returns:
+        (str): String representation of the value (hyperlinked if it defines get_absolute_url()) or a placeholder.
+
+    Examples:
+        >>> hyperlinked_object_target_new_tab(device)
+        '<a href="/dcim/devices/3faafe8c-bdd6-4317-88dc-f791e6988caa/" target="_blank" rel="noreferrer">Device 1</a>'
+        >>> hyperlinked_object_target_new_tab(device_role)
+        '<a href="/dcim/device-roles/router/" title="Devices that are routers, not switches" target="_blank" rel="noreferrer">Router</a>'
+        >>> hyperlinked_object_target_new_tab(None)
+        '<span class="text-muted">&mdash;</span>'
+        >>> hyperlinked_object_target_new_tab("Hello")
+        'Hello'
+        >>> hyperlinked_object_target_new_tab(location)
+        '<a href="/dcim/locations/leaf/" target="_blank" rel="noreferrer">Root → Intermediate → Leaf</a>'
+        >>> hyperlinked_object_target_new_tab(location, "name")
+        '<a href="/dcim/locations/leaf/" target="_blank" rel="noreferrer">Leaf</a>'
+    """
+    return _build_hyperlink(value, field, target="_blank", rel="noreferrer")
+
+
+def _build_hyperlink(value, field="", target="", rel=""):
+    """Internal function used by filters to build hyperlinks.
+
+    Args:
+        value (Union[django.db.models.Model, None]): Instance of a Django model or None.
+        field (Optional[str]): Name of the field to use for the display value. Defaults to "display".
+        target (Optional[str]): Location to open the linked document.  Defaults to "" which is _self.
+        rel (Optional[str]): Relationship between current document and linked document. Defaults to "".
+
+    Returns:
+        (str): String representation of the value (hyperlinked if it defines get_absolute_url()) or a placeholder.
+    """
+    if value is None:
+        return placeholder(value)
+
+    attributes = {}
+    display = getattr(value, field) if hasattr(value, field) else str(value)
+    if hasattr(value, "get_absolute_url"):
+        attributes["href"] = value.get_absolute_url()
+        if hasattr(value, "description") and value.description:
+            attributes["title"] = value.description
+        if target:
+            attributes["target"] = target
+        if rel:
+            attributes["rel"] = rel
+        return format_html("<a {}>{}</a>", format_html_join(" ", '{}="{}"', attributes.items()), display)
+    return format_html("{}", display)

nautobot/core/testing/__init__.py

@@ -102,7 +102,12 @@ def get_job_class_and_model(module, name, source="local"):
         (JobClassInfo): Named 2-tuple of (job_class, job_model)
     """
     job_class = get_job(f"{module}.{name}")
-    job_model = Job.objects.get(module_name=module, job_class_name=name)
+    try:
+        job_model = Job.objects.get(module_name=module, job_class_name=name)
+    except Job.DoesNotExist:
+        raise RuntimeError(
+            f"Job database record for {module}.{name} not found. Known jobs are: {list(Job.objects.all())}"
+        )
     job_model.enabled = True
     job_model.validated_save()
     return JobClassInfo(job_class, job_model)

nautobot/core/testing/api.py

@@ -13,12 +13,11 @@ from rest_framework import status
 from rest_framework.relations import ManyRelatedField
 from rest_framework.test import APITransactionTestCase as _APITransactionTestCase
 
-from nautobot.core import testing
 from nautobot.core.api.utils import get_serializer_for_model
 from nautobot.core.models import fields as core_fields
 from nautobot.core.models.tree_queries import TreeModel
 from nautobot.core.templatetags.helpers import bettertitle
-from nautobot.core.testing import mixins, views
+from nautobot.core.testing import mixins, utils, views
 from nautobot.core.utils import lookup
 from nautobot.core.utils.data import is_uuid
 from nautobot.extras import choices as extras_choices, models as extras_models, registry
@@ -111,7 +110,7 @@ class APIViewTestCases:
                 self.model._meta.model_name,
             ) in settings.EXEMPT_EXCLUDE_MODELS:
                 # Models listed in EXEMPT_EXCLUDE_MODELS should not be accessible to anonymous users
-                with testing.disable_warnings("django.request"):
+                with utils.disable_warnings("django.request"):
                     self.assertHttpStatus(self.client.get(url, **self.header), status.HTTP_403_FORBIDDEN)
             else:
                 response = self.client.get(url, **self.header)
@@ -125,7 +124,7 @@ class APIViewTestCases:
             url = self._get_detail_url(self._get_queryset().first())
 
             # Try GET without permission
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 self.assertHttpStatus(self.client.get(url, **self.header), status.HTTP_403_FORBIDDEN)
 
         @override_settings(EXEMPT_VIEW_PERMISSIONS=[])
@@ -303,7 +302,7 @@ class APIViewTestCases:
                 self.model._meta.model_name,
             ) in settings.EXEMPT_EXCLUDE_MODELS:
                 # Models listed in EXEMPT_EXCLUDE_MODELS should not be accessible to anonymous users
-                with testing.disable_warnings("django.request"):
+                with utils.disable_warnings("django.request"):
                     self.assertHttpStatus(self.client.get(url, **self.header), status.HTTP_403_FORBIDDEN)
             else:
                 # TODO(Glenn): if we're passing **self.header, we are *by definition* **NOT** anonymous!!
@@ -389,7 +388,7 @@ class APIViewTestCases:
             url = self._get_list_url()
 
             # Try GET without permission
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 self.assertHttpStatus(self.client.get(url, **self.header), status.HTTP_403_FORBIDDEN)
 
         @override_settings(EXEMPT_VIEW_PERMISSIONS=[])
@@ -490,7 +489,7 @@ class APIViewTestCases:
             GET a list of objects with an unknown filter parameter and strict filtering, expect a 400 response.
             """
             self.add_permissions(f"{self.model._meta.app_label}.view_{self.model._meta.model_name}")
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 response = self.client.get(f"{self._get_list_url()}?ice_cream_flavor=rocky-road", **self.header)
             self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
             self.assertIsInstance(response.data, dict)
@@ -606,7 +605,7 @@ class APIViewTestCases:
             url = self._get_list_url()
 
             # Try POST without permission
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 response = self.client.post(url, self.create_data[0], format="json", **self.header)
                 self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
 
@@ -679,7 +678,7 @@ class APIViewTestCases:
                 instance = self.get_deletable_object()
             else:
                 # try to do it ourselves
-                instance = testing.get_deletable_objects(self.model, self._get_queryset()).first()
+                instance = utils.get_deletable_objects(self.model, self._get_queryset()).first()
             if instance is None:
                 self.fail("Couldn't find a single deletable object!")
 
@@ -776,7 +775,7 @@ class APIViewTestCases:
             update_data = self.update_data or getattr(self, "create_data")[0]
 
             # Try PATCH without permission
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 response = self.client.patch(url, update_data, format="json", **self.header)
                 self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
 
@@ -983,7 +982,7 @@ class APIViewTestCases:
             For some models this may just be any random object, but when we have FKs with `on_delete=models.PROTECT`
             (as is often the case) we need to find or create an instance that doesn't have such entanglements.
             """
-            instance = testing.get_deletable_objects(self.model, self._get_queryset()).first()
+            instance = utils.get_deletable_objects(self.model, self._get_queryset()).first()
             if instance is None:
                 self.fail("Couldn't find a single deletable object!")
             return instance
@@ -995,7 +994,7 @@ class APIViewTestCases:
             For some models this may just be any random objects, but when we have FKs with `on_delete=models.PROTECT`
             (as is often the case) we need to find or create an instance that doesn't have such entanglements.
             """
-            instances = testing.get_deletable_objects(self.model, self._get_queryset()).values_list("pk", flat=True)[:3]
+            instances = utils.get_deletable_objects(self.model, self._get_queryset()).values_list("pk", flat=True)[:3]
             if len(instances) < 3:
                 self.fail(f"Couldn't find 3 deletable objects, only found {len(instances)}!")
             return instances
@@ -1007,7 +1006,7 @@ class APIViewTestCases:
             url = self._get_detail_url(self.get_deletable_object())
 
             # Try DELETE without permission
-            with testing.disable_warnings("django.request"):
+            with utils.disable_warnings("django.request"):
                 response = self.client.delete(url, **self.header)
                 self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN)
 

nautobot/core/testing/mixins.py

@@ -11,8 +11,8 @@ from django.forms.models import model_to_dict
 from netaddr import IPNetwork
 from rest_framework.test import APIClient, APIRequestFactory
 
-from nautobot.core import testing
 from nautobot.core.models import fields as core_fields
+from nautobot.core.testing import utils
 from nautobot.core.utils import permissions
 from nautobot.extras import management, models as extras_models
 from nautobot.users import models as users_models
@@ -169,7 +169,7 @@ class NautobotTestCaseMixin:
                 # REST API response; pass the response data through directly
                 err_message += f"\n{response.data}"
             # Attempt to extract form validation errors from the response HTML
-            form_errors = testing.extract_form_failures(response.content.decode(response.charset))
+            form_errors = utils.extract_form_failures(response.content.decode(response.charset))
             err_message += "\n" + str(form_errors or response.content.decode(response.charset) or "No data")
             if msg:
                 err_message = f"{msg}\n{err_message}"