Skip to content

Avoid executing querysets when getting the string representation of Serializers with related fields #7783

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Avoid executing querysets when getting the string representation of Serializers with related fields #7783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ff4974
Use the str representation of a queryset instead of the __repr__
michelts Mar 6, 2021
a8ef076
Remove unecessary import
michelts Mar 6, 2021
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
7 changes: 7 additions & 0 deletions rest_framework/utils/representation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,17 @@ def manager_repr(value):
return repr(value)


def queryset_repr(queryset):
return "{}".format(queryset.query)


def smart_repr(value):
if isinstance(value, models.Manager):
return manager_repr(value)

if isinstance(value, models.QuerySet):
value = queryset_repr(value)

if isinstance(value, Promise) and value._delegate_text:
value = force_str(value)

Expand Down
12 changes: 12 additions & 0 deletions tests/test_model_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,18 @@ class Meta:
""")
self.assertEqual(repr(TestSerializer()), expected)

def test_manual_pk_relation_will_customize_queryset_repr_to_avoid_execute_it(self):
queryset = ForeignKeyTargetModel.objects.all()

class TestSerializer(serializers.Serializer):
field = serializers.PrimaryKeyRelatedField(queryset=queryset)

expected = dedent("""
TestSerializer():
field = PrimaryKeyRelatedField(queryset='{}')
""")
self.assertEqual(repr(TestSerializer()), expected.format(queryset.query))

def test_nested_relations(self):
class TestSerializer(serializers.ModelSerializer):
class Meta:
Expand Down