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

nautobot/core/ui/titles.py

@@ -0,0 +1,127 @@
+from typing import Literal, Optional
+
+from django.template import Context, Template
+from django.utils.html import strip_tags
+
+DEFAULT_TITLES: dict[str, str] = {
+    "list": "{{ verbose_name_plural|bettertitle }}",
+    "detail": "{{ object.display|default:object }}",
+    "retrieve": "{{ object.display|default:object }}",
+    "destroy": "Delete {{ verbose_name }}?",
+    "create": "Add a new {{ verbose_name }}",
+    "update": "Editing {{ verbose_name }} {{ object.display|default:object }}",
+    "bulk_destroy": "Delete {{ total_objs_to_delete }} {{ verbose_name_plural|bettertitle }}?",
+    "bulk_rename": "Renaming {{ selected_objects|length }} {{ verbose_name_plural|bettertitle }} on {{ parent_name }}",
+    "bulk_update": "Editing {{ objs_count }} {{ verbose_name_plural|bettertitle }}",
+    "changelog": "{{ object.display|default:object }} - Change Log",
+    "notes": "{{ object.display|default:object }} - Notes",
+    "approve": "Approve {{ verbose_name|bettertitle }}?",
+    "deny": "Deny {{ verbose_name|bettertitle }}?",
+}
+
+DEFAULT_PLUGINS = ["helpers"]
+
+ModeType = Literal["html", "plain"]
+
+
+class Titles:
+    """
+    Base class for document titles and page headings.
+
+    This class provides a mechanism to define per-action title templates.
+    Titles can be dynamically rendered using context variables and template tags using the Django template engine and context.
+    Use the `render()` method to obtain either rich (HTML) or plain (stripped of HTML) output.
+
+    There is a dedicated simple tag to render `Titles` passed in the `context['view_titles']`: `{% render_title mode="html" %}`
+
+    Attributes:
+        titles (dict[str, str]): Action-to-title-template mapping.
+        template_plugins (list[str]): List of Django template libraries to load before rendering.
+
+    Args:
+        template_plugins (Optional[list[str]]): Template libraries to load into rendering.
+        titles (dict): Action-to-template-string mappings that override or extend the defaults.
+    """
+
+    def __init__(self, template_plugins: Optional[list[str]] = None, titles: Optional[dict[str, str]] = None):
+        """
+        Keyword arguments passed can either add new action-title pair or override existing titles.
+
+        Args:
+            template_plugins (Optional[list[str]]): Extra Django template libraries to load before rendering.
+            titles (Optional[dict[str, str]]): Custom or overriding mappings from action to template string.
+        """
+        self.titles: dict[str, str] = DEFAULT_TITLES.copy()
+        if titles:
+            self.titles.update(**titles)
+
+        self.template_plugins: list[str] = DEFAULT_PLUGINS.copy()
+        if template_plugins:
+            self.template_plugins.extend(template_plugins)
+
+    def render(self, context: Context, mode: ModeType = "html") -> str:
+        """
+        Renders the title based on given context and current action.
+
+        If mode == "plain", the output will be stripped of HTML tags.
+
+        Make sure that needed context variables are in context and needed plugins are loaded.
+
+        Args:
+            context (Context): Render context.
+            mode (ModeType): Rendering mode: "html" or "plain".
+
+        Returns:
+            (str): HTML fragment or plain text, depending on `mode`.
+        """
+        with context.update(self.get_extra_context(context)):
+            template_str = self.get_template_str(context)
+            template = Template(self.template_plugins_str + template_str)
+            rendered_title = template.render(context)
+            if mode == "plain":
+                return strip_tags(rendered_title)
+            return rendered_title
+
+    def get_template_str(self, context: Context) -> str:
+        """
+        Determine the template string for the current action.
+
+        Args:
+            context (Context): Render context.
+
+        Returns:
+            str: The template string for the current action, or an empty string if not found.
+        """
+        action = context.get("view_action", "list")
+
+        template_str = self.titles.get(action)
+        if template_str:
+            return template_str
+
+        detail = context.get("detail", False)
+        if detail:
+            return self.titles.get("detail", "")
+
+        return ""
+
+    @property
+    def template_plugins_str(self) -> str:
+        """
+        Return a concatenated string of Django {% load ... %} tags for all template plugins.
+
+        Returns:
+            str: String containing {% load ... %} tags for the required template libraries.
+        """
+        return "".join(f"{{% load {plugin_name} %}}" for plugin_name in self.template_plugins)
+
+    def get_extra_context(self, context: Context) -> dict:
+        """
+        Provide additional data to include in the rendering context, based on the configuration of this component.
+
+        Args:
+            context (Context): The current template context.
+
+        Returns:
+            (dict): Additional context data.
+        """
+        return {}

nautobot/core/ui/utils.py

@@ -1,3 +1,6 @@
+from typing import Optional
+
+from django.db.models import Model
 from django.template import Context
 from django.template.loader import get_template
 
@@ -34,3 +37,25 @@ def render_component_template(template_path: str, context: Context, **kwargs) ->
     """
     with context.update(kwargs):
         return get_template(template_path).render(flatten_context(context))
+
+
+def get_absolute_url(value: Optional[Model]) -> str:
+    """
+    Function to retrieve just absolute url to the given model instance.
+
+    Args:
+        value (Optional[django.db.models.Model]): Instance of a Django model or None.
+
+    Returns:
+        (str): url to the object if it defines get_absolute_url(), empty string otherwise.
+    """
+    if value is None:
+        return ""
+
+    if hasattr(value, "get_absolute_url"):
+        try:
+            return value.get_absolute_url()
+        except AttributeError:
+            return ""
+
+    return ""

nautobot/core/utils/migrations.py

@@ -21,7 +21,7 @@ def check_for_duplicates_with_natural_key_fields_in_migration(model_class, natur
     if duplicate_records.exists():
         if len(natural_key_fields) > 1:
             print(
-                f"    Duplicate {model_class.__name__} attributes '{*natural_key_fields,}' detected: {list(duplicate_records.values_list(*natural_key_fields))}",
+                f"    Duplicate {model_class.__name__} attributes '{(*natural_key_fields,)}' detected: {list(duplicate_records.values_list(*natural_key_fields))}",
                 file=sys.stderr,
             )
         else:

nautobot/core/views/__init__.py

@@ -70,7 +70,7 @@ class HomeView(AccessMixin, TemplateView):
                 context[key] = data
 
         # Create standalone template
-        path = f'{details["template_path"]}{details["custom_template"]}'
+        path = f"{details['template_path']}{details['custom_template']}"
         if os.path.isfile(path):
             with open(path, "r") as f:
                 html = f.read()

nautobot/core/views/mixins.py

@@ -41,6 +41,8 @@ from nautobot.core.forms import (
     restrict_form_fields,
 )
 from nautobot.core.jobs import BulkDeleteObjects, BulkEditObjects
+from nautobot.core.ui.breadcrumbs import Breadcrumbs
+from nautobot.core.ui.titles import Titles
 from nautobot.core.utils import filtering, lookup, permissions
 from nautobot.core.utils.requests import get_filterable_params_from_filter_params, normalize_querydict
 from nautobot.core.views.renderers import NautobotHTMLRenderer
@@ -242,6 +244,22 @@ class NautobotViewSetMixin(GenericViewSet, AccessMixin, GetReturnURLMixin, FormV
     # custom view attributes used for permission checks and handling
     custom_view_base_action = None
     custom_view_additional_permissions = None
+    view_titles = None
+    breadcrumbs = None
+
+    def get_view_titles(self):
+        return self.instantiate_if_needed(self.view_titles, Titles)
+
+    def get_breadcrumbs(self):
+        return self.instantiate_if_needed(self.breadcrumbs, Breadcrumbs)
+
+    @staticmethod
+    def instantiate_if_needed(attr, default_cls):
+        if attr is None:
+            return default_cls()
+        if isinstance(attr, type):
+            return attr()
+        return attr
 
     def get_permissions_for_model(self, model, actions):
         """
@@ -868,7 +886,7 @@ class ObjectEditViewMixin(NautobotViewSetMixin, mixins.CreateModelMixin, mixins.
             if hasattr(form, "save_note") and callable(form.save_note):
                 form.save_note(instance=obj, user=request.user)
 
-            msg = f'{"Created" if object_created else "Modified"} {queryset.model._meta.verbose_name}'
+            msg = f"{'Created' if object_created else 'Modified'} {queryset.model._meta.verbose_name}"
             self.logger.info(f"{msg} {obj} (PK: {obj.pk})")
             try:
                 msg = format_html(
@@ -1142,6 +1160,9 @@ class ObjectBulkDestroyViewMixin(NautobotViewSetMixin, BulkDestroyModelMixin, Bu
                     f"No {queryset.model._meta.verbose_name_plural} were selected for deletion.",
                 )
                 return redirect(self.get_return_url(request))
+            # Hide actions column in the table for bulk destroy view
+            if "actions" in table.columns:
+                table.columns.hide("actions")
 
         data.update(
             {
@@ -1338,6 +1359,10 @@ class ObjectBulkUpdateViewMixin(NautobotViewSetMixin, BulkUpdateModelMixin, Bulk
                     f"No {queryset.model._meta.verbose_name_plural} were selected to update.",
                 )
                 return redirect(self.get_return_url(request))
+
+            # Hide actions column in the table for bulk update view
+            if "actions" in table.columns:
+                table.columns.hide("actions")
         data.update(
             {
                 "table": table,

nautobot/core/views/renderers.py

@@ -228,7 +228,7 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
                     if view.filterset is not None:
                         filterset_filters = view.filterset.filters
                     else:
-                        filterset_filters = view.filterset.get_filters()
+                        filterset_filters = view.filterset_class.get_filters()
                     display_filter_params = [
                         check_filter_for_display(filterset_filters, field_name, values)
                         for field_name, values in view.filter_params.items()
@@ -279,6 +279,7 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
 
         context = {
             "content_type": content_type,
+            "model": model,
             "form": form,
             "filter_form": filter_form,
             "dynamic_filter_form": self.get_dynamic_filter_form(view, request, filterset_class=view.filterset_class),
@@ -294,7 +295,13 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
             "table_config_form": TableConfigForm(table=table) if table else None,
             "verbose_name": queryset.model._meta.verbose_name,
             "verbose_name_plural": queryset.model._meta.verbose_name_plural,
+            "view_action": view.action,
+            "detail": False,
         }
+
+        self._set_context_from_method(view, "get_view_titles", context, "view_titles")
+        self._set_context_from_method(view, "get_breadcrumbs", context, "breadcrumbs")
+
         if view.detail:
             # If we are in a retrieve related detail view (retrieve and custom actions).
             try:
@@ -316,7 +323,6 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
             new_changes_not_applied = view_changes_not_saved(request, view, self.saved_view)
             context.update(
                 {
-                    "model": model,
                     "current_saved_view": self.saved_view,
                     "new_changes_not_applied": new_changes_not_applied,
                     "action_buttons": valid_actions,
@@ -364,3 +370,15 @@ class NautobotHTMLRenderer(renderers.BrowsableAPIRenderer):
         self.template = data.get("template", view.get_template_name())
 
         return super().render(data, accepted_media_type=accepted_media_type, renderer_context=renderer_context)
+
+    @staticmethod
+    def _set_context_from_method(
+        view,
+        view_function,
+        context,
+        context_key,
+    ):
+        try:
+            context[context_key] = getattr(view, view_function)()
+        except AttributeError:
+            context[context_key] = None

nautobot/core/views/utils.py

@@ -134,13 +134,13 @@ def get_csv_form_fields_from_serializer_class(serializer_class):
                     "help_text": cf_form_field.help_text,
                 }
                 if cf.type == CustomFieldTypeChoices.TYPE_BOOLEAN:
-                    field_info["format"] = mark_safe("<code>true</code> or <code>false</code>")  # noqa: S308
+                    field_info["format"] = mark_safe("<code>true</code> or <code>false</code>")
                 elif cf.type == CustomFieldTypeChoices.TYPE_DATE:
-                    field_info["format"] = mark_safe("<code>YYYY-MM-DD</code>")  # noqa: S308
+                    field_info["format"] = mark_safe("<code>YYYY-MM-DD</code>")
                 elif cf.type == CustomFieldTypeChoices.TYPE_SELECT:
                     field_info["choices"] = {value: value for value in cf.choices}
                 elif cf.type == CustomFieldTypeChoices.TYPE_MULTISELECT:
-                    field_info["format"] = mark_safe('<code>"value,value"</code>')  # noqa: S308
+                    field_info["format"] = mark_safe('<code>"value,value"</code>')
                     field_info["choices"] = {value: value for value in cf.choices}
                 fields.append(field_info)
             continue
@@ -153,29 +153,29 @@ def get_csv_form_fields_from_serializer_class(serializer_class):
             "help_text": field.help_text,
         }
         if isinstance(field, serializers.BooleanField):
-            field_info["format"] = mark_safe("<code>true</code> or <code>false</code>")  # noqa: S308
+            field_info["format"] = mark_safe("<code>true</code> or <code>false</code>")
         elif isinstance(field, serializers.DateField):
-            field_info["format"] = mark_safe("<code>YYYY-MM-DD</code>")  # noqa: S308
+            field_info["format"] = mark_safe("<code>YYYY-MM-DD</code>")
         elif isinstance(field, TimeZoneSerializerField):
-            field_info["format"] = mark_safe(  # noqa: S308
+            field_info["format"] = mark_safe(
                 '<a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">available options</a>'
             )
         elif isinstance(field, serializers.ManyRelatedField):
             if field.field_name == "tags":
-                field_info["format"] = mark_safe('<code>"name,name"</code> or <code>"UUID,UUID"</code>')  # noqa: S308
+                field_info["format"] = mark_safe('<code>"name,name"</code> or <code>"UUID,UUID"</code>')
             elif isinstance(field.child_relation, ContentTypeField):
-                field_info["format"] = mark_safe('<code>"app_label.model,app_label.model"</code>')  # noqa: S308
+                field_info["format"] = mark_safe('<code>"app_label.model,app_label.model"</code>')
             else:
                 field_info["foreign_key"] = field.child_relation.queryset.model._meta.label_lower
-                field_info["format"] = mark_safe('<code>"UUID,UUID"</code> or combination of fields')  # noqa: S308
+                field_info["format"] = mark_safe('<code>"UUID,UUID"</code> or combination of fields')
         elif isinstance(field, serializers.RelatedField):
             if isinstance(field, ContentTypeField):
-                field_info["format"] = mark_safe("<code>app_label.model</code>")  # noqa: S308
+                field_info["format"] = mark_safe("<code>app_label.model</code>")
             else:
                 field_info["foreign_key"] = field.queryset.model._meta.label_lower
-                field_info["format"] = mark_safe("<code>UUID</code> or combination of fields")  # noqa: S308
+                field_info["format"] = mark_safe("<code>UUID</code> or combination of fields")
         elif isinstance(field, (serializers.ListField, serializers.MultipleChoiceField)):
-            field_info["format"] = mark_safe('<code>"value,value"</code>')  # noqa: S308
+            field_info["format"] = mark_safe('<code>"value,value"</code>')
         elif isinstance(field, (serializers.DictField, serializers.JSONField)):
             pass  # Not trivial to specify a format as it could be a JSON dict or a comma-separated string
 
@@ -348,6 +348,7 @@ def common_detail_view_context(request, instance):
     created_by, last_updated_by = get_created_and_last_updated_usernames_for_model(instance)
     context["created_by"] = created_by
     context["last_updated_by"] = last_updated_by
+    context["detail"] = True
 
     if getattr(instance, "is_contact_associable_model", False):
         paginate = {"paginator_class": EnhancedPaginator, "per_page": get_paginate_count(request)}

nautobot/dcim/api/serializers.py

@@ -35,11 +35,14 @@ from nautobot.dcim.choices import (
     InterfaceRedundancyGroupProtocolChoices,
     InterfaceTypeChoices,
     PortTypeChoices,
+    PowerFeedBreakerPoleChoices,
     PowerFeedPhaseChoices,
     PowerFeedSupplyChoices,
     PowerFeedTypeChoices,
     PowerOutletFeedLegChoices,
     PowerOutletTypeChoices,
+    PowerPanelTypeChoices,
+    PowerPathChoices,
     PowerPortTypeChoices,
     RackDimensionUnitChoices,
     RackElevationDetailRenderChoices,
@@ -971,6 +974,8 @@ class VirtualChassisSerializer(TaggedModelSerializerMixin, NautobotModelSerializ
 
 
 class PowerPanelSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
+    panel_type = ChoiceField(choices=PowerPanelTypeChoices, allow_blank=True, required=False)
+    power_path = ChoiceField(choices=PowerPathChoices, allow_blank=True, required=False)
     power_feed_count = serializers.IntegerField(read_only=True)
 
     class Meta:
@@ -985,8 +990,12 @@ class PowerFeedSerializer(
     NautobotModelSerializer,
 ):
     type = ChoiceField(choices=PowerFeedTypeChoices, default=PowerFeedTypeChoices.TYPE_PRIMARY)
+    power_path = ChoiceField(choices=PowerPathChoices, allow_blank=True, required=False)
     supply = ChoiceField(choices=PowerFeedSupplyChoices, default=PowerFeedSupplyChoices.SUPPLY_AC)
     phase = ChoiceField(choices=PowerFeedPhaseChoices, default=PowerFeedPhaseChoices.PHASE_SINGLE)
+    breaker_pole_count = ChoiceField(
+        choices=PowerFeedBreakerPoleChoices, allow_blank=True, allow_null=True, required=False
+    )
 
     class Meta:
         model = PowerFeed

nautobot/dcim/choices.py

@@ -1371,6 +1371,37 @@ class CableLengthUnitChoices(ChoiceSet):
     )
 
 
+#
+# Power Panels
+#
+
+
+class PowerPanelTypeChoices(ChoiceSet):
+    TYPE_UTILITY = "utility"
+    TYPE_GENERATOR = "generator"
+    TYPE_SWITCHGEAR = "switchgear"
+    TYPE_MDP = "mdp"
+    TYPE_UPS = "ups"
+    TYPE_TRANSFER_SWITCH = "transfer-switch"
+    TYPE_PDU = "pdu"
+    TYPE_PANELBOARD = "panelboard"
+    TYPE_MLC = "mlc"
+    TYPE_RPP = "rpp"
+
+    CHOICES = (
+        (TYPE_UTILITY, "Utility"),
+        (TYPE_GENERATOR, "Generator"),
+        (TYPE_SWITCHGEAR, "Switchgear"),
+        (TYPE_MDP, "Main Distribution Panel (MDP)"),
+        (TYPE_UPS, "Uninterruptible Power Supply (UPS)"),
+        (TYPE_TRANSFER_SWITCH, "Transfer Switch (TS)"),
+        (TYPE_PDU, "Power Distribution Unit (PDU)"),
+        (TYPE_PANELBOARD, "Panelboard"),
+        (TYPE_MLC, "Mini Load Center (MLC)"),
+        (TYPE_RPP, "Remote Power Panel (RPP)"),
+    )
+
+
 #
 # PowerFeeds
 #
@@ -1405,6 +1436,16 @@ class PowerFeedTypeChoices(ChoiceSet):
     }
 
 
+class PowerPathChoices(ChoiceSet):
+    PATH_A = "a"
+    PATH_B = "b"
+
+    CHOICES = (
+        (PATH_A, "Path A"),
+        (PATH_B, "Path B"),
+    )
+
+
 class PowerFeedSupplyChoices(ChoiceSet):
     SUPPLY_AC = "ac"
     SUPPLY_DC = "dc"
@@ -1425,6 +1466,18 @@ class PowerFeedPhaseChoices(ChoiceSet):
     )
 
 
+class PowerFeedBreakerPoleChoices(ChoiceSet):
+    POLE_1 = 1
+    POLE_2 = 2
+    POLE_3 = 3
+
+    CHOICES = [
+        (POLE_1, "1-Pole"),
+        (POLE_2, "2-Pole"),
+        (POLE_3, "3-Pole"),
+    ]
+
+
 #
 # Device Redundancy Groups
 #

nautobot/dcim/filters/__init__.py

@@ -1639,10 +1639,14 @@ class PowerPanelFilterSet(LocatableModelFilterSetMixin, NautobotFilterSet):
         field_name="power_feeds",
         label="Has power feeds",
     )
+    has_feeders = RelatedMembershipBooleanFilter(
+        field_name="feeders",
+        label="Has feeders",
+    )
 
     class Meta:
         model = PowerPanel
-        fields = ["id", "name", "tags"]
+        fields = ["id", "name", "panel_type", "power_path", "tags"]
 
 
 class PowerFeedFilterSet(
@@ -1652,8 +1656,7 @@ class PowerFeedFilterSet(
     StatusModelFilterSetMixin,
 ):
     q = SearchFilter(filter_predicates={"name": "icontains", "comments": "icontains"})
-    # TODO: Why is this not using TreeNodeMultiple...
-    location = NaturalKeyOrPKMultipleChoiceFilter(
+    location = TreeNodeMultipleChoiceFilter(
         prefers_id=True,
         field_name="power_panel__location",
         queryset=Location.objects.all(),
@@ -1667,6 +1670,12 @@ class PowerFeedFilterSet(
         to_field_name="name",
         label="Power panel (name or ID)",
     )
+    destination_panel = NaturalKeyOrPKMultipleChoiceFilter(
+        prefers_id=True,
+        queryset=PowerPanel.objects.all(),
+        to_field_name="name",
+        label="Destination panel (name or ID)",
+    )
     # TODO: solve https://github.com/nautobot/nautobot/issues/2875 to use this filter correctly
     rack = NaturalKeyOrPKMultipleChoiceFilter(
         prefers_id=True,
@@ -1682,11 +1691,14 @@ class PowerFeedFilterSet(
             "name",
             "status",
             "type",
+            "power_path",
             "supply",
             "phase",
             "voltage",
             "amperage",
             "max_utilization",
+            "breaker_position",
+            "breaker_pole_count",
             "comments",
             "available_power",
             "tags",