Skip to content

Fix ListSerializer.get_initial to return consistent initial list structure #9822

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −3
Open

Fix ListSerializer.get_initial to return consistent initial list structure #9822

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7166a78
Refactor get_initial for list input handlingFix ListSerializer.get_in…
shrajal01 Nov 10, 2025
8fa867a
Fix indentation and implementation of get_initial in ListSerializer
shrajal01 Nov 11, 2025
3e19d6a
Remove unnecessary blank lines in serializers.py
shrajal01 Nov 11, 2025
dc1e9d2
Update serializers.py
shrajal01 Nov 11, 2025
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
12 changes: 9 additions & 3 deletions rest_framework/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ class ListSerializer(BaseSerializer):
'max_length': _('Ensure this field has no more than {max_length} elements.'),
'min_length': _('Ensure this field has at least {min_length} elements.')
}

def __init__(self, *args, **kwargs):
self.child = kwargs.pop('child', copy.deepcopy(self.child))
self.allow_empty = kwargs.pop('allow_empty', True)
Expand All @@ -609,10 +609,16 @@ def __init__(self, *args, **kwargs):
self.child.bind(field_name='', parent=self)

def get_initial(self):
"""
Return a list of initial values, one for each item in `initial_data`,
or an empty list if no input data was provided.
"""
if hasattr(self, 'initial_data'):
return self.to_representation(self.initial_data)
if isinstance(self.initial_data, list):
return [self.child.get_initial() for _ in self.initial_data]
Copy link
Collaborator

@peterthomassen peterthomassen Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not seem correct, as all the list items would be the same.

return []
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return [] statement on line 620 is unreachable code. When hasattr(self, 'initial_data') is True, the code returns either on line 618 (if initial_data is a list) or on line 619 (if it's not a list). When the condition is False, execution jumps directly to line 620.

This results in redundant code since line 619 and line 620 both return the same empty list.

Suggested fix - remove line 619 and keep only line 620:

def get_initial(self):
    """
    Return a list of initial values, one for each item in `initial_data`,
    or an empty list if no input data was provided.
    """
    if hasattr(self, 'initial_data'):
        if isinstance(self.initial_data, list):
            return [self.child.get_initial() for _ in self.initial_data]
    return []
Suggested change
return []

Copilot uses AI. Check for mistakes.
return []

def get_value(self, dictionary):
"""
Given the input dictionary, return the field value.
Expand Down
Loading