1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
from django.utils.translation import get_language
from django.db.models.query import EmptyQuerySet
from django.core.exceptions import EmptyResultSet
from django.utils.encoding import force_str
from rest_framework_extensions import compat
class AllArgsMixin:
def __init__(self, params='*'):
super().__init__(params)
class KeyBitBase:
def __init__(self, params=None):
self.params = params
def get_data(self, params, view_instance, view_method, request, args, kwargs):
"""
@rtype: dict
"""
raise NotImplementedError()
class KeyBitDictBase(KeyBitBase):
"""Base class for dict-like source data processing.
Look at HeadersKeyBit and QueryParamsKeyBit
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
data = {}
if params is not None:
source_dict = self.get_source_dict(
params=params,
view_instance=view_instance,
view_method=view_method,
request=request,
args=args,
kwargs=kwargs
)
if params == '*':
params = source_dict.keys()
for key in params:
value = source_dict.get(
self.prepare_key_for_value_retrieving(key))
if value is not None:
data[self.prepare_key_for_value_assignment(
key)] = force_str(value)
return data
def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
raise NotImplementedError()
def prepare_key_for_value_retrieving(self, key):
return key
def prepare_key_for_value_assignment(self, key):
return key
class UniqueViewIdKeyBit(KeyBitBase):
def get_data(self, params, view_instance, view_method, request, args, kwargs):
return '.'.join([
view_instance.__module__,
view_instance.__class__.__name__
])
class UniqueMethodIdKeyBit(KeyBitBase):
def get_data(self, params, view_instance, view_method, request, args, kwargs):
return '.'.join([
view_instance.__module__,
view_instance.__class__.__name__,
view_method.__name__
])
class LanguageKeyBit(KeyBitBase):
"""
Return example:
'en'
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
return force_str(get_language())
class FormatKeyBit(KeyBitBase):
"""
Return example for json:
u'json'
Return example for html:
u'html'
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
return force_str(request.accepted_renderer.format)
class UserKeyBit(KeyBitBase):
"""
Return example for anonymous:
u'anonymous'
Return example for authenticated (value is user id):
u'10'
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
if hasattr(request, 'user') and request.user and request.user.is_authenticated:
return force_str(self._get_id_from_user(request.user))
else:
return 'anonymous'
def _get_id_from_user(self, user):
return user.id
class HeadersKeyBit(KeyBitDictBase):
"""
Return example:
{'accept-language': u'ru', 'x-geobase-id': '123'}
"""
def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
return request.META
def prepare_key_for_value_retrieving(self, key):
from rest_framework_extensions.utils import prepare_header_name
# Accept-Language => http_accept_language
return prepare_header_name(key.lower())
def prepare_key_for_value_assignment(self, key):
return key.lower() # Accept-Language => accept-language
class RequestMetaKeyBit(KeyBitDictBase):
"""
Return example:
{'REMOTE_ADDR': u'127.0.0.2', 'REMOTE_HOST': u'yandex.ru'}
"""
def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
return request.META
class QueryParamsKeyBit(AllArgsMixin, KeyBitDictBase):
"""
Return example:
{'part': 'Londo', 'callback': 'jquery_callback'}
"""
def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
return request.GET
class PaginationKeyBit(QueryParamsKeyBit):
"""
Return example:
{'page_size': 100, 'page': '1'}
"""
paginator_attrs = [
'page_query_param', 'page_size_query_param',
'limit_query_param', 'offset_query_param',
'cursor_query_param',
]
def get_data(self, **kwargs):
kwargs['params'] = []
paginator = getattr(kwargs['view_instance'], 'paginator', None)
if paginator:
for attr in self.paginator_attrs:
param = getattr(paginator, attr, None)
if param:
kwargs['params'].append(param)
return super().get_data(**kwargs)
class SqlQueryKeyBitBase(KeyBitBase):
def _get_queryset_query_string(self, queryset):
if isinstance(queryset, EmptyQuerySet):
return None
else:
try:
return force_str(queryset.query.__str__())
except EmptyResultSet:
return None
class ModelInstanceKeyBitBase(KeyBitBase):
"""
Return the actual contents of the query set.
This class is similar to the `SqlQueryKeyBitBase`.
"""
def _get_queryset_query_values(self, queryset):
if isinstance(queryset, EmptyQuerySet) or queryset.count() == 0:
return None
else:
try:
# run through the instances and collect all values in ordered fashion
return compat.queryset_to_value_list(force_str(queryset.values_list()))
except EmptyResultSet:
return None
class ListSqlQueryKeyBit(SqlQueryKeyBitBase):
def get_data(self, params, view_instance, view_method, request, args, kwargs):
queryset = view_instance.filter_queryset(view_instance.get_queryset())
return self._get_queryset_query_string(queryset)
class RetrieveSqlQueryKeyBit(SqlQueryKeyBitBase):
def get_data(self, params, view_instance, view_method, request, args, kwargs):
lookup_value = view_instance.kwargs[
view_instance.lookup_url_kwarg or view_instance.lookup_field]
try:
queryset = view_instance.filter_queryset(view_instance.get_queryset()).filter(
**{view_instance.lookup_field: lookup_value}
)
except ValueError:
return None
else:
return self._get_queryset_query_string(queryset)
class RetrieveModelKeyBit(ModelInstanceKeyBitBase):
"""
A key bit reflecting the contents of the model instance.
Return example:
u"[(3, False)]"
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
lookup_value = view_instance.kwargs[view_instance.lookup_field]
try:
queryset = view_instance.filter_queryset(view_instance.get_queryset()).filter(
**{view_instance.lookup_field: lookup_value}
)
except ValueError:
return None
else:
return self._get_queryset_query_values(queryset)
class ListModelKeyBit(ModelInstanceKeyBitBase):
"""
A key bit reflecting the contents of a list of model instances.
Return example:
u"[(1, True), (2, True), (3, False)]"
"""
def get_data(self, params, view_instance, view_method, request, args, kwargs):
queryset = view_instance.filter_queryset(view_instance.get_queryset())
return self._get_queryset_query_values(queryset)
class ArgsKeyBit(AllArgsMixin, KeyBitBase):
def get_data(self, params, view_instance, view_method, request, args, kwargs):
if params == '*':
return args
elif params is not None:
return [args[i] for i in params]
else:
return []
class KwargsKeyBit(AllArgsMixin, KeyBitDictBase):
def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
return kwargs
|
