Commit e6545c8

committed

Verified in all fields whether reserved field names are used

In meta class only specifically declared fields in serializer are accessible. In case of `ModelSerializer` fields may be just on the model or if a user has overwritten what fields are being returned during runtime DJA won't notice. So there does not seem to be another way then simply hooking into the `get_fields` method to check for reserved field names.

1 parent 0816192 commit e6545c8Copy full SHA for e6545c8

File tree

2 files changed

+26

-19

lines changed

rest_framework_json_api
- serializers.py
tests
- test_serializers.py

2 files changed

+26

-19

lines changed

`‎rest_framework_json_api/serializers.py‎`

Lines changed: 24 additions & 19 deletions

Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,27 @@ def validate_path(serializer_class, field_path, path):`
`153`	`153`	`super().__init__(args, *kwargs)`
`154`	`154`
`155`	`155`
	`156`	`+class ReservedFieldNamesMixin:`
	`157`	`+ """Ensures that reserved field names are not used and an error raised instead."""`
	`158`	`+`
	`159`	`+ _reserved_field_names = {"meta", "results"}`
	`160`	`+`
	`161`	`+ def get_fields(self):`
	`162`	`+ fields = super().get_fields()`
	`163`	`+`
	`164`	`+ found_reserved_field_names = self._reserved_field_names.intersection(`
	`165`	`+ fields.keys()`
	`166`	`+ )`
	`167`	`+ if found_reserved_field_names:`
	`168`	`+ raise AttributeError(`
	`169`	`+ f"Serializer class {self.__class__.__module__}.{self.__class__.__qualname__} "`
	`170`	`+ f"uses following reserved field name(s) which is not allowed: "`
	`171`	`+ f"{', '.join(sorted(found_reserved_field_names))}"`
	`172`	`+ )`
	`173`	`+`
	`174`	`+ return fields`
	`175`	`+`
	`176`	`+`
`156`	`177`	`class LazySerializersDict(Mapping):`
`157`	`178`	`"""`
`158`	`179`	`A dictionary of serializers which lazily import dotted class path and self.`
`@@ -184,25 +205,6 @@ def __repr__(self):`
`184`	`205`
`185`	`206`
`186`	`207`	`class SerializerMetaclass(SerializerMetaclass):`
`187`		`-`
`188`		`- _reserved_field_names = {"meta", "results"}`
`189`		`-`
`190`		`- @classmethod`
`191`		`- def _get_declared_fields(cls, bases, attrs):`
`192`		`- fields = super()._get_declared_fields(bases, attrs)`
`193`		`-`
`194`		`- found_reserved_field_names = cls._reserved_field_names.intersection(`
`195`		`- fields.keys()`
`196`		`- )`
`197`		`- if found_reserved_field_names:`
`198`		`- raise AttributeError(`
`199`		`- f"Serializer class {attrs['__module__']}.{attrs['__qualname__']} uses "`
`200`		`- f"following reserved field name(s) which is not allowed: "`
`201`		`- f"{', '.join(sorted(found_reserved_field_names))}"`
`202`		`- )`
`203`		`-`
`204`		`- return fields`
`205`		`-`
`206`	`208`	`def __new__(cls, name, bases, attrs):`
`207`	`209`	`serializer = super().__new__(cls, name, bases, attrs)`
`208`	`210`
`@@ -228,6 +230,7 @@ def __new__(cls, name, bases, attrs):`
`228`	`230`	`class Serializer(`
`229`	`231`	`IncludedResourcesValidationMixin,`
`230`	`232`	`SparseFieldsetsMixin,`
	`233`	`+ ReservedFieldNamesMixin,`
`231`	`234`	`Serializer,`
`232`	`235`	`metaclass=SerializerMetaclass,`
`233`	`236`	`):`
`@@ -251,6 +254,7 @@ class Serializer(`
`251`	`254`	`class HyperlinkedModelSerializer(`
`252`	`255`	`IncludedResourcesValidationMixin,`
`253`	`256`	`SparseFieldsetsMixin,`
	`257`	`+ ReservedFieldNamesMixin,`
`254`	`258`	`HyperlinkedModelSerializer,`
`255`	`259`	`metaclass=SerializerMetaclass,`
`256`	`260`	`):`
`@@ -271,6 +275,7 @@ class HyperlinkedModelSerializer(`
`271`	`275`	`class ModelSerializer(`
`272`	`276`	`IncludedResourcesValidationMixin,`
`273`	`277`	`SparseFieldsetsMixin,`
	`278`	`+ ReservedFieldNamesMixin,`
`274`	`279`	`ModelSerializer,`
`275`	`280`	`metaclass=SerializerMetaclass,`
`276`	`281`	`):`

`‎tests/test_serializers.py‎`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,8 @@ class ReservedFieldNamesSerializer(serializers.Serializer):`
`43`	`43`	`meta = serializers.CharField()`
`44`	`44`	`results = serializers.CharField()`
`45`	`45`
	`46`	`+ ReservedFieldNamesSerializer().fields`
	`47`	`+`
`46`	`48`	`assert str(e.value) == (`
`47`	`49`	`"Serializer class tests.test_serializers.test_reserved_field_names.<locals>."`
`48`	`50`	`"ReservedFieldNamesSerializer uses following reserved field name(s) which is "`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit e6545c8

File tree

2 files changed

2 files changed

`‎rest_framework_json_api/serializers.py‎`

`‎tests/test_serializers.py‎`

0 commit comments