Change all uses of custom_object_type.name to use slug in urls or verbose_name/verbose_name_plural in templates

bctiemann · bctiemann · commit 80c911016f89 · 2025-08-21T21:23:18.000-04:00
diff --git a/netbox_custom_objects/api/serializers.py b/netbox_custom_objects/api/serializers.py
@@ -192,7 +192,7 @@ def get_url(self, obj):
         lookup_value = getattr(obj, "pk")
         kwargs = {
             "pk": lookup_value,
-            "custom_object_type": obj.custom_object_type.name.lower(),
+            "custom_object_type": obj.custom_object_type.slug,
         }
         request = self.context["request"]
         format = self.context.get("format")
@@ -230,7 +230,7 @@ def get_url(self, obj):
         lookup_value = getattr(obj, "pk")
         kwargs = {
             "pk": lookup_value,
-            "custom_object_type": obj.custom_object_type.name.lower(),
+            "custom_object_type": obj.custom_object_type.slug,
         }
         request = self.context["request"]
         format = self.context.get("format")
diff --git a/netbox_custom_objects/api/urls.py b/netbox_custom_objects/api/urls.py
@@ -51,7 +51,7 @@ def get(self, request, *args, **kwargs):
         # Extra logic to populate roots for custom object type lists
         for custom_object_type in CustomObjectType.objects.all():
             local_kwargs = deepcopy(kwargs)
-            cot_name = custom_object_type.name.lower()
+            cot_name = custom_object_type.slug
             url_name = 'customobject-list'
             local_kwargs['custom_object_type'] = cot_name
             if namespace:
diff --git a/netbox_custom_objects/api/views.py b/netbox_custom_objects/api/views.py
@@ -23,7 +23,7 @@ class CustomObjectViewSet(ModelViewSet):
 
     def get_view_name(self):
         if self.model:
-            return self.model.custom_object_type.name
+            return self.model.custom_object_type.verbose_name or self.model.custom_object_type.name
         return 'Custom Object'
 
     def get_serializer_class(self):
@@ -32,7 +32,7 @@ def get_serializer_class(self):
     def get_queryset(self):
         try:
             custom_object_type = CustomObjectType.objects.get(
-                name__iexact=self.kwargs["custom_object_type"]
+                slug=self.kwargs["custom_object_type"]
             )
         except CustomObjectType.DoesNotExist:
             raise Http404
diff --git a/netbox_custom_objects/fields.py b/netbox_custom_objects/fields.py
@@ -59,7 +59,7 @@ def get_bound_field(self, form, field_name):
             widget.attrs["data-url"] = reverse(
                 viewname,
                 kwargs={
-                    "custom_object_type": form.instance.custom_object_type.name.lower()
+                    "custom_object_type": form.instance.custom_object_type.slug
                 },
             )
 
@@ -70,7 +70,7 @@ def get_bound_field(self, form, field_name):
                 "url": reverse(
                     viewname,
                     kwargs={
-                        "custom_object_type": form.instance.custom_object_type.name.lower()
+                        "custom_object_type": form.instance.custom_object_type.slug
                     },
                 ),
                 "params": {},
diff --git a/netbox_custom_objects/models.py b/netbox_custom_objects/models.py
@@ -134,14 +134,14 @@ def get_absolute_url(self):
             "plugins:netbox_custom_objects:customobject",
             kwargs={
                 "pk": self.pk,
-                "custom_object_type": self.custom_object_type.name.lower(),
+                "custom_object_type": self.custom_object_type.slug,
             },
         )
 
     def get_list_url(self):
         return reverse(
             "plugins:netbox_custom_objects:customobject_list",
-            kwargs={"custom_object_type": self.custom_object_type.name.lower()},
+            kwargs={"custom_object_type": self.custom_object_type.slug},
         )
 
     @classmethod
@@ -154,7 +154,7 @@ def _get_viewname(cls, action=None, rest_api=False):
     def _get_action_url(cls, action=None, rest_api=False, kwargs=None):
         if kwargs is None:
             kwargs = {}
-        kwargs["custom_object_type"] = cls.custom_object_type.name.lower()
+        kwargs["custom_object_type"] = cls.custom_object_type.slug
         return reverse(cls._get_viewname(action, rest_api), kwargs=kwargs)
 
 
@@ -188,7 +188,11 @@ class Meta:
         ]
 
     def __str__(self):
-        return self.name
+        return self.display_name
+
+    @property
+    def display_name(self):
+        return self.verbose_name or self.name
 
     @classmethod
     def clear_model_cache(cls, custom_object_type_id=None):
@@ -272,7 +276,7 @@ def get_absolute_url(self):
     def get_list_url(self):
         return reverse(
             "plugins:netbox_custom_objects:customobject_list",
-            kwargs={"custom_object_type": self.name.lower()},
+            kwargs={"custom_object_type": self.slug},
         )
 
     @classmethod
diff --git a/netbox_custom_objects/navigation.py b/netbox_custom_objects/navigation.py
@@ -35,7 +35,7 @@ def __iter__(self):
             add_button.url = reverse_lazy(
                 f"plugins:{APP_LABEL}:customobject_add",
                 kwargs={
-                    "custom_object_type": custom_object_type.name.lower()
+                    "custom_object_type": custom_object_type.slug
                 },
             )
             menu_item = PluginMenuItem(
@@ -45,7 +45,7 @@ def __iter__(self):
             )
             menu_item.url = reverse_lazy(
                 f"plugins:{APP_LABEL}:customobject_list",
-                kwargs={"custom_object_type": custom_object_type.name.lower()},
+                kwargs={"custom_object_type": custom_object_type.slug},
             )
             yield menu_item
 
diff --git a/netbox_custom_objects/tables.py b/netbox_custom_objects/tables.py
@@ -112,7 +112,7 @@ def render(self, record, table, **kwargs):
                     get_viewname(model, action),
                     kwargs={
                         "pk": record.pk,
-                        "custom_object_type": record.custom_object_type.name.lower(),
+                        "custom_object_type": record.custom_object_type.slug,
                     },
                 )
 
diff --git a/netbox_custom_objects/templates/netbox_custom_objects/customobject.html b/netbox_custom_objects/templates/netbox_custom_objects/customobject.html
@@ -90,7 +90,7 @@
           <tr>
             <th scope="row">{% trans "Type" %}</th>
             <td>
-                {{ object.custom_object_type|linkify:"name" }}
+                {{ object.custom_object_type|linkify:"display_name" }}
             </td>
           </tr>
           <tr>
diff --git a/netbox_custom_objects/templates/netbox_custom_objects/customobject_edit.html b/netbox_custom_objects/templates/netbox_custom_objects/customobject_edit.html
@@ -4,9 +4,9 @@
 
 {% block title %}
   {% if object.pk %}
-    {% trans "Editing" %} {{ object.custom_object_type.get_verbose_name.lower }} {{ object }}
+    {% trans "Editing" %} {{ object.custom_object_type.display_name.lower }} {{ object }}
   {% else %}
-    {% blocktrans trimmed with custom_object_type=object.custom_object_type.name %}
+    {% blocktrans trimmed with custom_object_type=object.custom_object_type.display_name %}
       Add a new {{ custom_object_type }}
     {% endblocktrans %}
   {% endif %}
diff --git a/netbox_custom_objects/templates/netbox_custom_objects/customobjecttype.html b/netbox_custom_objects/templates/netbox_custom_objects/customobjecttype.html
@@ -25,6 +25,10 @@ <h5 class="card-header">{% trans "Custom Object Type" %}</h5>
             <th scope="row">{% trans "Name" %}</th>
             <td>{{ object.name }}</td>
           </tr>
+          <tr>
+            <th scope="row">{% trans "Readable name" %}</th>
+            <td>{{ object.verbose_name }}</td>
+          </tr>
           <tr>
             <th scope="row">{% trans "Description" %}</th>
             <td>{{ object.description|placeholder }}</td>
diff --git a/netbox_custom_objects/templatetags/custom_object_buttons.py b/netbox_custom_objects/templatetags/custom_object_buttons.py
@@ -79,7 +79,7 @@ def custom_object_clone_button(instance):
     viewname = get_viewname(instance, "add")
     url = reverse(
         viewname,
-        kwargs={"custom_object_type": instance.custom_object_type.name.lower()}
+        kwargs={"custom_object_type": instance.custom_object_type.slug}
     )
 
     # Populate cloned field values
@@ -99,7 +99,7 @@ def custom_object_edit_button(instance):
         viewname,
         kwargs={
             "pk": instance.pk,
-            "custom_object_type": instance.custom_object_type.name.lower(),
+            "custom_object_type": instance.custom_object_type.slug,
         },
     )
 
@@ -115,7 +115,7 @@ def custom_object_delete_button(instance):
     url = reverse(
         viewname, kwargs={
             "pk": instance.pk,
-            "custom_object_type": instance.custom_object_type.name.lower(),
+            "custom_object_type": instance.custom_object_type.slug,
         },
     )
 
@@ -191,7 +191,7 @@ def custom_object_add_button(model, custom_object_type, action="add"):
     try:
         viewname = get_viewname(model, action)
         url = reverse(
-            viewname, kwargs={"custom_object_type": custom_object_type.name.lower()}
+            viewname, kwargs={"custom_object_type": custom_object_type.slug}
         )
     except NoReverseMatch:
         url = None
@@ -247,7 +247,7 @@ def custom_object_bulk_edit_button(
     try:
         viewname = get_viewname(model, action)
         url = reverse(
-            viewname, kwargs={"custom_object_type": custom_object_type.name.lower()}
+            viewname, kwargs={"custom_object_type": custom_object_type.slug}
         )
 
         if query_params:
@@ -269,7 +269,7 @@ def custom_object_bulk_delete_button(
     try:
         viewname = get_viewname(model, action)
         url = reverse(
-            viewname, kwargs={"custom_object_type": custom_object_type.name.lower()}
+            viewname, kwargs={"custom_object_type": custom_object_type.slug}
         )
         if query_params:
             url = f"{url}?{query_params.urlencode()}"
diff --git a/netbox_custom_objects/tests/test_models.py b/netbox_custom_objects/tests/test_models.py
@@ -19,12 +19,14 @@ def test_custom_object_type_creation(self):
         custom_object_type = self.create_custom_object_type(
             name="TestObject",
             description="A test custom object type",
-            verbose_name_plural="Test Objects"
+            verbose_name_plural="Test Objects",
+            slug="test-objects",
         )
 
         self.assertEqual(custom_object_type.name, "TestObject")
         self.assertEqual(custom_object_type.description, "A test custom object type")
         self.assertEqual(custom_object_type.verbose_name_plural, "Test Objects")
+        self.assertEqual(custom_object_type.slug, "test-objects")
         self.assertEqual(str(custom_object_type), "TestObject")
 
     def test_custom_object_type_unique_name_constraint(self):
@@ -46,7 +48,7 @@ def test_custom_object_type_get_list_url(self):
         custom_object_type = self.create_custom_object_type(name="TestObject")
         expected_url = reverse(
             "plugins:netbox_custom_objects:customobject_list",
-            kwargs={"custom_object_type": custom_object_type.name.lower()}
+            kwargs={"custom_object_type": custom_object_type.slug}
         )
         self.assertEqual(custom_object_type.get_list_url(), expected_url)
 
@@ -533,7 +535,7 @@ def test_custom_object_get_absolute_url(self):
         expected_url = reverse(
             "plugins:netbox_custom_objects:customobject",
             kwargs={
-                "custom_object_type": self.custom_object_type.name.lower(),
+                "custom_object_type": self.custom_object_type.slug,
                 "pk": instance.pk
             }
         )
diff --git a/netbox_custom_objects/tests/test_views.py b/netbox_custom_objects/tests/test_views.py
@@ -20,13 +20,15 @@ def setUpTestData(cls):
         cls.custom_object_type1 = CustomObjectType.objects.create(
             name="TestObject1",
             description="First test custom object type",
-            verbose_name_plural="Test Objects 1"
+            verbose_name_plural="Test Objects 1",
+            slug="test-objects-1",
         )
 
         cls.custom_object_type2 = CustomObjectType.objects.create(
             name="TestObject2",
             description="Second test custom object type",
-            verbose_name_plural="Test Objects 2"
+            verbose_name_plural="Test Objects 2",
+            slug="test-objects-2",
         )
 
     def setUp(self):
@@ -302,7 +304,7 @@ def _get_url(self, action, instance=None):
         """
         url_format = self._get_base_url()
 
-        custom_object_type = self.model.custom_object_type.name.lower()
+        custom_object_type = self.model.custom_object_type.slug
 
         # If no instance was provided, assume we don't need a unique identifier
         if instance is None:
@@ -509,7 +511,7 @@ def _get_url(self, action, instance=None):
         """
         url_format = self._get_base_url()
 
-        custom_object_type = self.model.custom_object_type.name.lower()
+        custom_object_type = self.model.custom_object_type.slug
 
         # If no instance was provided, assume we don't need a unique identifier
         if instance is None:
@@ -672,7 +674,7 @@ def _get_url(self, action, instance=None):
         """
         url_format = self._get_base_url()
 
-        custom_object_type = self.model.custom_object_type.name.lower()
+        custom_object_type = self.model.custom_object_type.slug
 
         # If no instance was provided, assume we don't need a unique identifier
         if instance is None:
diff --git a/netbox_custom_objects/views.py b/netbox_custom_objects/views.py
@@ -308,7 +308,7 @@ def get_queryset(self, request):
             return self.queryset
         custom_object_type = self.kwargs.get("custom_object_type", None)
         self.custom_object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = self.custom_object_type.get_model()
         return model.objects.all()
@@ -391,15 +391,15 @@ class CustomObjectView(generic.ObjectView):
     def get_queryset(self, request):
         custom_object_type = self.kwargs.get("custom_object_type", None)
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
         return model.objects.all()
 
     def get_object(self, **kwargs):
         custom_object_type = self.kwargs.get("custom_object_type", None)
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
         # Filter out custom_object_type from kwargs for the object lookup
@@ -449,7 +449,7 @@ def get_object(self, **kwargs):
             return self.object
         custom_object_type = self.kwargs.pop("custom_object_type", None)
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
         if not self.kwargs.get("pk", None):
@@ -540,7 +540,7 @@ def get_object(self, **kwargs):
             return self.object
         custom_object_type = self.kwargs.pop("custom_object_type", None)
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
         return get_object_or_404(model.objects.all(), **self.kwargs)
@@ -580,7 +580,7 @@ def get_queryset(self, request):
             return self.queryset
         custom_object_type = self.kwargs.get("custom_object_type", None)
         self.custom_object_type = CustomObjectType.objects.get(
-            name__iexact=custom_object_type
+            slug=custom_object_type
         )
         model = self.custom_object_type.get_model()
         return model.objects.all()
@@ -626,7 +626,7 @@ def get_queryset(self, request):
             return self.queryset
         custom_object_type = self.kwargs.pop("custom_object_type", None)
         self.custom_object_type = CustomObjectType.objects.get(
-            name__iexact=custom_object_type
+            slug=custom_object_type
         )
         model = self.custom_object_type.get_model()
         return model.objects.all()
@@ -646,7 +646,7 @@ class CustomObjectJournalView(ConditionalLoginRequiredMixin, View):
     def get(self, request, custom_object_type, **kwargs):
         # Get the custom object type and model
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
 
@@ -718,7 +718,7 @@ class CustomObjectChangeLogView(ConditionalLoginRequiredMixin, View):
     def get(self, request, custom_object_type, **kwargs):
         # Get the custom object type and model
         object_type = get_object_or_404(
-            CustomObjectType, name__iexact=custom_object_type
+            CustomObjectType, slug=custom_object_type
         )
         model = object_type.get_model()
 

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ def __iter__(self):`
`35`	`35`	`add_button.url = reverse_lazy(`
`36`	`36`	`f"plugins:{APP_LABEL}:customobject_add",`
`37`	`37`	`kwargs={`
`38`		`- "custom_object_type": custom_object_type.name.lower()`
	`38`	`+ "custom_object_type": custom_object_type.slug`
`39`	`39`	`},`
`40`	`40`	`)`
`41`	`41`	`menu_item = PluginMenuItem(`
`@@ -45,7 +45,7 @@ def __iter__(self):`
`45`	`45`	`)`
`46`	`46`	`menu_item.url = reverse_lazy(`
`47`	`47`	`f"plugins:{APP_LABEL}:customobject_list",`
`48`		`- kwargs={"custom_object_type": custom_object_type.name.lower()},`
	`48`	`+ kwargs={"custom_object_type": custom_object_type.slug},`
`49`	`49`	`)`
`50`	`50`	`yield menu_item`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ def render(self, record, table, **kwargs):`
`112`	`112`	`get_viewname(model, action),`
`113`	`113`	`kwargs={`
`114`	`114`	`"pk": record.pk,`
`115`		`- "custom_object_type": record.custom_object_type.name.lower(),`
	`115`	`+ "custom_object_type": record.custom_object_type.slug,`
`116`	`116`	`},`
`117`	`117`	`)`
`118`	`118`