Skip to content

Commit

Permalink
Fixed #34899 -- Added blank choice to forms' callable choices lazily.
Browse files Browse the repository at this point in the history
  • Loading branch information
ngnpope authored and nessita committed Oct 23, 2023
1 parent 74afcee commit 171f91d
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 8 deletions.
10 changes: 3 additions & 7 deletions django/db/models/fields/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from django.db.models.query_utils import DeferredAttribute, RegisterLookupMixin
from django.utils import timezone
from django.utils.choices import (
BlankChoiceIterator,
CallableChoiceIterator,
flatten_choices,
normalize_choices,
Expand Down Expand Up @@ -1055,14 +1056,9 @@ def get_choices(
as <select> choices for this field.
"""
if self.choices is not None:
choices = list(self.choices)
if include_blank:
blank_defined = any(
choice in ("", None) for choice, _ in self.flatchoices
)
if not blank_defined:
choices = blank_choice + choices
return choices
return BlankChoiceIterator(self.choices, blank_choice)
return self.choices
rel_model = self.remote_field.model
limit_choices_to = limit_choices_to or self.get_limit_choices_to()
choice_func = operator.attrgetter(
Expand Down
17 changes: 16 additions & 1 deletion django/utils/choices.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
from collections.abc import Callable, Iterable, Iterator, Mapping
from itertools import islice, zip_longest
from itertools import islice, tee, zip_longest

from django.utils.functional import Promise

__all__ = [
"BaseChoiceIterator",
"BlankChoiceIterator",
"CallableChoiceIterator",
"flatten_choices",
"normalize_choices",
Expand Down Expand Up @@ -34,6 +35,20 @@ def __iter__(self):
)


class BlankChoiceIterator(BaseChoiceIterator):
"""Iterator to lazily inject a blank choice."""

def __init__(self, choices, blank_choice):
self.choices = choices
self.blank_choice = blank_choice

def __iter__(self):
choices, other = tee(self.choices)
if not any(value in ("", None) for value, _ in flatten_choices(other)):
yield from self.blank_choice
yield from choices


class CallableChoiceIterator(BaseChoiceIterator):
"""Iterator to lazily normalize choices generated by a callable."""

Expand Down
33 changes: 33 additions & 0 deletions tests/model_forms/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from django.template import Context, Template
from django.test import SimpleTestCase, TestCase, ignore_warnings, skipUnlessDBFeature
from django.test.utils import isolate_apps
from django.utils.choices import BlankChoiceIterator
from django.utils.deprecation import RemovedInDjango60Warning

from .models import (
Expand Down Expand Up @@ -2012,6 +2013,38 @@ def test_runtime_choicefield_populated(self):
),
)

@isolate_apps("model_forms")
def test_callable_choices_are_lazy(self):
call_count = 0

def get_animal_choices():
nonlocal call_count
call_count += 1
return [("LION", "Lion"), ("ZEBRA", "Zebra")]

class ZooKeeper(models.Model):
animal = models.CharField(
blank=True,
choices=get_animal_choices,
max_length=5,
)

class ZooKeeperForm(forms.ModelForm):
class Meta:
model = ZooKeeper
fields = ["animal"]

self.assertEqual(call_count, 0)
form = ZooKeeperForm()
self.assertEqual(call_count, 0)
self.assertIsInstance(form.fields["animal"].choices, BlankChoiceIterator)
self.assertEqual(call_count, 0)
self.assertEqual(
form.fields["animal"].choices,
models.BLANK_CHOICE_DASH + [("LION", "Lion"), ("ZEBRA", "Zebra")],
)
self.assertEqual(call_count, 1)

def test_recleaning_model_form_instance(self):
"""
Re-cleaning an instance that was added via a ModelForm shouldn't raise
Expand Down

0 comments on commit 171f91d

Please sign in to comment.