fix: handle non-string initial values in disabled TagField - #949
Open
SparshGarg999 wants to merge 1 commit into
Open
fix: handle non-string initial values in disabled TagField#949SparshGarg999 wants to merge 1 commit into
SparshGarg999 wants to merge 1 commit into
Conversation
When TagField has disabled=True, Django passes the initial value into clean().
For ModelForms or initial values providing model instances or tag lists,
super().clean() converted the list to a string ('[<Tag: ...>]') which was
subsequently corrupted by parse_tags().
Safely return non-string values and handle string/None initials when disabled.
Fixes jazzband#943
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #943.
When a form field using
TagFieldis set todisabled=True, Django's form handling passes the field'sinitialvalue directly intoclean(self, value).For ModelForms (or forms where initial data is provided as a QuerySet or list of
Tagmodel instances),super().clean(value)converts the list of tag instances into its string representation ('[<Tag: apple>, <Tag: banana>]'). This was subsequently parsed byparse_tags(), corrupting the tag names into strings like'[<Tag: apple>'and'<Tag: banana>]'.Changes
taggit/forms.py, updatedTagField.clean(self, value):self.disabledisTrue, ifvalueis not a string, return[] if value is None else value.valueis a string, clean and parse it normally.tests/test_forms.py, added unit tests for:TagFieldwith a list ofTagmodel instances.TagFieldwith a stringinitialvalue.TagFieldwithNoneinitialvalue.TagFieldon a ModelForm (FoodForm), ensuringform.save()preserves the original model tags untouched.CHANGELOG.rst, added an entry under(Unreleased).Validation
python -m django test --settings=tests.settings(407 tests passed).black,flake8, andisort.