Skip to content

Commit 722e7ba

Browse files
committed
Rename arg for clarity
1 parent 7518535 commit 722e7ba

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

drf_rw_serializers/generics.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ def get_serializer_class(self):
3636
"attribute, or override the `get_read_serializer_class()` or "
3737
"`get_serializer_class()` method." % self.__class__.__name__
3838
)
39-
# `use_serializer_class` is used to prevent a `RecursionError`
40-
return self.get_read_serializer_class(use_serializer_class=True)
39+
# `default_to_serializer_class` is used to prevent a `RecursionError`
40+
return self.get_read_serializer_class(default_to_serializer_class=True)
4141

4242
if self.request.method in ["POST", "PUT", "PATCH", "DELETE"]:
4343
assert (
@@ -48,8 +48,8 @@ def get_serializer_class(self):
4848
"attribute, or override the `get_write_serializer_class()` or "
4949
"`get_serializer_class()` method." % self.__class__.__name__
5050
)
51-
# `use_serializer_class` is used to prevent a `RecursionError`
52-
return self.get_write_serializer_class(use_serializer_class=True)
51+
# `default_to_serializer_class` is used to prevent a `RecursionError`
52+
return self.get_write_serializer_class(default_to_serializer_class=True)
5353

5454
assert (
5555
self.serializer_class is not None
@@ -70,7 +70,7 @@ def get_read_serializer(self, *args, **kwargs):
7070
kwargs["context"] = self.get_serializer_context()
7171
return serializer_class(*args, **kwargs)
7272

73-
def get_read_serializer_class(self, use_serializer_class: bool = False):
73+
def get_read_serializer_class(self, default_to_serializer_class: bool = False):
7474
"""
7575
Return the class to use for the serializer.
7676
Defaults to using `self.read_serializer_class`.
@@ -81,7 +81,7 @@ def get_read_serializer_class(self, use_serializer_class: bool = False):
8181
(Eg. admins get full serialization, others get basic serialization)
8282
"""
8383
if getattr(self, "read_serializer_class", None) is None:
84-
if use_serializer_class:
84+
if default_to_serializer_class:
8585
return self.serializer_class
8686

8787
return self.get_serializer_class()
@@ -97,7 +97,7 @@ def get_write_serializer(self, *args, **kwargs):
9797
kwargs["context"] = self.get_serializer_context()
9898
return serializer_class(*args, **kwargs)
9999

100-
def get_write_serializer_class(self, use_serializer_class: bool = False):
100+
def get_write_serializer_class(self, default_to_serializer_class: bool = False):
101101
"""
102102
Return the class to use for the serializer.
103103
Defaults to using `self.write_serializer_class`.
@@ -108,7 +108,7 @@ def get_write_serializer_class(self, use_serializer_class: bool = False):
108108
(Eg. admins can send extra fields, others cannot)
109109
"""
110110
if getattr(self, "write_serializer_class", None) is None:
111-
if use_serializer_class:
111+
if default_to_serializer_class:
112112
return self.serializer_class
113113

114114
return self.get_serializer_class()

tests/test_generics.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,10 @@ class GetSerializerClassView(generics.GenericAPIView):
128128
def get_serializer_class(self):
129129
return OrderedMealDetailsSerializer
130130

131-
def get_read_serializer_class(self, use_serializer_class: bool = False):
131+
def get_read_serializer_class(self, default_to_serializer_class: bool = False):
132132
return OrderListSerializer
133133

134-
def get_write_serializer_class(self, use_serializer_class: bool = False):
134+
def get_write_serializer_class(self, default_to_serializer_class: bool = False):
135135
return OrderCreateSerializer
136136

137137
self.assertEqual(
@@ -169,20 +169,20 @@ class SerializerClassView(generics.GenericAPIView):
169169
serializer_class = OrderedMealDetailsSerializer
170170

171171
self.assertEqual(
172-
SerializerClassView().get_read_serializer_class(use_serializer_class=True),
172+
SerializerClassView().get_read_serializer_class(default_to_serializer_class=True),
173173
OrderedMealDetailsSerializer,
174174
)
175175

176176
with mock.patch.object(
177177
SerializerClassView, "get_serializer_class"
178178
) as mock_get_serializer_class:
179-
SerializerClassView().get_read_serializer_class(use_serializer_class=False)
179+
SerializerClassView().get_read_serializer_class(default_to_serializer_class=False)
180180

181181
mock_get_serializer_class.assert_called_once()
182182

183183
def test_get_read_serializer_class_override_provided(self):
184184
class GetReadSerializerClassView(generics.GenericAPIView):
185-
def get_read_serializer_class(self, use_serializer_class: bool = False):
185+
def get_read_serializer_class(self, default_to_serializer_class: bool = False):
186186
return OrderListSerializer
187187

188188
self.assertEqual(
@@ -216,20 +216,20 @@ class SerializerClassView(generics.GenericAPIView):
216216
serializer_class = OrderedMealDetailsSerializer
217217

218218
self.assertEqual(
219-
SerializerClassView().get_write_serializer_class(use_serializer_class=True),
219+
SerializerClassView().get_write_serializer_class(default_to_serializer_class=True),
220220
OrderedMealDetailsSerializer,
221221
)
222222

223223
with mock.patch.object(
224224
SerializerClassView, "get_serializer_class"
225225
) as mock_get_serializer_class:
226-
SerializerClassView().get_write_serializer_class(use_serializer_class=False)
226+
SerializerClassView().get_write_serializer_class(default_to_serializer_class=False)
227227

228228
mock_get_serializer_class.assert_called_once()
229229

230230
def test_get_write_serializer_class_override_provided(self):
231231
class GetWriteSerializerClassView(generics.GenericAPIView):
232-
def get_write_serializer_class(self, use_serializer_class: bool = False):
232+
def get_write_serializer_class(self, default_to_serializer_class: bool = False):
233233
return OrderCreateSerializer
234234

235235
self.assertEqual(

0 commit comments

Comments
 (0)