Closes #11279: Replace _name natural key sorting with collation

netbox/circuits/migrations/0049_natural_ordering.py

@@ -0,0 +1,22 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0048_circuitterminations_cached_relations'),
+        ('dcim', '0197_natural_sort_collation'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='provider',
+            name='name',
+            field=models.CharField(db_collation='natural_sort', max_length=100, unique=True),
+        ),
+        migrations.AlterField(
+            model_name='providernetwork',
+            name='name',
+            field=models.CharField(db_collation='natural_sort', max_length=100),
+        ),
+    ]

netbox/circuits/models/providers.py

@@ -21,7 +21,8 @@ class Provider(ContactsMixin, PrimaryModel):
         verbose_name=_('name'),
         max_length=100,
         unique=True,
-        help_text=_('Full name of the provider')
+        help_text=_('Full name of the provider'),
+        db_collation="natural_sort"
     )
     slug = models.SlugField(
         verbose_name=_('slug'),
@@ -95,7 +96,8 @@ class ProviderNetwork(PrimaryModel):
     """
     name = models.CharField(
         verbose_name=_('name'),
-        max_length=100
+        max_length=100,
+        db_collation="natural_sort"
     )
     provider = models.ForeignKey(
         to='circuits.Provider',

netbox/core/tests/test_changelog.py

@@ -76,10 +76,6 @@ def test_create_object(self):
         self.assertEqual(oc.postchange_data['custom_fields']['cf2'], form_data['cf_cf2'])
         self.assertEqual(oc.postchange_data['tags'], ['Tag 1', 'Tag 2'])
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.postchange_data)
-        self.assertNotIn('_name', oc.postchange_data_clean)
-
     def test_update_object(self):
         site = Site(name='Site 1', slug='site-1')
         site.save()
@@ -117,12 +113,6 @@ def test_update_object(self):
         self.assertEqual(oc.postchange_data['custom_fields']['cf2'], form_data['cf_cf2'])
         self.assertEqual(oc.postchange_data['tags'], ['Tag 3'])
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.prechange_data)
-        self.assertNotIn('_name', oc.prechange_data_clean)
-        self.assertIn('_name', oc.postchange_data)
-        self.assertNotIn('_name', oc.postchange_data_clean)
-
     def test_delete_object(self):
         site = Site(
             name='Site 1',
@@ -153,10 +143,6 @@ def test_delete_object(self):
         self.assertEqual(oc.prechange_data['tags'], ['Tag 1', 'Tag 2'])
         self.assertEqual(oc.postchange_data, None)
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.prechange_data)
-        self.assertNotIn('_name', oc.prechange_data_clean)
-
     def test_bulk_update_objects(self):
         sites = (
             Site(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_ACTIVE),
@@ -353,10 +339,6 @@ def test_create_object(self):
         self.assertEqual(oc.postchange_data['custom_fields'], data['custom_fields'])
         self.assertEqual(oc.postchange_data['tags'], ['Tag 1', 'Tag 2'])
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.postchange_data)
-        self.assertNotIn('_name', oc.postchange_data_clean)
-
     def test_update_object(self):
         site = Site(name='Site 1', slug='site-1')
         site.save()
@@ -389,12 +371,6 @@ def test_update_object(self):
         self.assertEqual(oc.postchange_data['custom_fields'], data['custom_fields'])
         self.assertEqual(oc.postchange_data['tags'], ['Tag 3'])
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.prechange_data)
-        self.assertNotIn('_name', oc.prechange_data_clean)
-        self.assertIn('_name', oc.postchange_data)
-        self.assertNotIn('_name', oc.postchange_data_clean)
-
     def test_delete_object(self):
         site = Site(
             name='Site 1',
@@ -423,10 +399,6 @@ def test_delete_object(self):
         self.assertEqual(oc.prechange_data['tags'], ['Tag 1', 'Tag 2'])
         self.assertEqual(oc.postchange_data, None)
 
-        # Check that private attributes were included in raw data but not display data
-        self.assertIn('_name', oc.prechange_data)
-        self.assertNotIn('_name', oc.prechange_data_clean)
-
     def test_bulk_create_objects(self):
         data = (
             {

netbox/dcim/graphql/types.py

@@ -76,7 +76,6 @@ class ComponentType(
     """
     Base type for device/VM components
     """
-    _name: str
     device: Annotated["DeviceType", strawberry.lazy('dcim.graphql.types')]
 
 
@@ -93,7 +92,6 @@ class ComponentTemplateType(
     """
     Base type for device/VM components
     """
-    _name: str
     device_type: Annotated["DeviceTypeType", strawberry.lazy('dcim.graphql.types')]
 
 
@@ -181,7 +179,7 @@ class ConsolePortType(ModularComponentType, CabledObjectMixin, PathEndpointMixin
     filters=ConsolePortTemplateFilter
 )
 class ConsolePortTemplateType(ModularComponentTemplateType):
-    _name: str
+    pass
 
 
 @strawberry_django.type(
@@ -199,7 +197,7 @@ class ConsoleServerPortType(ModularComponentType, CabledObjectMixin, PathEndpoin
     filters=ConsoleServerPortTemplateFilter
 )
 class ConsoleServerPortTemplateType(ModularComponentTemplateType):
-    _name: str
+    pass
 
 
 @strawberry_django.type(
@@ -208,7 +206,6 @@ class ConsoleServerPortTemplateType(ModularComponentTemplateType):
     filters=DeviceFilter
 )
 class DeviceType(ConfigContextMixin, ImageAttachmentsMixin, ContactsMixin, NetBoxObjectType):
-    _name: str
     console_port_count: BigInt
     console_server_port_count: BigInt
     power_port_count: BigInt
@@ -273,7 +270,7 @@ class DeviceBayType(ComponentType):
     filters=DeviceBayTemplateFilter
 )
 class DeviceBayTemplateType(ComponentTemplateType):
-    _name: str
+    pass
 
 
 @strawberry_django.type(
@@ -282,7 +279,6 @@ class DeviceBayTemplateType(ComponentTemplateType):
     filters=InventoryItemTemplateFilter
 )
 class InventoryItemTemplateType(ComponentTemplateType):
-    _name: str
     role: Annotated["InventoryItemRoleType", strawberry.lazy('dcim.graphql.types')] | None
     manufacturer: Annotated["ManufacturerType", strawberry.lazy('dcim.graphql.types')]
 
@@ -366,7 +362,6 @@ class FrontPortType(ModularComponentType, CabledObjectMixin):
     filters=FrontPortTemplateFilter
 )
 class FrontPortTemplateType(ModularComponentTemplateType):
-    _name: str
     color: str
     rear_port: Annotated["RearPortTemplateType", strawberry.lazy('dcim.graphql.types')]
 
@@ -377,6 +372,7 @@ class FrontPortTemplateType(ModularComponentTemplateType):
     filters=InterfaceFilter
 )
 class InterfaceType(IPAddressesMixin, ModularComponentType, CabledObjectMixin, PathEndpointMixin):
+    _name: str
     mac_address: str | None
     wwn: str | None
     parent: Annotated["InterfaceType", strawberry.lazy('dcim.graphql.types')] | None
@@ -527,7 +523,7 @@ def parent(self) -> Annotated["ModuleBayType", strawberry.lazy('dcim.graphql.typ
     filters=ModuleBayTemplateFilter
 )
 class ModuleBayTemplateType(ModularComponentTemplateType):
-    _name: str
+    pass
 
 
 @strawberry_django.type(
@@ -588,7 +584,6 @@ class PowerOutletType(ModularComponentType, CabledObjectMixin, PathEndpointMixin
     filters=PowerOutletTemplateFilter
 )
 class PowerOutletTemplateType(ModularComponentTemplateType):
-    _name: str
     power_port: Annotated["PowerPortTemplateType", strawberry.lazy('dcim.graphql.types')] | None
 
 
@@ -620,8 +615,6 @@ class PowerPortType(ModularComponentType, CabledObjectMixin, PathEndpointMixin):
     filters=PowerPortTemplateFilter
 )
 class PowerPortTemplateType(ModularComponentTemplateType):
-    _name: str
-
     poweroutlet_templates: List[Annotated["PowerOutletTemplateType", strawberry.lazy('dcim.graphql.types')]]
 
 
@@ -640,7 +633,6 @@ class RackTypeType(NetBoxObjectType):
     filters=RackFilter
 )
 class RackType(VLANGroupsMixin, ImageAttachmentsMixin, ContactsMixin, NetBoxObjectType):
-    _name: str
     site: Annotated["SiteType", strawberry.lazy('dcim.graphql.types')]
     location: Annotated["LocationType", strawberry.lazy('dcim.graphql.types')] | None
     tenant: Annotated["TenantType", strawberry.lazy('tenancy.graphql.types')] | None
@@ -693,7 +685,6 @@ class RearPortType(ModularComponentType, CabledObjectMixin):
     filters=RearPortTemplateFilter
 )
 class RearPortTemplateType(ModularComponentTemplateType):
-    _name: str
     color: str
 
     frontport_templates: List[Annotated["FrontPortTemplateType", strawberry.lazy('dcim.graphql.types')]]
@@ -729,7 +720,6 @@ def circuit_terminations(self) -> List[Annotated["CircuitTerminationType", straw
     filters=SiteFilter
 )
 class SiteType(VLANGroupsMixin, ImageAttachmentsMixin, ContactsMixin, NetBoxObjectType):
-    _name: str
     time_zone: str | None
     region: Annotated["RegionType", strawberry.lazy('dcim.graphql.types')] | None
     group: Annotated["SiteGroupType", strawberry.lazy('dcim.graphql.types')] | None

netbox/dcim/migrations/0197_natural_sort_collation.py

@@ -0,0 +1,17 @@
+from django.contrib.postgres.operations import CreateCollation
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dcim', '0196_qinq_svlan'),
+    ]
+
+    operations = [
+        CreateCollation(
+            "natural_sort",
+            provider="icu",
+            locale="und-u-kn-true",
+        ),
+    ]