fix TYPE_OBJECT, TYPE_MULTIOBJECT fields

Author: arthanson

netbox_custom_objects/field_types.py

@@ -14,7 +14,8 @@
 from django.utils.translation import gettext_lazy as _
 from extras.choices import CustomFieldTypeChoices, CustomFieldUIEditableChoices
 from utilities.api import get_serializer_for_model
-from utilities.forms.fields import (CSVChoiceField, CSVMultipleChoiceField,
+from utilities.forms.fields import (CSVChoiceField, CSVModelChoiceField,
+                                    CSVModelMultipleChoiceField, CSVMultipleChoiceField,
                                     DynamicChoiceField,
                                     DynamicMultipleChoiceField, JSONField,
                                     LaxURLField)
@@ -357,7 +358,6 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
         """
         content_type = ContentType.objects.get(pk=field.related_object_type_id)
 
-        from utilities.forms.fields import DynamicModelChoiceField
         if content_type.app_label == APP_LABEL:
             # This is a custom object type
             from netbox_custom_objects.models import CustomObjectType
@@ -367,24 +367,34 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
             )
             custom_object_type = CustomObjectType.objects.get(pk=custom_object_type_id)
             model = custom_object_type.get_model()
-            field_class = DynamicModelChoiceField
         else:
             # This is a regular NetBox model
             model = content_type.model_class()
 
+        if for_csv_import:
+            field_class = CSVModelChoiceField
+            # For CSV import, determine to_field_name from the field configuration
+            to_field_name = getattr(field, 'to_field_name', None) or 'name'
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                to_field_name=to_field_name,
+            )
+        else:
+            from utilities.forms.fields import DynamicModelChoiceField
             field_class = DynamicModelChoiceField
-
-        return field_class(
-            queryset=model.objects.all(),
-            required=field.required,
-            initial=field.default,
-            query_params=(
-                field.related_object_filter
-                if hasattr(field, "related_object_filter")
-                else None
-            ),
-            selector=True,
-        )
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                query_params=(
+                    field.related_object_filter
+                    if hasattr(field, "related_object_filter")
+                    else None
+                ),
+                selector=True,
+            )
 
     def get_filterform_field(self, field, **kwargs):
         return None
@@ -658,19 +668,30 @@ def get_form_field(self, field, for_csv_import=False, **kwargs):
             # This is a regular NetBox model
             model = content_type.model_class()
 
-        from utilities.forms.fields import DynamicModelMultipleChoiceField
-
-        return DynamicModelMultipleChoiceField(
-            queryset=model.objects.all(),
-            required=field.required,
-            initial=field.default,
-            query_params=(
-                field.related_object_filter
-                if hasattr(field, "related_object_filter")
-                else None
-            ),
-            selector=True,
-        )
+        if for_csv_import:
+            field_class = CSVModelMultipleChoiceField
+            # For CSV import, determine to_field_name from the field configuration
+            to_field_name = getattr(field, 'to_field_name', None) or 'name'
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                to_field_name=to_field_name,
+            )
+        else:
+            from utilities.forms.fields import DynamicModelMultipleChoiceField
+            field_class = DynamicModelMultipleChoiceField
+            return field_class(
+                queryset=model.objects.all(),
+                required=field.required,
+                initial=field.default,
+                query_params=(
+                    field.related_object_filter
+                    if hasattr(field, "related_object_filter")
+                    else None
+                ),
+                selector=True,
+            )
 
     def get_filterform_field(self, field, **kwargs):
         return None

netbox_custom_objects/views.py

@@ -14,7 +14,11 @@
 from extras.models import JournalEntry
 from extras.tables import JournalEntryTable
 from netbox.filtersets import BaseFilterSet
-from netbox.forms import NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, NetBoxModelImportForm
+from netbox.forms import (
+    NetBoxModelBulkEditForm,
+    NetBoxModelFilterSetForm,
+    NetBoxModelImportForm,
+)
 from netbox.views import generic
 from netbox.views.generic.mixins import TableMixin
 from utilities.forms import ConfirmationForm
@@ -31,7 +35,7 @@
 from . import field_types, filtersets, forms, tables
 from .models import CustomObject, CustomObjectType, CustomObjectTypeField
 
-logger = logging.getLogger('netbox_custom_objects.views')
+logger = logging.getLogger("netbox_custom_objects.views")
 
 
 class CustomJournalEntryForm(JournalEntryForm):
@@ -123,7 +127,9 @@ def get_table(self, data, request, bulk_actions=True):
                 attrs[field.name] = field_type.get_table_column_field(field)
             except NotImplementedError:
                 logger.debug(
-                    "table mixin: {} field is not implemented; using a default column".format(field.name)
+                    "table mixin: {} field is not implemented; using a default column".format(
+                        field.name
+                    )
                 )
             # Define a method "render_table_column" method on any FieldType to customize output
             # See https://django-tables2.readthedocs.io/en/latest/pages/custom-data.html#table-render-foo-methods
@@ -587,7 +593,9 @@ def get_form(self, queryset):
             try:
                 attrs[field.name] = field_type.get_annotated_form_field(field)
             except NotImplementedError:
-                logger.debug("bulk edit form: {} field is not supported".format(field.name))
+                logger.debug(
+                    "bulk edit form: {} field is not supported".format(field.name)
+                )
 
         form = type(
             f"{queryset.model._meta.object_name}BulkEditForm",
@@ -621,7 +629,7 @@ def get_queryset(self, request):
         return model.objects.all()
 
 
-@register_model_view(CustomObject, 'bulk_import', path='import', detail=False)
+@register_model_view(CustomObject, "bulk_import", path="import", detail=False)
 class CustomObjectBulkImportView(generic.BulkImportView):
     queryset = None
     model_form = None
@@ -667,7 +675,9 @@ def get_model_form(self, queryset):
         for field in self.custom_object_type.fields.all():
             field_type = field_types.FIELD_TYPE_CLASS[field.type]()
             try:
-                attrs[field.name] = field_type.get_annotated_form_field(field)
+                attrs[field.name] = field_type.get_annotated_form_field(
+                    field, for_csv_import=True
+                )
             except NotImplementedError:
                 print(f"bulk import form: {field.name} field is not supported")
 
@@ -679,6 +689,7 @@ def get_model_form(self, queryset):
 
         return form
 
+
 class CustomObjectJournalView(ConditionalLoginRequiredMixin, View):
     """
     Custom journal view for CustomObject instances.