diff options
| author | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2025-11-19 08:22:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-11-19 08:22:44 +0100 |
| commit | 97acd4d2f92eef8c285bac070d437bf0fd52e071 (patch) | |
| tree | 62de2c4f5299318d8cffbf67d544f239c1d7fc07 | |
| parent | e05f2a75695b5f5faa7682d4053db4776d4d6f93 (diff) | |
Fixed #26609 -- Extended fields.E004 system check for unordered iterables.
Co-authored-by: Karl Wooster <karl.wooster@alleima.com>
| -rw-r--r-- | django/db/models/fields/__init__.py | 8 | ||||
| -rw-r--r-- | docs/ref/checks.txt | 2 | ||||
| -rw-r--r-- | tests/invalid_models_tests/test_ordinary_fields.py | 42 |
3 files changed, 44 insertions, 8 deletions
diff --git a/django/db/models/fields/__init__.py b/django/db/models/fields/__init__.py index 27d5657078..b380fcbb55 100644 --- a/django/db/models/fields/__init__.py +++ b/django/db/models/fields/__init__.py @@ -316,11 +316,13 @@ class Field(RegisterLookupMixin): if not self.choices: return [] - if not isinstance(self.choices, Iterable) or isinstance(self.choices, str): + if not isinstance(self.choices, Iterable) or isinstance( + self.choices, (str, set, frozenset) + ): return [ checks.Error( - "'choices' must be a mapping (e.g. a dictionary) or an iterable " - "(e.g. a list or tuple).", + "'choices' must be a mapping (e.g. a dictionary) or an " + "ordered iterable (e.g. a list or tuple, but not a set).", obj=self, id="fields.E004", ) diff --git a/docs/ref/checks.txt b/docs/ref/checks.txt index 1a79023b89..966bca23b2 100644 --- a/docs/ref/checks.txt +++ b/docs/ref/checks.txt @@ -167,7 +167,7 @@ Model fields * **fields.E003**: ``pk`` is a reserved word that cannot be used as a field name. * **fields.E004**: ``choices`` must be a mapping (e.g. a dictionary) or an - iterable (e.g. a list or tuple). + ordered iterable (e.g. a list or tuple, but not a set). * **fields.E005**: ``choices`` must be a mapping of actual values to human readable names or an iterable containing ``(actual value, human readable name)`` tuples. diff --git a/tests/invalid_models_tests/test_ordinary_fields.py b/tests/invalid_models_tests/test_ordinary_fields.py index 2c2653a538..04c18d7ddd 100644 --- a/tests/invalid_models_tests/test_ordinary_fields.py +++ b/tests/invalid_models_tests/test_ordinary_fields.py @@ -199,8 +199,8 @@ class CharFieldTests(TestCase): field.check(), [ Error( - "'choices' must be a mapping (e.g. a dictionary) or an iterable " - "(e.g. a list or tuple).", + "'choices' must be a mapping (e.g. a dictionary) or an " + "ordered iterable (e.g. a list or tuple, but not a set).", obj=field, id="fields.E004", ), @@ -906,8 +906,42 @@ class IntegerFieldTests(SimpleTestCase): field.check(), [ Error( - "'choices' must be a mapping (e.g. a dictionary) or an iterable " - "(e.g. a list or tuple).", + "'choices' must be a mapping (e.g. a dictionary) or an " + "ordered iterable (e.g. a list or tuple, but not a set).", + obj=field, + id="fields.E004", + ), + ], + ) + + def test_unordered_choices_set(self): + class Model(models.Model): + field = models.IntegerField(choices={1, 2, 3}) + + field = Model._meta.get_field("field") + self.assertEqual( + field.check(), + [ + Error( + "'choices' must be a mapping (e.g. a dictionary) or an " + "ordered iterable (e.g. a list or tuple, but not a set).", + obj=field, + id="fields.E004", + ), + ], + ) + + def test_unordered_choices_frozenset(self): + class Model(models.Model): + field = models.IntegerField(choices=frozenset({1, 2, 3})) + + field = Model._meta.get_field("field") + self.assertEqual( + field.check(), + [ + Error( + "'choices' must be a mapping (e.g. a dictionary) or an " + "ordered iterable (e.g. a list or tuple, but not a set).", obj=field, id="fields.E004", ), |
