nautobot 2.3.16__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/ipam/urls.py

@@ -8,86 +8,20 @@ from .models import (
     IPAddress,
     Prefix,
     RIR,
-    RouteTarget,
     Service,
     VLAN,
     VLANGroup,
-    VRF,
 )
 
 app_name = "ipam"
 
 router = NautobotUIViewSetRouter()
-router.register("namespaces", views.NamespaceUIViewSet)
 router.register("ip-address-to-interface", views.IPAddressToInterfaceUIViewSet)
+router.register("namespaces", views.NamespaceUIViewSet)
+router.register("route-targets", views.RouteTargetUIViewSet)
+router.register("vrfs", views.VRFUIViewSet)
 
 urlpatterns = [
-    # VRFs
-    path("vrfs/", views.VRFListView.as_view(), name="vrf_list"),
-    path("vrfs/add/", views.VRFEditView.as_view(), name="vrf_add"),
-    path("vrfs/import/", views.VRFBulkImportView.as_view(), name="vrf_import"),  # 3.0 TODO: remove, unused
-    path("vrfs/edit/", views.VRFBulkEditView.as_view(), name="vrf_bulk_edit"),
-    path("vrfs/delete/", views.VRFBulkDeleteView.as_view(), name="vrf_bulk_delete"),
-    path("vrfs/<uuid:pk>/", views.VRFView.as_view(), name="vrf"),
-    path("vrfs/<uuid:pk>/edit/", views.VRFEditView.as_view(), name="vrf_edit"),
-    path("vrfs/<uuid:pk>/delete/", views.VRFDeleteView.as_view(), name="vrf_delete"),
-    path(
-        "vrfs/<uuid:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="vrf_changelog",
-        kwargs={"model": VRF},
-    ),
-    path(
-        "vrfs/<uuid:pk>/notes/",
-        ObjectNotesView.as_view(),
-        name="vrf_notes",
-        kwargs={"model": VRF},
-    ),
-    # Route targets
-    path("route-targets/", views.RouteTargetListView.as_view(), name="routetarget_list"),
-    path(
-        "route-targets/add/",
-        views.RouteTargetEditView.as_view(),
-        name="routetarget_add",
-    ),
-    path(
-        "route-targets/import/",
-        views.RouteTargetBulkImportView.as_view(),  # 3.0 TODO: remove, unused
-        name="routetarget_import",
-    ),
-    path(
-        "route-targets/edit/",
-        views.RouteTargetBulkEditView.as_view(),
-        name="routetarget_bulk_edit",
-    ),
-    path(
-        "route-targets/delete/",
-        views.RouteTargetBulkDeleteView.as_view(),
-        name="routetarget_bulk_delete",
-    ),
-    path("route-targets/<uuid:pk>/", views.RouteTargetView.as_view(), name="routetarget"),
-    path(
-        "route-targets/<uuid:pk>/edit/",
-        views.RouteTargetEditView.as_view(),
-        name="routetarget_edit",
-    ),
-    path(
-        "route-targets/<uuid:pk>/delete/",
-        views.RouteTargetDeleteView.as_view(),
-        name="routetarget_delete",
-    ),
-    path(
-        "route-targets/<uuid:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="routetarget_changelog",
-        kwargs={"model": RouteTarget},
-    ),
-    path(
-        "route-targets/<uuid:pk>/notes/",
-        ObjectNotesView.as_view(),
-        name="routetarget_notes",
-        kwargs={"model": RouteTarget},
-    ),
     # RIRs
     path("rirs/", views.RIRListView.as_view(), name="rir_list"),
     path("rirs/add/", views.RIREditView.as_view(), name="rir_add"),

nautobot/ipam/utils/__init__.py

@@ -1,3 +1,5 @@
+from collections.abc import Iterable
+
 from django.core.exceptions import ValidationError
 import netaddr
 
@@ -5,19 +7,23 @@ from nautobot.core.forms.utils import compress_range
 from nautobot.dcim.models import Interface
 from nautobot.extras.models import RelationshipAssociation
 from nautobot.ipam.choices import PrefixTypeChoices
-from nautobot.ipam.models import Prefix, VLAN
+from nautobot.ipam.models import IPAddress, Namespace, Prefix, VLAN, VLANGroup
 from nautobot.ipam.querysets import IPAddressQuerySet
 from nautobot.virtualization.models import VMInterface
 
 
-def add_available_prefixes(parent, prefix_list):
+def add_available_prefixes(parent: netaddr.IPNetwork, namespace: Namespace, prefix_list: Iterable[Prefix]):
     """
     Create fake Prefix objects for all unallocated space within a prefix.
     """
 
     # Find all unallocated space
-    available_prefixes = netaddr.IPSet(parent) ^ netaddr.IPSet([p.prefix for p in prefix_list])
-    available_prefixes = [Prefix(prefix=p, status=None) for p in available_prefixes.iter_cidrs()]
+    available_prefixes = netaddr.IPSet(parent) ^ netaddr.IPSet(
+        [p.prefix for p in prefix_list if p.type != PrefixTypeChoices.TYPE_CONTAINER or not p.descendants().exists()]
+    )
+    available_prefixes = [
+        Prefix(prefix=p, namespace=namespace, type=None, status=None) for p in available_prefixes.iter_cidrs()
+    ]
 
     # Concatenate and sort complete list of children
     prefix_list = list(prefix_list) + available_prefixes
@@ -26,14 +32,14 @@ def add_available_prefixes(parent, prefix_list):
     return prefix_list
 
 
-def get_add_available_prefixes_callback(show_available, parent):
+def get_add_available_prefixes_callback(show_available: bool, parent: Prefix):
     """Conditionally provide a callback for add_available_prefixes()."""
     if show_available:
-        return lambda prefixes: add_available_prefixes(parent.prefix, prefixes)
+        return lambda prefixes: add_available_prefixes(parent.prefix, parent.namespace, prefixes)
     return lambda prefixes: prefixes
 
 
-def add_available_ipaddresses(prefix, ipaddress_list, is_pool=False):
+def add_available_ipaddresses(prefix: netaddr.IPNetwork, ipaddress_list: Iterable[IPAddress], is_pool: bool = False):
     """
     Annotate ranges of available IP addresses within a given prefix. If is_pool is True, the first and last IP will be
     considered usable (regardless of mask length).
@@ -89,7 +95,7 @@ def add_available_ipaddresses(prefix, ipaddress_list, is_pool=False):
     return output
 
 
-def get_add_available_ipaddresses_callback(show_available, parent):
+def get_add_available_ipaddresses_callback(show_available: bool, parent: Prefix):
     """Conditionally provide a callback for add_available_ipaddresses()."""
     if show_available:
         return lambda ip_addresses: add_available_ipaddresses(
@@ -98,7 +104,7 @@ def get_add_available_ipaddresses_callback(show_available, parent):
     return lambda ip_addresses: ip_addresses
 
 
-def add_available_vlans(vlan_group, vlans):
+def add_available_vlans(vlan_group: VLANGroup, vlans: list[VLAN]):
     """
     Create fake records for all gaps between used VLANs
     """
@@ -116,7 +122,7 @@ def add_available_vlans(vlan_group, vlans):
     return vlans
 
 
-def get_add_available_vlans_callback(show_available, vlan_group):
+def get_add_available_vlans_callback(show_available: bool, vlan_group: VLANGroup):
     """Conditionally provide a callback for add_available_vlans()."""
     if show_available:
         return lambda vlans: add_available_vlans(vlan_group=vlan_group, vlans=vlans)

nautobot/ipam/views.py

@@ -18,12 +18,16 @@ from django_tables2 import RequestConfig
 import netaddr
 
 from nautobot.cloud.tables import CloudNetworkTable
+from nautobot.core.constants import MAX_PAGE_SIZE_DEFAULT
 from nautobot.core.models.querysets import count_related
+from nautobot.core.ui import object_detail
+from nautobot.core.ui.choices import SectionChoices
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.permissions import get_permission_for_model
 from nautobot.core.views import generic, mixins as view_mixins
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import handle_protectederror
+from nautobot.core.views.viewsets import NautobotUIViewSet
 from nautobot.dcim.models import Device, Interface, Location
 from nautobot.extras.models import Role, SavedView, Status, Tag
 from nautobot.ipam import choices, constants
@@ -222,95 +226,59 @@ class NamespaceVRFsView(generic.ObjectView):
 #
 
 
-class VRFListView(generic.ObjectListView):
+class VRFUIViewSet(NautobotUIViewSet):
     queryset = VRF.objects.all()
-    filterset = filters.VRFFilterSet
-    filterset_form = forms.VRFFilterForm
-    table = tables.VRFTable
-
-
-class VRFView(generic.ObjectView):
-    queryset = VRF.objects.all()
-
-    def get_extra_context(self, request, instance):
-        context = super().get_extra_context(request, instance)
-
-        prefixes = instance.prefixes.restrict(request.user, "view")
-        prefix_count = prefixes.count()
-        prefix_table = tables.PrefixTable(prefixes.select_related("namespace"), hide_hierarchy_ui=True)
-
-        # devices = instance.devices.restrict(request.user, "view")
-        # device_count = devices.count()
-        # device_table = DeviceTable(devices.all(), orderable=False)
-
-        import_targets_table = tables.RouteTargetTable(
-            instance.import_targets.select_related("tenant"), orderable=False
-        )
-        export_targets_table = tables.RouteTargetTable(
-            instance.export_targets.select_related("tenant"), orderable=False
-        )
-
-        # TODO(jathan): This table might need to live on Device and on VRFs
-        # (possibly replacing `device_table` above.
-        vrfs = instance.device_assignments.restrict(request.user, "view")
-        vrf_table = tables.VRFDeviceAssignmentTable(vrfs, exclude=["vrf"])
-        # context["vrf_table"] = vrf_table
-
-        paginate = {
-            "paginator_class": EnhancedPaginator,
-            "per_page": get_paginate_count(request),
-        }
-        RequestConfig(request, paginate).configure(prefix_table)
-        RequestConfig(request, paginate).configure(vrf_table)
-        RequestConfig(request, paginate).configure(import_targets_table)
-        RequestConfig(request, paginate).configure(export_targets_table)
-
-        context.update(
-            {
-                "device_table": vrf_table,
-                # "device_table": device_table,
-                "prefix_count": prefix_count,
-                "prefix_table": prefix_table,
-                "import_targets_table": import_targets_table,
-                "export_targets_table": export_targets_table,
-            }
-        )
-
-        return context
-
-
-class VRFEditView(generic.ObjectEditView):
-    queryset = VRF.objects.all()
-    model_form = forms.VRFForm
-    template_name = "ipam/vrf_edit.html"
-
-
-class VRFDeleteView(generic.ObjectDeleteView):
-    queryset = VRF.objects.all()
-
-
-class VRFBulkImportView(generic.BulkImportView):  # 3.0 TODO: remove, unused
-    queryset = VRF.objects.all()
-    table = tables.VRFTable
-
-
-class VRFBulkEditView(generic.BulkEditView):
-    queryset = VRF.objects.select_related("tenant")
-    filterset = filters.VRFFilterSet
-    table = tables.VRFTable
-    form = forms.VRFBulkEditForm
-
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_prefixes", None):
-            obj.prefixes.add(*form.cleaned_data["add_prefixes"])
-        if form.cleaned_data.get("remove_prefixes", None):
-            obj.prefixes.remove(*form.cleaned_data["remove_prefixes"])
-
-
-class VRFBulkDeleteView(generic.BulkDeleteView):
-    queryset = VRF.objects.select_related("tenant")
-    filterset = filters.VRFFilterSet
-    table = tables.VRFTable
+    filterset_class = filters.VRFFilterSet
+    filterset_form_class = forms.VRFFilterForm
+    table_class = tables.VRFTable
+    form_class = forms.VRFForm
+    bulk_update_form_class = forms.VRFBulkEditForm
+    serializer_class = serializers.VRFSerializer
+
+    object_detail_content = object_detail.ObjectDetailContent(
+        panels=(
+            object_detail.ObjectFieldsPanel(
+                section=SectionChoices.LEFT_HALF,
+                weight=100,
+                fields="__all__",
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.RIGHT_HALF,
+                weight=100,
+                table_class=tables.RouteTargetTable,
+                table_filter="importing_vrfs",
+                table_title="Import Route Targets",
+                add_button_route=None,
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.RIGHT_HALF,
+                weight=200,
+                table_class=tables.RouteTargetTable,
+                table_filter="exporting_vrfs",
+                table_title="Export Route Targets",
+                add_button_route=None,
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.FULL_WIDTH,
+                weight=100,
+                table_class=tables.PrefixTable,
+                table_filter="vrfs",
+                table_title="Assigned Prefixes",
+                hide_hierarchy_ui=True,
+                exclude_columns=["namespace"],
+                add_button_route=None,
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.FULL_WIDTH,
+                weight=200,
+                table_class=tables.VRFDeviceAssignmentTable,
+                table_filter="vrf",
+                table_title="Assigned Devices",
+                exclude_columns=["vrf", "namespace", "rd"],
+                add_button_route=None,
+            ),
+        ),
+    )
 
 
 #
@@ -318,59 +286,38 @@ class VRFBulkDeleteView(generic.BulkDeleteView):
 #
 
 
-class RouteTargetListView(generic.ObjectListView):
-    queryset = RouteTarget.objects.all()
-    filterset = filters.RouteTargetFilterSet
-    filterset_form = forms.RouteTargetFilterForm
-    table = tables.RouteTargetTable
-
-
-class RouteTargetView(generic.ObjectView):
-    queryset = RouteTarget.objects.all()
-
-    def get_extra_context(self, request, instance):
-        importing_vrfs_table = tables.VRFTable(instance.importing_vrfs.select_related("tenant"), orderable=False)
-        exporting_vrfs_table = tables.VRFTable(instance.exporting_vrfs.select_related("tenant"), orderable=False)
-
-        paginate = {
-            "paginator_class": EnhancedPaginator,
-            "per_page": get_paginate_count(request),
-        }
-        RequestConfig(request, paginate).configure(importing_vrfs_table)
-        RequestConfig(request, paginate).configure(exporting_vrfs_table)
-
-        return {
-            "importing_vrfs_table": importing_vrfs_table,
-            "exporting_vrfs_table": exporting_vrfs_table,
-            **super().get_extra_context(request, instance),
-        }
-
-
-class RouteTargetEditView(generic.ObjectEditView):
-    queryset = RouteTarget.objects.all()
-    model_form = forms.RouteTargetForm
-
-
-class RouteTargetDeleteView(generic.ObjectDeleteView):
-    queryset = RouteTarget.objects.all()
-
-
-class RouteTargetBulkImportView(generic.BulkImportView):  # 3.0 TODO: remove, unused
+class RouteTargetUIViewSet(NautobotUIViewSet):
     queryset = RouteTarget.objects.all()
-    table = tables.RouteTargetTable
-
-
-class RouteTargetBulkEditView(generic.BulkEditView):
-    queryset = RouteTarget.objects.select_related("tenant")
-    filterset = filters.RouteTargetFilterSet
-    table = tables.RouteTargetTable
-    form = forms.RouteTargetBulkEditForm
-
-
-class RouteTargetBulkDeleteView(generic.BulkDeleteView):
-    queryset = RouteTarget.objects.select_related("tenant")
-    filterset = filters.RouteTargetFilterSet
-    table = tables.RouteTargetTable
+    filterset_class = filters.RouteTargetFilterSet
+    filterset_form_class = forms.RouteTargetFilterForm
+    table_class = tables.RouteTargetTable
+    form_class = forms.RouteTargetForm
+    bulk_update_form_class = forms.RouteTargetBulkEditForm
+    serializer_class = serializers.RouteTargetSerializer
+
+    object_detail_content = object_detail.ObjectDetailContent(
+        panels=(
+            object_detail.ObjectFieldsPanel(
+                section=SectionChoices.LEFT_HALF,
+                weight=100,
+                fields="__all__",
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.RIGHT_HALF,
+                weight=100,
+                table_class=tables.VRFTable,
+                table_filter="import_targets",
+                table_title="Importing VRFs",
+            ),
+            object_detail.ObjectsTablePanel(
+                section=SectionChoices.RIGHT_HALF,
+                weight=200,
+                table_class=tables.VRFTable,
+                table_filter="export_targets",
+                table_title="Exporting VRFs",
+            ),
+        ),
+    )
 
 
 #
@@ -434,7 +381,6 @@ class PrefixListView(generic.ObjectListView):
     table = tables.PrefixDetailTable
     template_name = "ipam/prefix_list.html"
     queryset = Prefix.objects.all()
-    use_new_ui = True
 
 
 class PrefixView(generic.ObjectView):
@@ -447,7 +393,6 @@ class PrefixView(generic.ObjectView):
         "vlan__vlan_group",
         "namespace",
     ).prefetch_related("locations")
-    use_new_ui = True
 
     def get_extra_context(self, request, instance):
         # Parent prefixes table
@@ -492,7 +437,6 @@ class PrefixPrefixesView(generic.ObjectView):
 
         prefix_table = tables.PrefixDetailTable(
             child_prefixes,
-            hide_hierarchy_ui=True,
             exclude=["namespace"],
             data_transform_callback=data_transform_callback,
         )
@@ -516,6 +460,7 @@ class PrefixPrefixesView(generic.ObjectView):
 
         return {
             "first_available_prefix": instance.get_first_available_prefix(),
+            "base_tree_depth": instance.ancestors().count(),
             "prefix_table": prefix_table,
             "permissions": permissions,
             "bulk_querystring": bulk_querystring,
@@ -713,16 +658,6 @@ class PrefixBulkEditView(generic.BulkEditView):
     table = tables.PrefixTable
     form = forms.PrefixBulkEditForm
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_locations", None):
-            obj.locations.add(*form.cleaned_data["add_locations"])
-        if form.cleaned_data.get("remove_locations", None):
-            obj.locations.remove(*form.cleaned_data["remove_locations"])
-        if form.cleaned_data.get("add_vrfs", None):
-            obj.vrfs.add(*form.cleaned_data["add_vrfs"])
-        if form.cleaned_data.get("remove_vrfs", None):
-            obj.vrfs.remove(*form.cleaned_data["remove_vrfs"])
-
 
 class PrefixBulkDeleteView(generic.BulkDeleteView):
     queryset = Prefix.objects.all()
@@ -761,7 +696,8 @@ class IPAddressListView(generic.ObjectListView):
             except ObjectDoesNotExist:
                 pass
 
-        if table_columns and "assigned_count" in table_columns:
+        # column name is "assigned", not "assigned_count", and it's shown by default if there is no table config
+        if (table_columns and "assigned" in table_columns) or not table_columns:
             queryset = queryset.annotate(
                 assigned_count=count_related(Interface, "ip_addresses") + count_related(VMInterface, "ip_addresses"),
             )
@@ -770,7 +706,6 @@ class IPAddressListView(generic.ObjectListView):
 
 class IPAddressView(generic.ObjectView):
     queryset = IPAddress.objects.select_related("tenant", "status", "role")
-    use_new_ui = True
 
     def get_extra_context(self, request, instance):
         # Parent prefixes table
@@ -929,7 +864,7 @@ class IPAddressAssignView(view_mixins.GetReturnURLMixin, generic.ObjectView):
                 "per_page": get_paginate_count(request),
             }
             RequestConfig(request, paginate).configure(table)
-            max_page_size = get_settings_or_config("MAX_PAGE_SIZE")
+            max_page_size = get_settings_or_config("MAX_PAGE_SIZE", fallback=MAX_PAGE_SIZE_DEFAULT)
             if max_page_size and paginate["per_page"] > max_page_size:
                 messages.warning(
                     request,
@@ -1421,12 +1356,6 @@ class VLANBulkEditView(generic.BulkEditView):
     table = tables.VLANTable
     form = forms.VLANBulkEditForm
 
-    def extra_post_save_action(self, obj, form):
-        if form.cleaned_data.get("add_locations", None):
-            obj.locations.add(*form.cleaned_data["add_locations"])
-        if form.cleaned_data.get("remove_locations", None):
-            obj.locations.remove(*form.cleaned_data["remove_locations"])
-
 
 class VLANBulkDeleteView(generic.BulkDeleteView):
     queryset = VLAN.objects.select_related(