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

nautobot/core/templates/utilities/render_jinja2.html

@@ -0,0 +1,117 @@
+{% extends "base.html" %}
+{% load form_helpers %}
+{% load helpers %}
+{% load static %}
+
+{% block extra_styles %}
+<style type="text/css">
+    .button-container {
+        margin-bottom: 24px;
+    }
+    #render_jinja_template_form textarea {
+        resize: vertical;
+        white-space: pre;
+    }
+
+</style>
+{% endblock extra_styles %}
+
+{% block header %}
+<h1>{% block title %}Jinja Template Renderer{% endblock %}</h1>
+<hr>
+{% endblock %}
+
+
+
+{% block content %}
+<form class="form form-horizontal" onsubmit="handleFormSubmit(event)" id="render_jinja_template_form">
+    <div class="row">
+        <div class="col-lg-6 col-md-6">
+            <div class="panel panel-default">
+                <div class="panel-heading"><strong>Template</strong></div>
+                <div class="panel-body">
+                    <div class="form-group">
+                        <label class="col-md-3 control-label required" for="id_template_code">Jinja Template</label>
+                        <div class="col-md-9">
+                            <textarea cols="40" rows="10" class="form-control" id="id_template_code" required=""></textarea>
+                        </div>
+                    </div>
+                    <div class="form-group">
+                        <label class="col-md-3 control-label" for="id_context">Data</label>
+                        <div class="col-md-9">
+                            <textarea cols="40" rows="10" class="form-control" placeholder="{}" id="id_context">{}</textarea>
+                            <span class="help-block">Enter data in <a href="https://json.org/">JSON</a> format.</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="button-container text-right">
+                <button type="submit" class="btn btn-primary">Render</button>
+            </div>
+        </div>
+        <div class="col-lg-6 col-md-6">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Rendered Template</strong>
+                    <button type="button" class="btn btn-inline btn-default copy-rendered-template" data-clipboard-target="#rendered_template">
+                        <span class="mdi mdi-content-copy"></span>
+                    </button>
+                </div>
+                <div class="panel-body">
+                    <textarea readonly="readonly" cols="40" rows="23" class="form-control" placeholder="Rendered Template" id="rendered_template"></textarea>
+                </div>
+            </div>
+        </div>
+    </div>
+</form>
+{% endblock content %}
+
+{% block javascript %}
+    {{ block.super }}
+    <script>
+        new ClipboardJS('.copy-rendered-template');
+        const sanitize = function(string) {
+            return string.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+        };
+        async function handleFormSubmit(event) {
+            event.preventDefault(); // Prevent default form submission
+
+            // Check that the context is valid JSON
+            const context = document.getElementById("id_context");
+            var parsed_context;
+            try {
+                parsed_context = JSON.parse(context.value);
+            } catch (error) {
+                context.setCustomValidity("Invalid JSON");
+                context.reportValidity();
+                context.setCustomValidity("");
+                return error;
+            }
+
+            try {
+                const rendered_template = document.getElementById("rendered_template");
+                rendered_template.innerHTML = "Loading...";
+                const template_code = document.getElementById("id_template_code").value;
+                const url = "{% url 'core-api:render_jinja_template' %}";
+                const data = {
+                    template_code: template_code,
+                    context: parsed_context
+                }
+                const response = await fetch(url, {
+                    method: "POST",
+                    body: JSON.stringify(data),
+                    headers: {"Content-Type": "application/json", "X-CSRFTOKEN": "{{ csrf_token }}"}
+                });
+                const responseData = await response.json();
+                if (!response.ok) {
+                    const msg = responseData.detail ? responseData.detail : response.statusText;
+                    rendered_template.innerHTML = sanitize(`An error occurred:\n\n${msg}`);
+                } else {
+                    rendered_template.innerHTML = sanitize(responseData.rendered_template);
+                }
+            } catch (error) {
+                rendered_template.innerHTML = sanitize(`An error occurred:\n\n${error.message}`);
+            }
+        }
+    </script>
+{% endblock javascript %}

nautobot/core/templates/utilities/templatetags/tag.html

@@ -1,3 +1,3 @@
 {% load helpers %}
 
-{% if url_name %}<a href="{% url url_name %}?tags={{ tag.name }}">{% endif %}<span class="label label-default" style="color: {{ tag.color|fgcolor }}; background-color: #{{ tag.color }}">{{ tag }}</span>{% if url_name %}</a>{% endif %}
+{% if url_name %}<a href="{% url url_name %}?tags={{ tag.name }}">{% endif %}<span class="label" style="color: {{ tag.color|fgcolor }}; background-color: #{{ tag.color }}">{{ tag }}</span>{% if url_name %}</a>{% endif %}

nautobot/core/templates/utilities/theme_preview.html

@@ -330,6 +330,7 @@
                     <small>title for most object views</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -340,6 +341,7 @@
                     <small>used for special purposes such as Location detail "badges"</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -350,6 +352,7 @@
                     <small>title for object create/edit forms</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -360,6 +363,7 @@
                     <small>used in modal titles and a few others</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -370,6 +374,7 @@
                     <small>used in user profiles and cable traces</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -380,6 +385,7 @@
                     <small>Unused in core</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>
@@ -390,6 +396,7 @@
                     <small>Small text</small>
                     <span class="label label-default">Default</span>
                     <span class="label label-primary">Primary</span>
+                    <span class="label label-transparent">Transparent</span>
                     <span class="label label-success">Success</span>
                     <span class="label label-info">Info</span>
                     <span class="label label-warning">Warning</span>

nautobot/core/templatetags/helpers.py

@@ -21,6 +21,7 @@ import yaml
 
 from nautobot.apps.config import get_app_settings_or_config
 from nautobot.core import forms
+from nautobot.core.constants import PAGINATE_COUNT_DEFAULT
 from nautobot.core.utils import color, config, data, logging as nautobot_logging, lookup
 from nautobot.core.utils.requests import add_nautobot_version_query_param_to_url
 
@@ -118,6 +119,26 @@ def placeholder(value):
     return HTML_NONE
 
 
+@library.filter()
+@register.filter()
+def pre_tag(value):
+    """Render a value within `<pre></pre>` tags to enable formatting.
+
+    Args:
+        value (any): Input value, can be any variable.
+
+    Returns:
+        (str): Value wrapped in `<pre></pre>` tags.
+
+    Example:
+        >>> pre_tag("")
+        '<pre></pre>'
+        >>> pre_tag("hello")
+        '<pre>hello</pre>'
+    """
+    return format_html("<pre>{}</pre>", value)
+
+
 @library.filter()
 @register.filter()
 def add_html_id(element_str, id_str):
@@ -202,6 +223,29 @@ def render_json(value, syntax_highlight=True, pretty_print=False):
 
     Unless `syntax_highlight=False` is specified, the returned string will be wrapped in a
     `<code class="language-json>` HTML tag to flag it for syntax highlighting by highlight.js.
+
+    Args:
+        value (any): Input value, can be any variable.
+        syntax_highlight (bool): Whether to highlight the JSON syntax or not.
+        pretty_print (bool): Wraps rendered and highlighted JSON in <pre> tag for better code display.
+
+    Returns:
+        (str): HTML
+            '<code class="language-json">{"json_key": "json_value"}</code>' if only syntax_highlight is True
+            - or -
+            '<pre><code class="language-json">{"json_key": "json_value"}</code></pre>' if both syntax_highlight and pretty_print are True
+            - or -
+            '{"json_key": "json_value"}' if only pretty_print is True (both syntax_highlight and pretty_print must be True for pretty print)
+
+    Examples:
+        >>> render_json({"key": "value"})
+        '<code class="language-json">{"key": "value"}</code>'
+        >>> render_json({"key": "value"}, syntax_highlight=False)
+        '{"key": "value"}'
+        >>> render_json({"key": "value"}, pretty_print=True)
+        '<pre><code class="language-json">{"key": "value"}</code></pre>'
+        >>> render_json({"key": "value"}, syntax_highlight=False, pretty_print=True)
+        '{"key": "value"}'
     """
     rendered_json = json.dumps(value, indent=4, sort_keys=True, ensure_ascii=False)
     if syntax_highlight:
@@ -616,6 +660,57 @@ def render_uptime(seconds):
     )
 
 
+@library.filter()
+@register.filter()
+def dbm(value):
+    """Display value as dBm."""
+    return f"{value} dBm" if value else placeholder(value)
+
+
+@library.filter()
+@register.filter()
+def hyperlinked_field(value, hyperlink=None):
+    """Render a value as a hyperlink."""
+    if not value:
+        return placeholder(value)
+    hyperlink = hyperlink or value
+    return format_html('<a href="{}">{}</a>', hyperlink, value)
+
+
+@library.filter()
+@register.filter()
+def render_content_types(value):
+    """Render sorted by model and app_label ContentTypes value"""
+    if not value.exists():
+        return HTML_NONE
+    output = format_html("<ul>")
+    sorted_value = value.order_by("app_label", "model")
+    for content_type in sorted_value:
+        output += format_html("<li>{content_type}</li>", content_type=content_type)
+    output += format_html("</ul>")
+
+    return output
+
+
+@library.filter()
+@register.filter()
+def render_ancestor_hierarchy(value):
+    """Renders a nested HTML list representing the hierarchy of ancestors for a given object."""
+    result = format_html('<ul class="tree-hierarchy">')
+    append_to_result = format_html("</ul>")
+    for ancestor in value.ancestors():
+        nestable_tag = format_html('<span title="nestable">↺</span>' if getattr(ancestor, "nestable", False) else "")
+        result += format_html(
+            "<li>{value} {nestable_tag}<ul>", value=hyperlinked_object(ancestor, "name"), nestable_tag=nestable_tag
+        )
+        append_to_result += format_html("</ul></li>")
+    nestable_tag = format_html('<span title="nestable">↺</span>' if getattr(value, "nestable", False) else "")
+    result += format_html("<li><strong>{value} {nestable_tag}</strong></li>", value=value, nestable_tag=nestable_tag)
+    result += append_to_result
+
+    return result
+
+
 #
 # Tags
 #
@@ -645,15 +740,15 @@ def querystring(request, **kwargs):
 
 
 @register.simple_tag()
-def table_config_button(table, table_name=None, extra_classes=""):
+def table_config_button(table, table_name=None, extra_classes="", disabled=False):
     if table_name is None:
         table_name = table.__class__.__name__
     html_template = (
         '<button type="button" class="btn btn-default {}'
-        '" data-toggle="modal" data-target="#{}_config" title="Configure table">'
+        '" data-toggle="modal" data-target="#{}_config" {} title="Configure table">'
         '<i class="mdi mdi-cog"></i> Configure</button>'
     )
-    return format_html(html_template, extra_classes, table_name)
+    return format_html(html_template, extra_classes, table_name, 'disabled="disabled"' if disabled else "")
 
 
 @register.simple_tag()
@@ -852,11 +947,11 @@ def saved_view_modal(
     elif current_saved_view is not None and not per_page:
         # no changes made, display current saved view pagination count
         param_dict["per_page"] = current_saved_view.config.get(
-            "pagination_count", config.get_settings_or_config("PAGINATE_COUNT")
+            "pagination_count", config.get_settings_or_config("PAGINATE_COUNT", fallback=PAGINATE_COUNT_DEFAULT)
         )
     else:
         # display default pagination count
-        param_dict["per_page"] = config.get_settings_or_config("PAGINATE_COUNT")
+        param_dict["per_page"] = config.get_settings_or_config("PAGINATE_COUNT", fallback=PAGINATE_COUNT_DEFAULT)
 
     if sort_order:
         # user made changes to saved view sort order
@@ -955,12 +1050,13 @@ def versioned_static(file_path):
 
 
 @register.simple_tag
-def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui):
+def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui, base_depth=0):
     """Generates a visual representation of a tree record hierarchy using dots.
 
     Args:
         tree_depth (range): A range representing the depth of the tree nodes.
         hide_hierarchy_ui (bool): Indicates whether to hide the hierarchy UI.
+        base_depth (int, optional): Starting depth (number of dots to skip rendering).
 
     Returns:
         str: A string containing dots (representing hierarchy levels) if `hide_hierarchy_ui` is False,
@@ -968,6 +1064,8 @@ def tree_hierarchy_ui_representation(tree_depth, hide_hierarchy_ui):
     """
     if hide_hierarchy_ui or tree_depth == 0:
         return ""
+    if isinstance(base_depth, int):  # may be an empty string
+        tree_depth = tree_depth[base_depth:]
     ui_representation = " ".join(['<i class="mdi mdi-circle-small"></i>' for _ in tree_depth])
     return mark_safe(ui_representation)  # noqa: S308 # suspicious-mark-safe-usage, OK here since its just the `i` tag
 

nautobot/core/templatetags/ui_framework.py

@@ -0,0 +1,40 @@
+from django import template
+from django.utils.html import format_html_join
+
+from nautobot.core.utils.lookup import get_view_for_model
+from nautobot.core.views.utils import get_obj_from_context
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def render_tabs_labels(context, tabs):
+    """Render the tab labels for each Tab in the given `tabs` with the given `context`."""
+    if tabs is not None:
+        return format_html_join("\n", "{}", ([tab.render_label_wrapper(context)] for tab in tabs))
+    return ""
+
+
+@register.simple_tag(takes_context=True)
+def render_components(context, components):
+    """Render each component in the given `components` with the given `context`."""
+    if components is not None:
+        return format_html_join("\n", "{}", ([component.render(context)] for component in components))
+    return ""
+
+
+@register.simple_tag(takes_context=True)
+def render_detail_view_extra_buttons(context):
+    """
+    Render the "extra_buttons" if any from the base detail view associated with the context object.
+
+    This makes it possible for "extra" tabs (such as Changelog and Notes, and any added by App TemplateExtensions)
+    to automatically still render any `extra_buttons` defined by the base detail view, without the tab-specific views
+    needing to explicitly inherit from the base view.
+    """
+    obj = get_obj_from_context(context)
+    base_detail_view = get_view_for_model(obj)
+    object_detail_content = getattr(base_detail_view, "object_detail_content", None)
+    if object_detail_content is not None and object_detail_content.extra_buttons:
+        return render_components(context, object_detail_content.extra_buttons)
+    return ""

nautobot/core/testing/__init__.py

@@ -21,23 +21,23 @@ from nautobot.extras.models import Job, JobResult
 __all__ = (
     "APITestCase",
     "APIViewTestCases",
+    "FilterTestCases",
+    "JobClassInfo",
+    "ModelTestCase",
+    "ModelViewTestCase",
+    "NautobotTestCaseMixin",
+    "NautobotTestClient",
+    "TestCase",
+    "ViewTestCases",
     "create_job_result_and_run_job",
     "create_test_user",
     "disable_warnings",
     "extract_form_failures",
     "extract_page_body",
-    "FilterTestCases",
     "get_deletable_objects",
     "get_job_class_and_model",
-    "JobClassInfo",
-    "ModelTestCase",
-    "ModelViewTestCase",
-    "NautobotTestCaseMixin",
-    "NautobotTestClient",
     "post_data",
     "run_job_for_testing",
-    "TestCase",
-    "ViewTestCases",
 )
 
 # Use the proper swappable User model