Skip to content

Fixes: #17794 - Setup get_field_value to return multiple values when required #19188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions netbox/utilities/forms/utils.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import re

from django import forms
from django.forms.models import fields_for_model
from django.forms import MultipleChoiceField
from django.forms.models import fields_for_model, ModelMultipleChoiceField
from django.utils.translation import gettext as _

from utilities.choices import unpack_grouped_choices
Expand Down Expand Up @@ -139,7 +140,16 @@ def get_field_value(form, field_name):
if form.is_bound and field_name in form.data:
if (value := form.data[field_name]) is None:
return
if hasattr(field, 'valid_value') and field.valid_value(value):
if isinstance(field, (MultipleChoiceField, ModelMultipleChoiceField)) and isinstance(value, (list, tuple)):
values = []
for v in value:
if hasattr(field, 'valid_value') and field.valid_value(v):
values.append(v)

if values:
return values

elif hasattr(field, 'valid_value') and field.valid_value(value):
return value

return form.get_initial_for_field(field, field_name)
Expand Down
27 changes: 27 additions & 0 deletions netbox/utilities/tests/test_forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -448,3 +448,30 @@ def test_bound_null_with_initial(self):
get_field_value(form, 'site'),
None
)


class MultipleGetFieldValueTest(GetFieldValueTest):
@classmethod
def setUpTestData(cls):
super().setUpTestData()

class TestForm(forms.Form):
site = forms.ModelMultipleChoiceField(
queryset=Site.objects.all(),
required=False
)
cls.form_class = TestForm

def test_bound_with_list_without_initial(self):
form = self.form_class({'site': (self.sites[0].pk, self.sites[1].pk)}, initial={'site': None})
self.assertEqual(
get_field_value(form, 'site'),
[self.sites[0].pk, self.sites[1].pk]
)

def test_bound_with_list_with_initial(self):
form = self.form_class({'site': (self.sites[0].pk, self.sites[1].pk)}, initial={'site': self.sites[0]})
self.assertEqual(
get_field_value(form, 'site'),
[self.sites[0].pk, self.sites[1].pk]
)