nautobot 2.4.11__py3-none-any.whl → 2.4.12__py3-none-any.whl

nautobot/extras/jobs_ui.py

@@ -0,0 +1,208 @@
+from django.template import Context
+from django.template.loader import render_to_string
+from django.utils.html import format_html, format_html_join
+from django.utils.safestring import mark_safe
+
+from nautobot.core.templatetags import helpers
+from nautobot.core.ui.object_detail import Button, KeyValueTablePanel, ObjectFieldsPanel
+from nautobot.core.views.utils import get_obj_from_context
+
+
+class JobRunScheduleButton(Button):
+    """
+    A custom button for running or scheduling a job.
+
+    This button is rendered only if the user has the 'extras.run_job' permission.
+    It also disables itself (via HTML 'disabled' attribute) if the related object is not
+    installed or not enabled.
+    """
+
+    def get_extra_context(self, context):
+        """Inject dynamic attributes (e.g. 'disabled') based on object state into the rendering context."""
+        extra_context = super().get_extra_context(context)
+        obj = context.get("object")
+        if not obj.installed or not obj.enabled:
+            if extra_context["attributes"] is None:
+                extra_context["attributes"] = {}
+            extra_context["attributes"]["disabled"] = "disabled"
+        return extra_context
+
+
+class JobKeyValueOverrideValueTablePanel(KeyValueTablePanel):
+    """A table panel for displaying key-value pairs of job-related attributes, along with any override values defined on the job object."""
+
+    def _render_overridden_text(self, text):
+        """
+        Render a simple overridden value inside a muted <span>, with a customizable prefix.
+
+        Args:
+            value (str): The content to display.
+            prefix (str): The label shown before the value (default: 'default is').
+        """
+        return format_html('<span class="text-muted">overridden; default is {}</span>', mark_safe(text))  # noqa: S308
+
+    def _render_overridden_block(self, content):
+        """
+        Render a more complex block of HTML content (like rendered markdown or JSON)
+        in a div with a muted label indicating it's an overridden value.
+        """
+        return format_html('<div class="text-muted">overridden; default is:<br>{}</div>', content)
+
+    def render_description_default(self, default_value):
+        """
+        Render a description field's default value as markdown.
+
+        If the default value is a string, it is rendered as markdown;
+        otherwise, a placeholder is shown.
+        """
+        rendered = (
+            helpers.render_markdown(default_value)
+            if isinstance(default_value, str)
+            else helpers.placeholder(default_value)
+        )
+        return self._render_overridden_block(rendered)
+
+    def render_time_limit_default(self, default_value, system_default_value, override=True):
+        """
+        Render a time limit value, falling back to the system default if needed.
+        """
+        message = "{} seconds" if default_value > 0 else "{} seconds (system default)"
+        value = default_value if default_value > 0 else system_default_value
+        if not override:
+            return message.format(value)
+        return self._render_overridden_text(message.format(value))
+
+    def render_job_queues_default(self, obj):
+        """
+        Render the job's default task queues as JSON.
+
+        Attempts to retrieve the `task_queues` from the job's class and render
+        it using a JSON template. Falls back to a placeholder on error.
+        """
+        try:
+            data = obj.job_class.task_queues
+            rendered = render_to_string("extras/inc/json_data.html", {"data": data, "format": "json"})
+        except Exception:
+            rendered = helpers.placeholder(None)
+        return self._render_overridden_block(rendered)
+
+    def render_default_job_queue_default(self, obj):
+        """
+        Render the default job queue name from the job class.
+
+        Retrieves the first queue from `task_queues` if available.
+        Falls back to a placeholder if no queues are present.
+        """
+        try:
+            queue = obj.job_class.task_queues[0]
+        except (AttributeError, IndexError, TypeError):
+            queue = helpers.placeholder("not specified")
+        return self._render_overridden_text(queue)
+
+    def render_boolean_default(self, default_value):
+        """Render a boolean default value using a standardized visual format."""
+        return self._render_overridden_text(helpers.render_boolean(default_value))
+
+    def render_override_value(self, key, obj):
+        """Render the override value for a given key on a job object."""
+        override_attr = f"{key}_override"
+
+        if not getattr(obj, override_attr, None):
+            return ""
+
+        if not obj.installed:
+            return self._render_overridden_text("default is unknown (not currently installed)")
+
+        try:
+            default_value = getattr(obj.job_class, key)
+        except Exception:
+            default_value = "unknown"
+
+        renderers = {
+            "description": self.render_description_default,
+            "soft_time_limit": lambda v: self.render_time_limit_default(
+                v, helpers.settings_or_config("CELERY_TASK_SOFT_TIME_LIMIT")
+            ),
+            "time_limit": lambda v: self.render_time_limit_default(
+                v, helpers.settings_or_config("CELERY_TASK_TIME_LIMIT")
+            ),
+            "job_queues": lambda _: self.render_job_queues_default(obj),
+            "default_job_queue": lambda _: self.render_default_job_queue_default(obj),
+        }
+
+        if key in renderers:
+            return renderers[key](default_value)
+
+        if isinstance(default_value, bool):
+            return self.render_boolean_default(default_value)
+
+        return self._render_overridden_text(f'"{default_value}"')
+
+    def render_job_queues_list(self, value):
+        """Renders a <ul> HTML list of job queues with hyperlinks, or a placeholder if none exist."""
+        if not value or not value.exists():
+            return helpers.placeholder(None)
+
+        items = format_html_join("\n", "<li>{}</li>", ((helpers.hyperlinked_object(q),) for q in value.all()))
+        return format_html("<ul>{}</ul>", items)
+
+    def render_body_content(self, context: Context):
+        """Render the body content of the panel as a table of key-value rows, including any override information."""
+        data = self.get_data(context)
+        obj = get_obj_from_context(context)
+
+        if not data:
+            return format_html('<tr><td colspan="2">{}</td></tr>', helpers.placeholder(data))
+
+        result = format_html("")
+        panel_label = helpers.slugify(self.label or "")
+        for key, value in data.items():
+            key_display = self.render_key(key, value, context)
+            override_value_display = self.render_override_value(key, obj)
+            if value_display := self.render_value(key, value, context):
+                if value_display is helpers.HTML_NONE:
+                    value_tag = value_display
+                else:
+                    value_tag = format_html(
+                        """
+                            <span class="hover_copy">
+                                <span id="{unique_id}_value_{key}">{value}</span>
+                                <button class="btn btn-inline btn-default hover_copy_button" data-clipboard-target="#{unique_id}_value_{key}">
+                                    <span class="mdi mdi-content-copy"></span>
+                                </button>
+                            </span>
+                        """,
+                        # key might not be globally unique in a page, but is unique to a panel;
+                        # Hence we add the panel label to make it globally unique to the page
+                        unique_id=panel_label,
+                        key=helpers.slugify(key),
+                        value=value_display,
+                    )
+                result += format_html(
+                    "<tr><td>{}</td><td>{}</td><td>{}</td></tr>",
+                    key_display,
+                    value_tag,
+                    override_value_display,
+                )
+
+        return result
+
+
+class JobObjectFieldsPanel(ObjectFieldsPanel, JobKeyValueOverrideValueTablePanel):
+    """
+    ObjectFieldsPanel that renders its fields in a 3-column layout.
+    Inherits behavior from ObjectFieldsPanel but overrides rendering with JobKeyValueOverrideValueTablePanel.
+    """
+
+    def render_value(self, key, value, context: Context):
+        if key == "job_queues":
+            return self.render_job_queues_list(value)
+        if key == "soft_time_limit":
+            value = self.render_time_limit_default(
+                value, helpers.settings_or_config("CELERY_TASK_SOFT_TIME_LIMIT"), override=False
+            )
+        if key == "time_limit":
+            value = self.render_time_limit_default(
+                value, helpers.settings_or_config("CELERY_TASK_TIME_LIMIT"), override=False
+            )
+        return super().render_value(key, value, context)

nautobot/extras/models/tags.py

@@ -1,5 +1,6 @@
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
+from django.utils.html import format_html
 from taggit.models import GenericUUIDTaggedItemBase
 
 from nautobot.core.choices import ColorChoices
@@ -65,6 +66,9 @@ class Tag(
     class Meta:
         ordering = ["name"]
 
+    def get_color_display(self):
+        return format_html('<span class="label color-block" style="background-color: #{}">&nbsp;</span>', self.color)
+
     def validate_content_types_removal(self, content_types_id):
         """Validate content_types to be removed are not tagged to a model"""
         errors = {}

nautobot/extras/tables.py

@@ -908,7 +908,7 @@ class JobResultTable(BaseTable):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         # Only calculate log counts for "summary" column if it's actually visible.
-        if self.columns["summary"].visible and isinstance(self.data.data, QuerySet):
+        if "summary" in self.columns and self.columns["summary"].visible and isinstance(self.data.data, QuerySet):
             self.data = TableData.from_data(
                 self.data.data.annotate(
                     debug_log_count=count_related(

nautobot/extras/templates/extras/configcontextschema_retrieve.html

@@ -39,10 +39,10 @@
             <div class="panel panel-default">
                 <div class="panel-heading">
                     <strong>Data Schema</strong>
-                    {% include 'extras/inc/json_format.html' %}
+                    {% include 'extras/inc/configcontext_format.html' %}
                 </div>
                 <div class="panel-body">
-                    {% include 'extras/inc/json_data.html' with data=object.data_schema format=format %}
+                    {% include 'extras/inc/json_data.html' with data=object.data_schema format=data_format %}
                 </div>
             </div>
 {% endblock content_right_page %}

nautobot/extras/templates/extras/inc/configcontext_data.html

@@ -1 +1 @@
-{% include 'extras/inc/json_data.html' with data=object.data format=format %}
+{% include 'extras/inc/json_data.html' with data=object.data format=data_format %}

nautobot/extras/templates/extras/inc/configcontext_format.html

@@ -0,0 +1,6 @@
+<div class="pull-right">
+    <div class="btn-group btn-group-xs" role="group">
+        <a href="?data_format=json" class="btn btn-default{% if data_format == 'json' %} active{% endif %}">JSON</a>
+        <a href="?data_format=yaml" class="btn btn-default{% if data_format == 'yaml' %} active{% endif %}">YAML</a>
+    </div>
+</div>

nautobot/extras/templates/extras/inc/json_data.html

@@ -1,5 +1,5 @@
 {% load helpers %}
 
 <div class="rendered-json-data">
-    <pre>{% if data_format == 'json' %}{{ data|render_json }}{% elif data_format == 'yaml' %}{{ data|render_yaml }}{% else %}{{ data }}{% endif %}</pre>
+    <pre>{% if format == 'json' %}{{ data|render_json }}{% elif format == 'yaml' %}{{ data|render_yaml }}{% else %}{{ data }}{% endif %}</pre>
 </div>

nautobot/extras/templates/extras/inc/json_format.html

@@ -1,6 +1,6 @@
 <div class="pull-right">
     <div class="btn-group btn-group-xs" role="group">
-        <a href="?data_format=json" class="btn btn-default{% if data_format == 'json' %} active{% endif %}">JSON</a>
-        <a href="?data_format=yaml" class="btn btn-default{% if data_format == 'yaml' %} active{% endif %}">YAML</a>
+        <a href="?format=json" class="btn btn-default{% if format == 'json' %} active{% endif %}">JSON</a>
+        <a href="?format=yaml" class="btn btn-default{% if format == 'yaml' %} active{% endif %}">YAML</a>
     </div>
 </div>

nautobot/extras/templates/extras/job_detail.html

@@ -1,327 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-{% load perms %}
-{% load plugins %}
-
-{% block extra_breadcrumbs %}
-    <li>{{ object.grouping }}</li>
-{% endblock extra_breadcrumbs %}
-
-{% block extra_buttons %}
-    {% if perms.extras.run_job %}
-        <a href="{% url 'extras:job_run' pk=object.pk %}" class="btn btn-primary"
-           {% if not object.installed or not object.enabled %}disabled="disabled"{% endif %}>
-            <i class="mdi mdi-play" aria-hidden="true"></i> Run/Schedule
-        </a>
-    {% endif %}
-{% endblock extra_buttons %}
-
-{% block content_left_page %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Source Code</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Module</td>
-                <td><code>{{ object.module_name }}</code></td>
-            </tr>
-            <tr>
-                <td>Job Class</td>
-                <td><code>{{ object.job_class_name }}</code></td>
-            </tr>
-            <tr>
-                <td>Class Path</td>
-                <td>
-                    <span class="hover_copy">
-                        <span id="job_class_path_copy"><code>{{ object.class_path }}</code></span>
-                        <button class="btn btn-inline btn-default hover_copy_button" data-clipboard-target="#job_class_path_copy">
-                            <span class="mdi mdi-content-copy"></span>
-                        </button>
-                    </span>
-                </td>
-            </tr>
-            <tr>
-                <td>Installed</td>
-                <td>{{ object.installed | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Is Job Hook Receiver</td>
-                <td>{{ object.is_job_hook_receiver | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Is Job Button Receiver</td>
-                <td>{{ object.is_job_button_receiver | render_boolean }}</td>
-            </tr>
-        </table>
-    </div>
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Job</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Grouping</td>
-                <td>{{ object.grouping }}</td>
-                <td>
-                    {% if object.grouping_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                “{{ object.job_class.grouping }}”
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Name</td>
-                <td>{{ object.name }}</td>
-                <td>
-                    {% if object.name_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                “{{ object.job_class.name }}”
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Description</td>
-                <td>{{ object.description | render_markdown | placeholder }}</td>
-                <td>
-                    {% if object.description_override %}
-                        <div class="text-muted">
-                            overridden; default is:<br>
-                            {% if object.installed %}
-                                {{ object.job_class.description | render_markdown | placeholder }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </div>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Enabled</td>
-                <td>{{ object.enabled | render_boolean }}</td>
-                <td></td>
-            </tr>
-            <tr>
-                <td>Job Results</td>
-                <td>
-                    {% if object.job_results.exists %}
-                        <a href="{% url 'extras:jobresult_list' %}?job_model={{ object.name | urlencode }}">{{ object.job_results.count }}</a>
-                    {% else %}
-                        {{ None|placeholder }}
-                    {% endif %}
-                </td>
-                <td></td>
-            </tr>
-        </table>
-    </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Properties</strong>
-        </div>
-        <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Approval Required to Execute</td>
-                <td>{{ object.approval_required | render_boolean }}</td>
-                <td>
-                    {% if object.approval_required_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.approval_required | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Supports Dryrun</td>
-                <td colspan="2">{{ object.supports_dryrun | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Default to Dryrun</td>
-                <td>{{ object.dryrun_default | render_boolean }}</td>
-                <td>
-                    {% if object.dryrun_default_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.dryrun_default | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Read-Only Execution</td>
-                <td colspan="2">{{ object.read_only | render_boolean }}</td>
-            </tr>
-            <tr>
-                <td>Hide from Default UI</td>
-                <td>{{ object.hidden | render_boolean }}</td>
-                <td>
-                    {% if object.hidden_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.hidden | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Has Sensitive Variables</td>
-                <td>{{ object.has_sensitive_variables | render_boolean }}</td>
-                <td>
-                    {% if object.has_sensitive_variables_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.has_sensitive_variables | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Is Singleton</td>
-                <td>{{ object.is_singleton | render_boolean }}</td>
-                <td>
-                    {% if object.is_singleton_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.is_singleton | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Execution Soft Time Limit</td>
-                <td>
-                    {% if object.soft_time_limit > 0 %}
-                        {{ object.soft_time_limit }} seconds
-                    {% else %}
-                        {{ "CELERY_TASK_SOFT_TIME_LIMIT" | settings_or_config }} seconds (system default)
-                    {% endif %}
-                </td>
-                <td>
-                    {% if object.soft_time_limit_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {% if object.job_class.soft_time_limit > 0 %}
-                                    {{ object.job_class.soft_time_limit }} seconds
-                                {% else %}
-                                    {{ "CELERY_TASK_SOFT_TIME_LIMIT" | settings_or_config }} seconds (system default)
-                                {% endif %}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Execution Hard Time Limit</td>
-                <td>
-                    {% if object.time_limit > 0 %}
-                        {{ object.time_limit }} seconds
-                    {% else %}
-                        {{ "CELERY_TASK_TIME_LIMIT" | settings_or_config }} seconds (system default)
-                    {% endif %}
-                </td>
-                <td>
-                    {% if object.time_limit_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {% if object.job_class.time_limit > 0 %}
-                                    {{ object.job_class.time_limit }} seconds
-                                {% else %}
-                                    {{ "CELERY_TASK_TIME_LIMIT" | settings_or_config }} seconds (system default)
-                                {% endif %}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Job Queues</td>
-                <td>
-                    {% if object.job_queues.exists %}
-                        <ul>
-                            {% for queue in object.job_queues.all %}
-                                <li>{{ queue|hyperlinked_object }}</li>
-                            {% endfor %}
-                        </ul>
-                    {% else %}
-                        {{ None|placeholder }}
-                    {% endif %}
-                </td>
-                <td>
-                    {% if object.job_queues_override %}
-                        <span class="text-muted">
-                            overridden; default is:<br>
-                            {% if object.installed %}
-                                {% include 'extras/inc/json_data.html' with data=object.job_class.task_queues format="json" %}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-            <tr>
-                <td>Default Job Queue</td>
-                <td>
-                    {{ object.default_job_queue|hyperlinked_object }}
-                </td>
-                <td>
-                    {% if object.default_job_queue_override %}
-                        <span class="text-muted">
-                            overridden; default is:
-                            {% if object.installed %}
-                                {% if object.job_class.task_queues|length > 1 %}
-                                    {{ object.job_class.task_queues.0 }}
-                                {% else %}
-                                    {{ None|placeholder }}
-                                {% endif %}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
-        </table>
-    </div>
-{% endblock content_right_page %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/extras/templates/extras/tag_retrieve.html

@@ -1,52 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Tag</strong>
-                </div>
-                <table class="table table-hover panel-body attr-table">
-                    <tr>
-                        <td>Name</td>
-                        <td>
-                            {{ object.name }}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Tagged Items</td>
-                        <td>
-                            {{ items_count }}
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Color</td>
-                        <td>
-                            <span class="label color-block" style="background-color: #{{ object.color }}">&nbsp;</span>
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Content Type(s)</td>
-                        <td>
-                            <ul class="list-unstyled">
-                                {% for ct in content_types %}
-                                    <li>{{ ct }}</li>
-                                {% endfor %}
-                            </ul>
-                        </td>
-                    </tr>
-                    <tr>
-                        <td>Description</td>
-                        <td>
-                            {{ object.description|placeholder }}
-                        </td>
-                    </tr>
-                </table>
-            </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-            {% include 'panel_table.html' with table=items_table heading='Tagged Objects' %}
-            {% include 'inc/paginator.html' with paginator=items_table.paginator page=items_table.page %}
-            <div class="row"></div>
-{% endblock content_right_page %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}