Merge branch 'feature' into NPL-379-import

Author: arthanson

netbox_custom_objects/__init__.py

@@ -18,6 +18,36 @@ def is_running_migration():
     return False
 
 
+def is_in_clear_cache():
+    """
+    Check if the code is currently being called from Django's clear_cache() method.
+
+    TODO: This is fairly ugly, but in models.CustomObjectType.get_model() we call
+    meta = type() which calls clear_cache on the model which causes a call to
+    get_models() which in-turn calls get_model and therefore recurses.
+
+    This catches the specific case of a recursive call to get_models() from
+    clear_cache() which is the only case we care about, so should be relatively
+    safe.  An alternative should be found for this.
+    """
+    import inspect
+
+    frame = inspect.currentframe()
+    try:
+        # Walk up the call stack to see if we're being called from clear_cache
+        while frame:
+            if (
+                frame.f_code.co_name == "clear_cache"
+                and "django/apps/registry.py" in frame.f_code.co_filename
+            ):
+                return True
+            frame = frame.f_back
+        return False
+    finally:
+        # Clean up the frame reference
+        del frame
+
+
 def check_custom_object_type_table_exists():
     """
     Check if the CustomObjectType table exists in the database.
@@ -49,6 +79,7 @@ class CustomObjectsPluginConfig(PluginConfig):
     default_settings = {}
     required_settings = []
     template_extensions = "template_content.template_extensions"
+    _in_get_models = False  # Recursion guard
 
     def get_model(self, model_name, require_ready=True):
         try:
@@ -84,33 +115,45 @@ def get_model(self, model_name, require_ready=True):
 
     def get_models(self, include_auto_created=False, include_swapped=False):
         """Return all models for this plugin, including custom object type models."""
+
         # Get the regular Django models first
         for model in super().get_models(include_auto_created, include_swapped):
             yield model
 
-        # Suppress warnings about database calls during model loading
-        with warnings.catch_warnings():
-            warnings.filterwarnings(
-                "ignore", category=RuntimeWarning, message=".*database.*"
-            )
-            warnings.filterwarnings(
-                "ignore", category=UserWarning, message=".*database.*"
-            )
+        # Prevent recursion
+        if self._in_get_models and is_in_clear_cache():
+            # Skip dynamic model creation if we're in a recursive get_models call
+            return
 
-            # Skip custom object type model loading if running during migration
-            if is_running_migration() or not check_custom_object_type_table_exists():
-                return
-
-            # Add custom object type models
-            from .models import CustomObjectType
-
-            custom_object_types = CustomObjectType.objects.all()
-            for custom_type in custom_object_types:
-                # Only yield already cached models during discovery
-                if CustomObjectType.is_model_cached(custom_type.id):
-                    model = CustomObjectType.get_cached_model(custom_type.id)
+        self._in_get_models = True
+        try:
+            # Suppress warnings about database calls during model loading
+            with warnings.catch_warnings():
+                warnings.filterwarnings(
+                    "ignore", category=RuntimeWarning, message=".*database.*"
+                )
+                warnings.filterwarnings(
+                    "ignore", category=UserWarning, message=".*database.*"
+                )
+
+                # Skip custom object type model loading if running during migration
+                if (
+                    is_running_migration()
+                    or not check_custom_object_type_table_exists()
+                ):
+                    return
+
+                # Add custom object type models
+                from .models import CustomObjectType
+
+                custom_object_types = CustomObjectType.objects.all()
+                for custom_type in custom_object_types:
+                    model = custom_type.get_model()
                     if model:
                         yield model
+        finally:
+            # Clean up the recursion guard
+            self._in_get_models = False
 
 
 config = CustomObjectsPluginConfig

netbox_custom_objects/api/serializers.py

@@ -1,3 +1,4 @@
+import logging
 import sys
 
 from core.models import ObjectType
@@ -12,6 +13,9 @@
 from netbox_custom_objects.models import (CustomObject, CustomObjectType,
                                           CustomObjectTypeField)
 
+logger = logging.getLogger('netbox_custom_objects.api.serializers')
+
+
 __all__ = (
     "CustomObjectTypeSerializer",
     "CustomObjectSerializer",
@@ -251,8 +255,8 @@ def get_display(self, obj):
         try:
             attrs[field.name] = field_type.get_serializer_field(field)
         except NotImplementedError:
-            print(
-                f"serializer: {field.name} field is not implemented; using a default serializer field"
+            logger.debug(
+                "serializer: {} field is not implemented; using a default serializer field".format(field.name)
             )
 
     serializer_name = f"{model._meta.object_name}Serializer"

netbox_custom_objects/api/views.py

@@ -24,7 +24,7 @@ class CustomObjectViewSet(ModelViewSet):
     def get_view_name(self):
         if self.model:
             return self.model.custom_object_type.name
-        return super().get_view_name()
+        return 'Custom Object'
 
     def get_serializer_class(self):
         return serializers.get_serializer_class(self.model)

netbox_custom_objects/choices.py

@@ -18,3 +18,21 @@ class MappingFieldTypeChoices(ChoiceSet):
         (DATETIME, _("DateTime"), "blue"),
         (OBJECT, _("Object"), "orange"),
     )
+
+
+#
+# Search
+#
+
+class SearchWeightChoices(ChoiceSet):
+    WEIGHT_NONE = 0
+    WEIGHT_LOW = 1000
+    WEIGHT_MEDIUM = 500
+    WEIGHT_HIGH = 100
+
+    CHOICES = (
+        (WEIGHT_HIGH, _('High (100)')),
+        (WEIGHT_MEDIUM, _('Medium (500)')),
+        (WEIGHT_LOW, _('Low (1000)')),
+        (WEIGHT_NONE, _('Not searchable')),
+    )

netbox_custom_objects/forms.py

@@ -9,6 +9,7 @@
 from utilities.forms.rendering import FieldSet
 from utilities.object_types import object_type_name
 
+from netbox_custom_objects.choices import SearchWeightChoices
 from netbox_custom_objects.constants import APP_LABEL
 from netbox_custom_objects.models import (CustomObjectObjectType,
                                           CustomObjectType,
@@ -104,13 +105,21 @@ class CustomObjectTypeFieldForm(CustomFieldForm):
         queryset=CustomObjectObjectType.objects.public(),
         help_text=_("Type of the related object (for object/multi-object fields only)"),
     )
+    search_weight = forms.ChoiceField(
+        choices=SearchWeightChoices,
+        required=False,
+        help_text=_(
+            "Weighting for search. Lower values are considered more important. Fields with a search weight of 0 "
+            "will be ignored."
+        ),
+    )
 
     fieldsets = (
         FieldSet(
             "custom_object_type",
-            "primary",
             "name",
             "label",
+            "primary",
             "group_name",
             "description",
             "type",

netbox_custom_objects/migrations/0006_alter_customobjecttypefield_name_and_more.py

@@ -0,0 +1,40 @@
+# Generated by Django 5.2.4 on 2025-08-12 17:38
+
+import django.core.validators
+import re
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_custom_objects", "0005_alter_customobjecttype_description"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="customobjecttypefield",
+            name="name",
+            field=models.CharField(
+                max_length=50,
+                validators=[
+                    django.core.validators.RegexValidator(
+                        flags=re.RegexFlag["IGNORECASE"],
+                        message="Only alphanumeric characters and underscores are allowed.",
+                        regex="^[a-z0-9_]+$",
+                    ),
+                    django.core.validators.RegexValidator(
+                        flags=re.RegexFlag["IGNORECASE"],
+                        inverse_match=True,
+                        message="Double underscores are not permitted in custom object field names.",
+                        regex="__",
+                    ),
+                ],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="customobjecttypefield",
+            name="search_weight",
+            field=models.PositiveSmallIntegerField(default=500),
+        ),
+    ]