Fix serializer method field hidden unique together (#9700) #9710
Conversation
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
Corrects an issue where a `SerializerMethodField` that shares its name with a model field involved in a `unique_together` constraint (or `UniqueConstraint`) could be incorrectly treated as a `HiddenField`. This typically occurred if the underlying model field was nullable or had a default value, and the `SerializerMethodField` was not being correctly prioritized during the uniqueness metadata processing. The `ModelSerializer.get_uniqueness_extra_kwargs` method has been updated to ensure that if a field name corresponding to a model field in a uniqueness constraint is explicitly declared as a `SerializerMethodField` on the serializer, it is not converted into a `HiddenField`. A test case has been added to `tests/test_model_serializer.py` (`TestSerializerMethodFieldInUniqueTogether`) to verify this behavior. NOTE: Due to persistent timeouts in the testing environment, I could not complete full test suite verification. Multiple attempts to run tests (full suite, specific module, specific class) timed out. The implemented fix is based on code analysis and the added specific test case logic. Relying on CI/CD pipeline for full test validation.
auvipy
suggested changes
May 27, 2025
| other_field = models.CharField(max_length=100, default="default_value") | ||
|
|
||
| class Meta: | ||
| unique_together = [("name", "description")] |
There was a problem hiding this comment.
why not using unique constraint here?
There was a problem hiding this comment.
Please tidy the diff in this file. It's clearly AI generated file (even the commit is not hiding that fact), with extra verbose comments. It should follow the style of the surrounding code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix: SerializerMethodField as HiddenField in unique_together
Corrects an issue where a
SerializerMethodFieldthat shares its namewith a model field involved in a
unique_togetherconstraint (orUniqueConstraint) could be incorrectly treated as aHiddenField.This typically occurred if the underlying model field was nullable or had
a default value, and the
SerializerMethodFieldwas not being correctlyprioritized during the uniqueness metadata processing.
The
ModelSerializer.get_uniqueness_extra_kwargsmethod has been updatedto ensure that if a field name corresponding to a model field in a
uniqueness constraint is explicitly declared as a
SerializerMethodFieldon the serializer, it is not converted into a
HiddenField.A test case has been added to
tests/test_model_serializer.py(
TestSerializerMethodFieldInUniqueTogether) to verify this behavior.