#4347: Rename NetBoxModelCSVForm to NetBoxModelImportForm

Author: jeremystretch

docs/plugins/development/forms.md

@@ -4,11 +4,11 @@
 
 NetBox provides several base form classes for use by plugins.
 
-| Form Class                | Purpose                              |
-|---------------------------|--------------------------------------|
-| `NetBoxModelForm`         | Create/edit individual objects       |
-| `NetBoxModelCSVForm`      | Bulk import objects from CSV data    |
-| `NetBoxModelBulkEditForm` | Edit multiple objects simultaneously |
+| Form Class                 | Purpose                              |
+|----------------------------|--------------------------------------|
+| `NetBoxModelForm`          | Create/edit individual objects       |
+| `NetBoxModelImportForm`    | Bulk import objects from CSV data    |
+| `NetBoxModelBulkEditForm`  | Edit multiple objects simultaneously |
 | `NetBoxModelFilterSetForm` | Filter objects within a list view   |
 
 ### `NetBoxModelForm`
@@ -45,19 +45,20 @@ class MyModelForm(NetBoxModelForm):
 !!! tip "Comment fields"
     If your form has a `comments` field, there's no need to list it; this will always appear last on the page.
 
-### `NetBoxModelCSVForm`
+### `NetBoxModelImportForm`
 
-This form facilitates the bulk import of new objects from CSV data. As with model forms, you'll need to declare a `Meta` subclass specifying the associated `model` and `fields`. NetBox also provides several form fields suitable for import various types of CSV data, listed below.
+This form facilitates the bulk import of new objects from CSV, JSON, or YAML data. As with model forms, you'll need to declare a `Meta` subclass specifying the associated `model` and `fields`. NetBox also provides several form fields suitable for import various types of CSV data, listed below.
 
 **Example**
 
 ```python
 from dcim.models import Site
-from netbox.forms import NetBoxModelCSVForm
+from netbox.forms import NetBoxModelImportForm
 from utilities.forms import CSVModelChoiceField
 from .models import MyModel
 
-class MyModelCSVForm(NetBoxModelCSVForm):
+
+class MyModelImportForm(NetBoxModelImportForm):
     site = CSVModelChoiceField(
         queryset=Site.objects.all(),
         to_field_name='name',
@@ -69,6 +70,9 @@ class MyModelCSVForm(NetBoxModelCSVForm):
         fields = ('name', 'status', 'site', 'comments')
 ```
 
+!!! note "Previously NetBoxModelCSVForm"
+    This form class was previously named `NetBoxModelCSVForm`. It was renamed in NetBox v3.4 to convey support for JSON and YAML formats in addition to CSV. The `NetBoxModelCSVForm` class has been retained for backward compatibility and functions exactly the same as `NetBoxModelImportForm`. However, plugin authors should be aware that this backward compatability will be removed in NetBox v3.5.
+
 ### `NetBoxModelBulkEditForm`
 
 This form facilitates editing multiple objects in bulk. Unlike a model form, this form does not have a child `Meta` class, and must explicitly define each field. All fields in a bulk edit form are generally declared with `required=False`.
@@ -84,11 +88,12 @@ This form facilitates editing multiple objects in bulk. Unlike a model form, thi
 ```python
 from django import forms
 from dcim.models import Site
-from netbox.forms import NetBoxModelCSVForm
+from netbox.forms import NetBoxModelImportForm
 from utilities.forms import CommentField, DynamicModelChoiceField
 from .models import MyModel, MyModelStatusChoices
 
-class MyModelEditForm(NetBoxModelCSVForm):
+
+class MyModelEditForm(NetBoxModelImportForm):
     name = forms.CharField(
         required=False
     )

docs/release-notes/version-3.4.md

@@ -10,6 +10,7 @@
 * The `noc_contact`, `admin_contact`, and `portal_url` fields have been removed from the provider model. Please replicate any data remaining in these fields to the contact model introduced in NetBox v3.1 prior to upgrading.
 * The `content_type` field on the CustomLink and ExportTemplate models have been renamed to `content_types` and now supports the assignment of multiple content types.
 * The `cf` property on an object with custom fields now returns deserialized values. For example, a custom field referencing an object will return the object instance rather than its numeric ID. To access the raw serialized values, use `custom_field_data` instead.
+* The `NetBoxModelCSVForm` class has been renamed to `NetBoxModelImportForm`. Backward compatability with the previous name has been retained for this release, but will be dropped in NetBox v3.5.
 
 ### New Features
 

netbox/circuits/forms/bulk_import.py

@@ -1,19 +1,19 @@
 from circuits.choices import CircuitStatusChoices
 from circuits.models import *
 from django.utils.translation import gettext as _
-from netbox.forms import NetBoxModelCSVForm
+from netbox.forms import NetBoxModelImportForm
 from tenancy.models import Tenant
 from utilities.forms import CSVChoiceField, CSVModelChoiceField, SlugField
 
 __all__ = (
-    'CircuitCSVForm',
-    'CircuitTypeCSVForm',
-    'ProviderCSVForm',
-    'ProviderNetworkCSVForm',
+    'CircuitImportForm',
+    'CircuitTypeImportForm',
+    'ProviderImportForm',
+    'ProviderNetworkImportForm',
 )
 
 
-class ProviderCSVForm(NetBoxModelCSVForm):
+class ProviderImportForm(NetBoxModelImportForm):
     slug = SlugField()
 
     class Meta:
@@ -23,7 +23,7 @@ class Meta:
         )
 
 
-class ProviderNetworkCSVForm(NetBoxModelCSVForm):
+class ProviderNetworkImportForm(NetBoxModelImportForm):
     provider = CSVModelChoiceField(
         queryset=Provider.objects.all(),
         to_field_name='name',
@@ -37,7 +37,7 @@ class Meta:
         ]
 
 
-class CircuitTypeCSVForm(NetBoxModelCSVForm):
+class CircuitTypeImportForm(NetBoxModelImportForm):
     slug = SlugField()
 
     class Meta:
@@ -48,7 +48,7 @@ class Meta:
         }
 
 
-class CircuitCSVForm(NetBoxModelCSVForm):
+class CircuitImportForm(NetBoxModelImportForm):
     provider = CSVModelChoiceField(
         queryset=Provider.objects.all(),
         to_field_name='name',

netbox/circuits/views.py

@@ -57,7 +57,7 @@ class ProviderDeleteView(generic.ObjectDeleteView):
 
 class ProviderBulkImportView(generic.BulkImportView):
     queryset = Provider.objects.all()
-    model_form = forms.ProviderCSVForm
+    model_form = forms.ProviderImportForm
     table = tables.ProviderTable
 
 
@@ -122,7 +122,7 @@ class ProviderNetworkDeleteView(generic.ObjectDeleteView):
 
 class ProviderNetworkBulkImportView(generic.BulkImportView):
     queryset = ProviderNetwork.objects.all()
-    model_form = forms.ProviderNetworkCSVForm
+    model_form = forms.ProviderNetworkImportForm
     table = tables.ProviderNetworkTable
 
 
@@ -179,7 +179,7 @@ class CircuitTypeDeleteView(generic.ObjectDeleteView):
 
 class CircuitTypeBulkImportView(generic.BulkImportView):
     queryset = CircuitType.objects.all()
-    model_form = forms.CircuitTypeCSVForm
+    model_form = forms.CircuitTypeImportForm
     table = tables.CircuitTypeTable
 
 
@@ -231,7 +231,7 @@ class CircuitDeleteView(generic.ObjectDeleteView):
 
 class CircuitBulkImportView(generic.BulkImportView):
     queryset = Circuit.objects.all()
-    model_form = forms.CircuitCSVForm
+    model_form = forms.CircuitImportForm
     table = tables.CircuitTable