Skip to content

Verified in all fields whether reserved field names are used #992

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
Oct 8, 2021
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
43 changes: 24 additions & 19 deletions rest_framework_json_api/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,27 @@ def validate_path(serializer_class, field_path, path):
super().__init__(*args, **kwargs)


class ReservedFieldNamesMixin:
"""Ensures that reserved field names are not used and an error raised instead."""

_reserved_field_names = {"meta", "results"}

def get_fields(self):
fields = super().get_fields()

found_reserved_field_names = self._reserved_field_names.intersection(
fields.keys()
)
if found_reserved_field_names:
raise AttributeError(
f"Serializer class {self.__class__.__module__}.{self.__class__.__qualname__} "
f"uses following reserved field name(s) which is not allowed: "
f"{', '.join(sorted(found_reserved_field_names))}"
)

return fields


class LazySerializersDict(Mapping):
"""
A dictionary of serializers which lazily import dotted class path and self.
Expand Down Expand Up @@ -184,25 +205,6 @@ def __repr__(self):


class SerializerMetaclass(SerializerMetaclass):

_reserved_field_names = {"meta", "results"}

@classmethod
def _get_declared_fields(cls, bases, attrs):
fields = super()._get_declared_fields(bases, attrs)

found_reserved_field_names = cls._reserved_field_names.intersection(
fields.keys()
)
if found_reserved_field_names:
raise AttributeError(
f"Serializer class {attrs['__module__']}.{attrs['__qualname__']} uses "
f"following reserved field name(s) which is not allowed: "
f"{', '.join(sorted(found_reserved_field_names))}"
)

return fields

def __new__(cls, name, bases, attrs):
serializer = super().__new__(cls, name, bases, attrs)

Expand All @@ -228,6 +230,7 @@ def __new__(cls, name, bases, attrs):
class Serializer(
IncludedResourcesValidationMixin,
SparseFieldsetsMixin,
ReservedFieldNamesMixin,
Serializer,
metaclass=SerializerMetaclass,
):
Expand All @@ -251,6 +254,7 @@ class Serializer(
class HyperlinkedModelSerializer(
IncludedResourcesValidationMixin,
SparseFieldsetsMixin,
ReservedFieldNamesMixin,
HyperlinkedModelSerializer,
metaclass=SerializerMetaclass,
):
Expand All @@ -271,6 +275,7 @@ class HyperlinkedModelSerializer(
class ModelSerializer(
IncludedResourcesValidationMixin,
SparseFieldsetsMixin,
ReservedFieldNamesMixin,
ModelSerializer,
metaclass=SerializerMetaclass,
):
Expand Down
2 changes: 2 additions & 0 deletions tests/test_serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ class ReservedFieldNamesSerializer(serializers.Serializer):
meta = serializers.CharField()
results = serializers.CharField()

ReservedFieldNamesSerializer().fields

assert str(e.value) == (
"Serializer class tests.test_serializers.test_reserved_field_names.<locals>."
"ReservedFieldNamesSerializer uses following reserved field name(s) which is "
Expand Down