NPL-374 Add Mixin Support and make CustomObject class ABC (#110)

Author: arthanson

netbox_custom_objects/__init__.py

@@ -13,30 +13,5 @@ class CustomObjectsPluginConfig(PluginConfig):
     required_settings = []
     template_extensions = "template_content.template_extensions"
 
-    # def get_model(self, model_name, require_ready=True):
-    #     if require_ready:
-    #         self.apps.check_models_ready()
-    #     else:
-    #         self.apps.check_apps_ready()
-    #
-    #     if model_name.lower() in self.models:
-    #         return self.models[model_name.lower()]
-    #
-    #     from .models import CustomObjectType
-    #     if "table" not in model_name.lower() or "model" not in model_name.lower():
-    #         raise LookupError(
-    #             "App '%s' doesn't have a '%s' model." % (self.label, model_name)
-    #         )
-    #
-    #     custom_object_type_id = int(model_name.replace("table", "").replace("model", ""))
-    #
-    #     try:
-    #         obj = CustomObjectType.objects.get(pk=custom_object_type_id)
-    #     except CustomObjectType.DoesNotExist:
-    #         raise LookupError(
-    #             "App '%s' doesn't have a '%s' model." % (self.label, model_name)
-    #         )
-    #     return obj.get_model()
-
 
 config = CustomObjectsPluginConfig

netbox_custom_objects/api/views.py

@@ -2,7 +2,7 @@
 from rest_framework.routers import APIRootView
 from rest_framework.viewsets import ModelViewSet
 
-from netbox_custom_objects.models import CustomObject, CustomObjectType, CustomObjectTypeField
+from netbox_custom_objects.models import CustomObjectType, CustomObjectTypeField
 
 from . import serializers
 
@@ -18,7 +18,6 @@ class CustomObjectTypeViewSet(ModelViewSet):
 
 
 class CustomObjectViewSet(ModelViewSet):
-    queryset = CustomObject.objects.all()
     serializer_class = serializers.CustomObjectSerializer
     model = None
 

netbox_custom_objects/field_types.py

@@ -611,16 +611,15 @@ def get_through_model(self, field, model=None):
             and field.custom_object_type.id == custom_object_type_id
         )
 
+        # Use the actual model if provided, otherwise use string reference
+        source_model = model if model else "netbox_custom_objects.CustomObject"
+
         attrs = {
             "__module__": "netbox_custom_objects.models",
             "Meta": meta,
             "id": models.AutoField(primary_key=True),
             "source": models.ForeignKey(
-                (
-                    "self"
-                    if is_self_referential
-                    else (model or "netbox_custom_objects.CustomObject")
-                ),
+                source_model,
                 on_delete=models.CASCADE,
                 related_name="+",
                 db_column="source_id",
@@ -652,6 +651,8 @@ def get_model_field(self, field, **kwargs):
             and field.custom_object_type.id == custom_object_type_id
         )
 
+        # For now, we'll create the through model with string references
+        # and resolve them later in after_model_generation
         through = self.get_through_model(field)
 
         # For self-referential fields, use 'self' as the target
@@ -694,8 +695,14 @@ def after_model_generation(self, instance, model, field_name):
         if getattr(field, "_is_self_referential", False):
             field.remote_field.model = model
             through_model = field.remote_field.through
-            through_model._meta.get_field("target").remote_field.model = model
-            through_model._meta.get_field("target").related_model = model
+
+            # Update both source and target fields to point to the same model
+            source_field = through_model._meta.get_field("source")
+            target_field = through_model._meta.get_field("target")
+            source_field.remote_field.model = model
+            source_field.related_model = model
+            target_field.remote_field.model = model
+            target_field.related_model = model
             return
 
         content_type = ContentType.objects.get(pk=instance.related_object_type_id)
@@ -713,12 +720,19 @@ def after_model_generation(self, instance, model, field_name):
             to_ct = f"{content_type.app_label}.{content_type.model}"
             to_model = apps.get_model(to_ct)
 
-        # Update the M2M field's model references
+        # Update through model's fields
         field.remote_field.model = to_model
 
         # Update through model's target field
         through_model = field.remote_field.through
+        source_field = through_model._meta.get_field("source")
         target_field = through_model._meta.get_field("target")
+
+        # Source field should point to the current model
+        source_field.remote_field.model = model
+        source_field.related_model = model
+
+        # Target field should point to the related model
         target_field.remote_field.model = to_model
         target_field.related_model = to_model
 
@@ -751,15 +765,24 @@ def create_m2m_table(self, instance, model, field_name):
 
         # Create the through model with actual model references
         through = self.get_through_model(instance, model)
-        through._meta.get_field("target").remote_field.model = to_model
-        through._meta.get_field("target").related_model = to_model
+
+        # Update the through model's foreign key references
+        source_field = through._meta.get_field("source")
+        target_field = through._meta.get_field("target")
+
+        # Source field should point to the current model
+        source_field.remote_field.model = model
+        source_field.remote_field.field_name = model._meta.pk.name
+        source_field.related_model = model
+
+        # Target field should point to the related model
+        target_field.remote_field.model = to_model
+        target_field.remote_field.field_name = to_model._meta.pk.name
+        target_field.related_model = to_model
 
         # Register the model with Django's app registry
         apps = model._meta.apps
 
-        # if app_label is None:
-        #     app_label = str(uuid.uuid4()) + "_database_table"
-        # apps = AppsProxy(dynamic_models=None, app_label=app_label)
         try:
             through_model = apps.get_model(APP_LABEL, instance.through_model_name)
         except LookupError:
@@ -769,6 +792,7 @@ def create_m2m_table(self, instance, model, field_name):
         # Update the M2M field's through model and target model
         field.remote_field.through = through_model
         field.remote_field.model = to_model
+        field.remote_field.field_name = to_model._meta.pk.name
 
         # Create the through table
         with connection.schema_editor() as schema_editor:

netbox_custom_objects/migrations/0002_customobject_created_customobject_last_updated.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.2.2 on 2025-07-15 17:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_custom_objects", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="customobject",
+            name="created",
+            field=models.DateTimeField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="customobject",
+            name="last_updated",
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+    ]

netbox_custom_objects/migrations/0003_delete_customobject.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.2.2 on 2025-07-18 20:24
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "netbox_custom_objects",
+            "0002_customobject_created_customobject_last_updated",
+        ),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="CustomObject",
+        ),
+    ]