Skip to content

Allow type checkers to make serializers generic #7385

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.

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

Merged
merged 1 commit into from
Jul 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions rest_framework/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ def __new__(cls, *args, **kwargs):
return cls.many_init(*args, **kwargs)
return super().__new__(cls, *args, **kwargs)

# Allow type checkers to make serializers generic.
def __class_getitem__(cls, *args, **kwargs):
return cls

@classmethod
def many_init(cls, *args, **kwargs):
"""
Expand Down
8 changes: 8 additions & 0 deletions tests/test_serializer.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import inspect
import pickle
import re
import sys
from collections import ChainMap
from collections.abc import Mapping

Expand Down Expand Up @@ -204,6 +205,13 @@ class ExampleSerializer(serializers.Serializer):
exceptions.ErrorDetail(string='Raised error', code='invalid')
]}

@pytest.mark.skipif(
sys.version_info < (3, 7),
reason="subscriptable classes requires Python 3.7 or higher",
)
def test_serializer_is_subscriptable(self):
assert serializers.Serializer is serializers.Serializer["foo"]


class TestValidateMethod:
def test_non_field_error_validate_method(self):
Expand Down
9 changes: 9 additions & 0 deletions tests/test_serializer_lists.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import sys

import pytest
from django.http import QueryDict
from django.utils.datastructures import MultiValueDict
Expand Down Expand Up @@ -55,6 +57,13 @@ def test_validate_html_input(self):
assert serializer.is_valid()
assert serializer.validated_data == expected_output

@pytest.mark.skipif(
sys.version_info < (3, 7),
reason="subscriptable classes requires Python 3.7 or higher",
)
def test_list_serializer_is_subscriptable(self):
assert serializers.ListSerializer is serializers.ListSerializer["foo"]


class TestListSerializerContainingNestedSerializer:
"""
Expand Down