Document save_object() on BulkImportView

This commit is contained in:
jeremystretch 2022-11-16 08:47:45 -05:00
parent de1b346da0
commit 80f5c96af3
3 changed files with 12 additions and 7 deletions

View File

@ -127,7 +127,8 @@ Below are the class definitions for NetBox's multi-object views. These views han
::: netbox.views.generic.BulkImportView ::: netbox.views.generic.BulkImportView
options: options:
members: false members:
- save_object
::: netbox.views.generic.BulkEditView ::: netbox.views.generic.BulkEditView
options: options:

View File

@ -807,11 +807,11 @@ class RackReservationImportView(generic.BulkImportView):
model_form = forms.RackReservationImportForm model_form = forms.RackReservationImportForm
table = tables.RackReservationTable table = tables.RackReservationTable
def save_object(self, obj_form, request): def save_object(self, object_form, request):
""" """
Assign the currently authenticated user to the RackReservation. Assign the currently authenticated user to the RackReservation.
""" """
instance = obj_form.save(commit=False) instance = object_form.save(commit=False)
instance.user = request.user instance.user = request.user
instance.save() instance.save()
@ -2031,8 +2031,8 @@ class ChildDeviceBulkImportView(generic.BulkImportView):
table = tables.DeviceImportTable table = tables.DeviceImportTable
template_name = 'dcim/device_import_child.html' template_name = 'dcim/device_import_child.html'
def save_object(self, obj_form, request): def save_object(self, object_form, request):
obj = obj_form.save() obj = object_form.save()
# Save the reverse relation to the parent device bay # Save the reverse relation to the parent device bay
device_bay = obj.parent_bay device_bay = obj.parent_bay

View File

@ -345,11 +345,15 @@ class BulkImportView(GetReturnURLMixin, BaseMultiObjectView):
return obj return obj
def save_object(self, obj_form, request): def save_object(self, object_form, request):
""" """
Provide a hook to modify the object immediately before saving it (e.g. to encrypt secret data). Provide a hook to modify the object immediately before saving it (e.g. to encrypt secret data).
Args:
object_form: The model form instance
request: The current request
""" """
return obj_form.save() return object_form.save()
def create_and_update_objects(self, form, request): def create_and_update_objects(self, form, request):
saved_objects = [] saved_objects = []