From 80f5c96af3e78232ffe2bcce7c27995612964596 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 16 Nov 2022 08:47:45 -0500 Subject: [PATCH] Document save_object() on BulkImportView --- docs/plugins/development/views.md | 3 ++- netbox/dcim/views.py | 8 ++++---- netbox/netbox/views/generic/bulk_views.py | 8 ++++++-- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/plugins/development/views.md b/docs/plugins/development/views.md index 9be1a9b6e..7f8a64744 100644 --- a/docs/plugins/development/views.md +++ b/docs/plugins/development/views.md @@ -127,7 +127,8 @@ Below are the class definitions for NetBox's multi-object views. These views han ::: netbox.views.generic.BulkImportView options: - members: false + members: + - save_object ::: netbox.views.generic.BulkEditView options: diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 12f9ff2fc..efedc58ab 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -807,11 +807,11 @@ class RackReservationImportView(generic.BulkImportView): model_form = forms.RackReservationImportForm 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. """ - instance = obj_form.save(commit=False) + instance = object_form.save(commit=False) instance.user = request.user instance.save() @@ -2031,8 +2031,8 @@ class ChildDeviceBulkImportView(generic.BulkImportView): table = tables.DeviceImportTable template_name = 'dcim/device_import_child.html' - def save_object(self, obj_form, request): - obj = obj_form.save() + def save_object(self, object_form, request): + obj = object_form.save() # Save the reverse relation to the parent device bay device_bay = obj.parent_bay diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 86ffbf224..444004623 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -345,11 +345,15 @@ class BulkImportView(GetReturnURLMixin, BaseMultiObjectView): 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). + + 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): saved_objects = []