nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/ipam/api/serializers.py

@@ -5,19 +5,10 @@ from rest_framework.validators import UniqueTogetherValidator
 
 from nautobot.core.api import (
     ChoiceField,
-    SerializedPKRelatedField,
-)
-from nautobot.dcim.api.nested_serializers import (
-    NestedDeviceSerializer,
-    NestedLocationSerializer,
-)
-from nautobot.dcim.models import Device
-from nautobot.extras.api.serializers import (
     NautobotModelSerializer,
-    RoleModelSerializerMixin,
-    StatusModelSerializerMixin,
-    TaggedModelSerializerMixin,
 )
+from nautobot.extras.api.mixins import TaggedModelSerializerMixin
+from nautobot.ipam.api.fields import IPFieldSerializer
 from nautobot.ipam.choices import PrefixTypeChoices, ServiceProtocolChoices
 from nautobot.ipam import constants
 from nautobot.ipam.models import (
@@ -31,25 +22,7 @@ from nautobot.ipam.models import (
     VLANGroup,
     VRF,
 )
-from nautobot.tenancy.api.nested_serializers import NestedTenantSerializer
-from nautobot.virtualization.api.nested_serializers import (
-    NestedVirtualMachineSerializer,
-)
 
-# Not all of these variable(s) are actually used anywhere in this file, but are required for the
-# automagically replacing a Serializer with its corresponding NestedSerializer.
-from .nested_serializers import (  # noqa: F401
-    IPFieldSerializer,
-    NestedIPAddressSerializer,
-    NestedNamespaceSerializer,
-    NestedPrefixSerializer,
-    NestedRIRSerializer,
-    NestedRouteTargetSerializer,
-    NestedServiceSerializer,
-    NestedVLANGroupSerializer,
-    NestedVLANSerializer,
-    NestedVRFSerializer,
-)
 
 #
 # Namespaces
@@ -70,53 +43,13 @@ class NamespaceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
 
 
 class VRFSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vrf-detail")
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-    import_targets = SerializedPKRelatedField(
-        queryset=RouteTarget.objects.all(),
-        serializer=NestedRouteTargetSerializer,
-        required=False,
-        many=True,
-    )
-    export_targets = SerializedPKRelatedField(
-        queryset=RouteTarget.objects.all(),
-        serializer=NestedRouteTargetSerializer,
-        required=False,
-        many=True,
-    )
-    devices = SerializedPKRelatedField(
-        queryset=Device.objects.all(),
-        serializer=NestedDeviceSerializer,
-        required=False,
-        many=True,
-    )
-    prefixes = SerializedPKRelatedField(
-        queryset=Prefix.objects.all(),
-        serializer=NestedPrefixSerializer,
-        required=False,
-        many=True,
-    )
-    namespace = NestedNamespaceSerializer()
-    # FIXME(jathan); These two values come from annotation on `VRFViewSet.queryset`
-    # ipaddress_count = serializers.IntegerField(read_only=True)
-    # prefix_count = serializers.IntegerField(read_only=True)
+    ipaddress_count = serializers.IntegerField(read_only=True)
+    prefix_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = VRF
-        fields = [
-            "url",
-            "name",
-            "rd",
-            "namespace",
-            "tenant",
-            "description",
-            "import_targets",
-            "export_targets",
-            "devices",
-            "prefixes",
-            # "ipaddress_count",
-            # "prefix_count",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "rd", "tenant", "description"]
 
 
 #
@@ -125,17 +58,10 @@ class VRFSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
 
 
 class RouteTargetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:routetarget-detail")
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
     class Meta:
         model = RouteTarget
-        fields = [
-            "url",
-            "name",
-            "tenant",
-            "description",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "tenant", "description"]
 
 
 #
@@ -144,17 +70,16 @@ class RouteTargetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin)
 
 
 class RIRSerializer(NautobotModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:rir-detail")
     assigned_prefix_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = RIR
-        fields = [
-            "url",
+        fields = "__all__"
+        list_display_fields = [
             "name",
             "is_private",
-            "description",
             "assigned_prefix_count",
+            "description",
         ]
 
 
@@ -164,20 +89,12 @@ class RIRSerializer(NautobotModelSerializer):
 
 
 class VLANGroupSerializer(NautobotModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlangroup-detail")
-    location = NestedLocationSerializer(required=False, allow_null=True)
     vlan_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = VLANGroup
-        fields = [
-            "url",
-            "name",
-            "slug",
-            "location",
-            "description",
-            "vlan_count",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "location", "vlan_count", "description"]
         # 2.0 TODO: Remove if/when slug is globally unique. This would be a breaking change.
         validators = []
 
@@ -195,28 +112,24 @@ class VLANGroupSerializer(NautobotModelSerializer):
         return data
 
 
-class VLANSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlan-detail")
-    location = NestedLocationSerializer(required=False, allow_null=True)
-    vlan_group = NestedVLANGroupSerializer(required=False, allow_null=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
+class VLANSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     prefix_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = VLAN
-        fields = [
-            "url",
+        # TODO(jathan): These were taken from VLANDetailTable and not VLANTable. Let's make sure
+        # these are correct.
+        fields = "__all__"
+        list_display_fields = [
+            "vid",
             "location",
             "vlan_group",
-            "vid",
             "name",
+            "prefixes",
             "tenant",
             "status",
             "role",
             "description",
-            "prefix_count",
         ]
         validators = []
 
@@ -238,38 +151,28 @@ class VLANSerializer(
 #
 
 
-class PrefixSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:prefix-detail")
+class PrefixSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     prefix = IPFieldSerializer()
     type = ChoiceField(choices=PrefixTypeChoices, default=PrefixTypeChoices.TYPE_NETWORK)
-    location = NestedLocationSerializer(required=False, allow_null=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-    vlan = NestedVLANSerializer(required=False, allow_null=True)
-    rir = NestedRIRSerializer(required=False, allow_null=True)
-    namespace = NestedNamespaceSerializer()
-    vrfs = NestedVRFSerializer(required=False, allow_null=True, many=True)
 
     class Meta:
         model = Prefix
-        fields = [
-            "url",
-            "ip_version",
+        fields = "__all__"
+        list_display_fields = [
             "prefix",
             "type",
-            "location",
-            "vrfs",
-            "namespace",
+            "status",
+            "vrf",
             "tenant",
+            "location",
             "vlan",
-            "status",
             "role",
-            "rir",
-            "date_allocated",
             "description",
         ]
-        read_only_fields = ["ip_version"]
+        extra_kwargs = {
+            "ip_version": {"read_only": True},
+            "prefix_length": {"read_only": True},
+        }
 
 
 class PrefixLengthSerializer(serializers.Serializer):
@@ -297,7 +200,6 @@ class AvailablePrefixSerializer(serializers.Serializer):
 
     ip_version = serializers.IntegerField(read_only=True)
     prefix = serializers.CharField(read_only=True)
-    namespace = NestedNamespaceSerializer(read_only=True)
 
     def to_representation(self, instance):
         return OrderedDict(
@@ -314,30 +216,32 @@ class AvailablePrefixSerializer(serializers.Serializer):
 #
 
 
-class IPAddressSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:ipaddress-detail")
+class IPAddressSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     address = IPFieldSerializer()
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-    nat_inside = NestedIPAddressSerializer(required=False, allow_null=True)
-    nat_outside_list = NestedIPAddressSerializer(read_only=True, many=True)
 
     class Meta:
         model = IPAddress
-        fields = [
-            "url",
-            "ip_version",
+        fields = "__all__"
+        list_display_fields = [
             "address",
-            "tenant",
+            "vrf",
             "status",
             "role",
-            "nat_inside",
-            "nat_outside_list",
+            "tenant",
             "dns_name",
             "description",
         ]
-        read_only_fields = ["ip_version"]
+        extra_kwargs = {
+            "ip_version": {"read_only": True},
+            "mask_length": {"read_only": True},
+            "nat_outside_list": {"read_only": True},
+        }
+
+    def get_field_names(self, declared_fields, info):
+        """Add nat_outside_list reverse relation to the automatically discovered fields."""
+        fields = list(super().get_field_names(declared_fields, info))
+        self.extend_field_names(fields, "nat_outside_list")
+        return fields
 
 
 class AvailableIPSerializer(serializers.Serializer):
@@ -347,8 +251,6 @@ class AvailableIPSerializer(serializers.Serializer):
 
     ip_version = serializers.IntegerField(read_only=True)
     address = serializers.CharField(read_only=True)
-    namespace = NestedNamespaceSerializer(read_only=True)
-    # TODO: Should be requesting a prefix instead
 
     def to_representation(self, instance):
         return OrderedDict(
@@ -366,32 +268,24 @@ class AvailableIPSerializer(serializers.Serializer):
 
 
 class ServiceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:service-detail")
-    device = NestedDeviceSerializer(required=False, allow_null=True)
-    virtual_machine = NestedVirtualMachineSerializer(required=False, allow_null=True)
+    # TODO #3024 make a backlog item to rip out the choice field.
     protocol = ChoiceField(choices=ServiceProtocolChoices, required=False)
-    ip_addresses = SerializedPKRelatedField(
-        queryset=IPAddress.objects.all(),
-        serializer=NestedIPAddressSerializer,
-        required=False,
-        many=True,
-    )
     ports = serializers.ListField(
         child=serializers.IntegerField(
             min_value=constants.SERVICE_PORT_MIN,
             max_value=constants.SERVICE_PORT_MAX,
-        )
+        ),
     )
 
     class Meta:
         model = Service
-        fields = [
-            "url",
-            "device",
-            "virtual_machine",
-            "name",
-            "ports",
-            "protocol",
-            "ip_addresses",
-            "description",
-        ]
+        fields = "__all__"
+        extra_kwargs = {
+            "device": {"help_text": "Required if no virtual_machine is specified"},
+            "virtual_machine": {"help_text": "Required if no device is specified"},
+        }
+        # TODO(jathan): We need to account for the "parent" field from the `ServiceTable` which is
+        # an either/or column for `device` or `virtual_machine`. For now it's hard-coded to
+        # `device`.
+        # list_display_fields = ["name", "parent", "protocol", "ports", "description"]
+        list_display_fields = ["name", "device", "protocol", "ports", "description"]

nautobot/ipam/api/urls.py

@@ -1,4 +1,4 @@
-from nautobot.core.api import OrderedDefaultRouter
+from nautobot.core.api.routers import OrderedDefaultRouter
 from . import views
 
 

nautobot/ipam/api/views.py

@@ -94,6 +94,7 @@ class PrefixViewSet(NautobotModelViewSet):
     queryset = Prefix.objects.select_related(
         "role",
         "status",
+        "location",
         "tenant",
         "vlan",
         "namespace",
@@ -152,7 +153,7 @@ class PrefixViewSet(NautobotModelViewSet):
                     available_prefixes.remove(allocated_prefix)
 
                 # Initialize the serializer with a list or a single object depending on what was requested
-                context = {"request": request}
+                context = {"request": request, "depth": 0}
                 if isinstance(request.data, list):
                     serializer = serializers.PrefixSerializer(data=requested_prefixes, many=True, context=context)
                 else:
@@ -227,7 +228,7 @@ class PrefixViewSet(NautobotModelViewSet):
                     requested_ip["namespace"] = prefix.namespace.pk
 
                 # Initialize the serializer with a list or a single object depending on what was requested
-                context = {"request": request}
+                context = {"request": request, "depth": 0}
                 if isinstance(request.data, list):
                     serializer = serializers.IPAddressSerializer(data=requested_ips, many=True, context=context)
                 else:

nautobot/ipam/apps.py

@@ -16,8 +16,7 @@ class IPAMConfig(NautobotConfig):
 
         from graphene_django.converter import convert_django_field, convert_field_to_string
         from nautobot.ipam.fields import VarbinaryIPField
+        import nautobot.ipam.signals  # noqa: F401
 
         # Register VarbinaryIPField to be converted to a string type
         convert_django_field.register(VarbinaryIPField)(convert_field_to_string)
-
-        from nautobot.ipam import signals  # noqa

nautobot/ipam/filters.py

@@ -337,10 +337,6 @@ class IPAddressFilterSet(
         method="filter_address",
         label="Address",
     )
-    mask_length = django_filters.NumberFilter(
-        method="filter_mask_length",
-        label="Mask length",
-    )
     vrf = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="parent__vrfs",
         queryset=VRF.objects.all(),
@@ -404,7 +400,7 @@ class IPAddressFilterSet(
 
     class Meta:
         model = IPAddress
-        fields = ["id", "ip_version", "dns_name", "tags"]
+        fields = ["id", "ip_version", "dns_name", "tags", "mask_length"]
 
     def search_by_parent(self, queryset, name, value):
         value = value.strip()
@@ -422,11 +418,6 @@ class IPAddressFilterSet(
         except ValidationError:
             return queryset.none()
 
-    def filter_mask_length(self, queryset, name, value):
-        if not value:
-            return queryset
-        return queryset.filter(prefix_length=value)
-
     def filter_present_in_vrf(self, queryset, name, value):
         if value is None:
             return queryset.none