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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
|
<!doctype html PUBLIC "-//W3C//DTD html 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=emulateIE7' />
<title>Coverage for rest_framework/throttling: 81%</title>
<link rel='stylesheet' href='style.css' type='text/css'>
<script type='text/javascript' src='jquery-1.4.3.min.js'></script>
<script type='text/javascript' src='jquery.hotkeys.js'></script>
<script type='text/javascript' src='jquery.isonscreen.js'></script>
<script type='text/javascript' src='coverage_html.js'></script>
<script type='text/javascript' charset='utf-8'>
jQuery(document).ready(coverage.pyfile_ready);
</script>
</head>
<body id='pyfile'>
<div id='header'>
<div class='content'>
<h1>Coverage for <b>rest_framework/throttling</b> :
<span class='pc_cov'>81%</span>
</h1>
<img id='keyboard_icon' src='keybd_closed.png'>
<h2 class='stats'>
90 statements
<span class='run hide_run shortkey_r' onclick='coverage.toggle_lines(this, "run")'>73 run</span>
<span class='mis shortkey_m' onclick='coverage.toggle_lines(this, "mis")'>17 missing</span>
<span class='exc shortkey_x' onclick='coverage.toggle_lines(this, "exc")'>0 excluded</span>
</h2>
</div>
</div>
<div class='help_panel'>
<img id='panel_icon' src='keybd_open.png'>
<p class='legend'>Hot-keys on this page</p>
<div>
<p class='keyhelp'>
<span class='key'>r</span>
<span class='key'>m</span>
<span class='key'>x</span>
<span class='key'>p</span> toggle line displays
</p>
<p class='keyhelp'>
<span class='key'>j</span>
<span class='key'>k</span> next/prev highlighted chunk
</p>
<p class='keyhelp'>
<span class='key'>0</span> (zero) top of page
</p>
<p class='keyhelp'>
<span class='key'>1</span> (one) first highlighted chunk
</p>
</div>
</div>
<div id='source'>
<table cellspacing='0' cellpadding='0'>
<tr>
<td class='linenos' valign='top'>
<p id='n1' class='pln'><a href='#n1'>1</a></p>
<p id='n2' class='pln'><a href='#n2'>2</a></p>
<p id='n3' class='pln'><a href='#n3'>3</a></p>
<p id='n4' class='stm run hide_run'><a href='#n4'>4</a></p>
<p id='n5' class='stm run hide_run'><a href='#n5'>5</a></p>
<p id='n6' class='stm run hide_run'><a href='#n6'>6</a></p>
<p id='n7' class='stm run hide_run'><a href='#n7'>7</a></p>
<p id='n8' class='stm run hide_run'><a href='#n8'>8</a></p>
<p id='n9' class='pln'><a href='#n9'>9</a></p>
<p id='n10' class='pln'><a href='#n10'>10</a></p>
<p id='n11' class='stm run hide_run'><a href='#n11'>11</a></p>
<p id='n12' class='pln'><a href='#n12'>12</a></p>
<p id='n13' class='pln'><a href='#n13'>13</a></p>
<p id='n14' class='pln'><a href='#n14'>14</a></p>
<p id='n15' class='stm run hide_run'><a href='#n15'>15</a></p>
<p id='n16' class='pln'><a href='#n16'>16</a></p>
<p id='n17' class='pln'><a href='#n17'>17</a></p>
<p id='n18' class='pln'><a href='#n18'>18</a></p>
<p id='n19' class='stm mis'><a href='#n19'>19</a></p>
<p id='n20' class='pln'><a href='#n20'>20</a></p>
<p id='n21' class='stm run hide_run'><a href='#n21'>21</a></p>
<p id='n22' class='pln'><a href='#n22'>22</a></p>
<p id='n23' class='pln'><a href='#n23'>23</a></p>
<p id='n24' class='pln'><a href='#n24'>24</a></p>
<p id='n25' class='pln'><a href='#n25'>25</a></p>
<p id='n26' class='stm mis'><a href='#n26'>26</a></p>
<p id='n27' class='pln'><a href='#n27'>27</a></p>
<p id='n28' class='pln'><a href='#n28'>28</a></p>
<p id='n29' class='stm run hide_run'><a href='#n29'>29</a></p>
<p id='n30' class='pln'><a href='#n30'>30</a></p>
<p id='n31' class='pln'><a href='#n31'>31</a></p>
<p id='n32' class='pln'><a href='#n32'>32</a></p>
<p id='n33' class='pln'><a href='#n33'>33</a></p>
<p id='n34' class='pln'><a href='#n34'>34</a></p>
<p id='n35' class='pln'><a href='#n35'>35</a></p>
<p id='n36' class='pln'><a href='#n36'>36</a></p>
<p id='n37' class='pln'><a href='#n37'>37</a></p>
<p id='n38' class='pln'><a href='#n38'>38</a></p>
<p id='n39' class='pln'><a href='#n39'>39</a></p>
<p id='n40' class='pln'><a href='#n40'>40</a></p>
<p id='n41' class='pln'><a href='#n41'>41</a></p>
<p id='n42' class='stm run hide_run'><a href='#n42'>42</a></p>
<p id='n43' class='stm run hide_run'><a href='#n43'>43</a></p>
<p id='n44' class='stm run hide_run'><a href='#n44'>44</a></p>
<p id='n45' class='stm run hide_run'><a href='#n45'>45</a></p>
<p id='n46' class='pln'><a href='#n46'>46</a></p>
<p id='n47' class='stm run hide_run'><a href='#n47'>47</a></p>
<p id='n48' class='stm run hide_run'><a href='#n48'>48</a></p>
<p id='n49' class='stm mis'><a href='#n49'>49</a></p>
<p id='n50' class='stm run hide_run'><a href='#n50'>50</a></p>
<p id='n51' class='pln'><a href='#n51'>51</a></p>
<p id='n52' class='stm run hide_run'><a href='#n52'>52</a></p>
<p id='n53' class='pln'><a href='#n53'>53</a></p>
<p id='n54' class='pln'><a href='#n54'>54</a></p>
<p id='n55' class='pln'><a href='#n55'>55</a></p>
<p id='n56' class='pln'><a href='#n56'>56</a></p>
<p id='n57' class='pln'><a href='#n57'>57</a></p>
<p id='n58' class='pln'><a href='#n58'>58</a></p>
<p id='n59' class='stm mis'><a href='#n59'>59</a></p>
<p id='n60' class='pln'><a href='#n60'>60</a></p>
<p id='n61' class='stm run hide_run'><a href='#n61'>61</a></p>
<p id='n62' class='pln'><a href='#n62'>62</a></p>
<p id='n63' class='pln'><a href='#n63'>63</a></p>
<p id='n64' class='pln'><a href='#n64'>64</a></p>
<p id='n65' class='stm run hide_run'><a href='#n65'>65</a></p>
<p id='n66' class='stm mis'><a href='#n66'>66</a></p>
<p id='n67' class='pln'><a href='#n67'>67</a></p>
<p id='n68' class='stm mis'><a href='#n68'>68</a></p>
<p id='n69' class='pln'><a href='#n69'>69</a></p>
<p id='n70' class='stm run hide_run'><a href='#n70'>70</a></p>
<p id='n71' class='stm run hide_run'><a href='#n71'>71</a></p>
<p id='n72' class='stm mis'><a href='#n72'>72</a></p>
<p id='n73' class='stm mis'><a href='#n73'>73</a></p>
<p id='n74' class='stm mis'><a href='#n74'>74</a></p>
<p id='n75' class='pln'><a href='#n75'>75</a></p>
<p id='n76' class='stm run hide_run'><a href='#n76'>76</a></p>
<p id='n77' class='pln'><a href='#n77'>77</a></p>
<p id='n78' class='pln'><a href='#n78'>78</a></p>
<p id='n79' class='pln'><a href='#n79'>79</a></p>
<p id='n80' class='pln'><a href='#n80'>80</a></p>
<p id='n81' class='stm run hide_run'><a href='#n81'>81</a></p>
<p id='n82' class='stm mis'><a href='#n82'>82</a></p>
<p id='n83' class='stm run hide_run'><a href='#n83'>83</a></p>
<p id='n84' class='stm run hide_run'><a href='#n84'>84</a></p>
<p id='n85' class='stm run hide_run'><a href='#n85'>85</a></p>
<p id='n86' class='stm run hide_run'><a href='#n86'>86</a></p>
<p id='n87' class='pln'><a href='#n87'>87</a></p>
<p id='n88' class='stm run hide_run'><a href='#n88'>88</a></p>
<p id='n89' class='pln'><a href='#n89'>89</a></p>
<p id='n90' class='pln'><a href='#n90'>90</a></p>
<p id='n91' class='pln'><a href='#n91'>91</a></p>
<p id='n92' class='pln'><a href='#n92'>92</a></p>
<p id='n93' class='pln'><a href='#n93'>93</a></p>
<p id='n94' class='pln'><a href='#n94'>94</a></p>
<p id='n95' class='stm run hide_run'><a href='#n95'>95</a></p>
<p id='n96' class='stm mis'><a href='#n96'>96</a></p>
<p id='n97' class='pln'><a href='#n97'>97</a></p>
<p id='n98' class='stm run hide_run'><a href='#n98'>98</a></p>
<p id='n99' class='stm run hide_run'><a href='#n99'>99</a></p>
<p id='n100' class='stm run hide_run'><a href='#n100'>100</a></p>
<p id='n101' class='pln'><a href='#n101'>101</a></p>
<p id='n102' class='pln'><a href='#n102'>102</a></p>
<p id='n103' class='pln'><a href='#n103'>103</a></p>
<p id='n104' class='stm run hide_run'><a href='#n104'>104</a></p>
<p id='n105' class='stm run hide_run'><a href='#n105'>105</a></p>
<p id='n106' class='stm run hide_run'><a href='#n106'>106</a></p>
<p id='n107' class='stm run hide_run'><a href='#n107'>107</a></p>
<p id='n108' class='stm run hide_run'><a href='#n108'>108</a></p>
<p id='n109' class='pln'><a href='#n109'>109</a></p>
<p id='n110' class='stm run hide_run'><a href='#n110'>110</a></p>
<p id='n111' class='pln'><a href='#n111'>111</a></p>
<p id='n112' class='pln'><a href='#n112'>112</a></p>
<p id='n113' class='pln'><a href='#n113'>113</a></p>
<p id='n114' class='pln'><a href='#n114'>114</a></p>
<p id='n115' class='stm run hide_run'><a href='#n115'>115</a></p>
<p id='n116' class='stm run hide_run'><a href='#n116'>116</a></p>
<p id='n117' class='stm run hide_run'><a href='#n117'>117</a></p>
<p id='n118' class='pln'><a href='#n118'>118</a></p>
<p id='n119' class='stm run hide_run'><a href='#n119'>119</a></p>
<p id='n120' class='pln'><a href='#n120'>120</a></p>
<p id='n121' class='pln'><a href='#n121'>121</a></p>
<p id='n122' class='pln'><a href='#n122'>122</a></p>
<p id='n123' class='stm run hide_run'><a href='#n123'>123</a></p>
<p id='n124' class='pln'><a href='#n124'>124</a></p>
<p id='n125' class='stm run hide_run'><a href='#n125'>125</a></p>
<p id='n126' class='pln'><a href='#n126'>126</a></p>
<p id='n127' class='pln'><a href='#n127'>127</a></p>
<p id='n128' class='pln'><a href='#n128'>128</a></p>
<p id='n129' class='stm run hide_run'><a href='#n129'>129</a></p>
<p id='n130' class='stm run hide_run'><a href='#n130'>130</a></p>
<p id='n131' class='pln'><a href='#n131'>131</a></p>
<p id='n132' class='stm mis'><a href='#n132'>132</a></p>
<p id='n133' class='pln'><a href='#n133'>133</a></p>
<p id='n134' class='stm run hide_run'><a href='#n134'>134</a></p>
<p id='n135' class='pln'><a href='#n135'>135</a></p>
<p id='n136' class='stm run hide_run'><a href='#n136'>136</a></p>
<p id='n137' class='pln'><a href='#n137'>137</a></p>
<p id='n138' class='pln'><a href='#n138'>138</a></p>
<p id='n139' class='stm run hide_run'><a href='#n139'>139</a></p>
<p id='n140' class='pln'><a href='#n140'>140</a></p>
<p id='n141' class='pln'><a href='#n141'>141</a></p>
<p id='n142' class='pln'><a href='#n142'>142</a></p>
<p id='n143' class='pln'><a href='#n143'>143</a></p>
<p id='n144' class='pln'><a href='#n144'>144</a></p>
<p id='n145' class='stm run hide_run'><a href='#n145'>145</a></p>
<p id='n146' class='pln'><a href='#n146'>146</a></p>
<p id='n147' class='stm run hide_run'><a href='#n147'>147</a></p>
<p id='n148' class='stm mis'><a href='#n148'>148</a></p>
<p id='n149' class='stm mis'><a href='#n149'>149</a></p>
<p id='n150' class='pln'><a href='#n150'>150</a></p>
<p id='n151' class='stm mis'><a href='#n151'>151</a></p>
<p id='n152' class='pln'><a href='#n152'>152</a></p>
<p id='n153' class='stm mis'><a href='#n153'>153</a></p>
<p id='n154' class='pln'><a href='#n154'>154</a></p>
<p id='n155' class='pln'><a href='#n155'>155</a></p>
<p id='n156' class='pln'><a href='#n156'>156</a></p>
<p id='n157' class='pln'><a href='#n157'>157</a></p>
<p id='n158' class='pln'><a href='#n158'>158</a></p>
<p id='n159' class='stm run hide_run'><a href='#n159'>159</a></p>
<p id='n160' class='pln'><a href='#n160'>160</a></p>
<p id='n161' class='pln'><a href='#n161'>161</a></p>
<p id='n162' class='pln'><a href='#n162'>162</a></p>
<p id='n163' class='pln'><a href='#n163'>163</a></p>
<p id='n164' class='pln'><a href='#n164'>164</a></p>
<p id='n165' class='pln'><a href='#n165'>165</a></p>
<p id='n166' class='pln'><a href='#n166'>166</a></p>
<p id='n167' class='stm run hide_run'><a href='#n167'>167</a></p>
<p id='n168' class='pln'><a href='#n168'>168</a></p>
<p id='n169' class='stm run hide_run'><a href='#n169'>169</a></p>
<p id='n170' class='stm run hide_run'><a href='#n170'>170</a></p>
<p id='n171' class='stm run hide_run'><a href='#n171'>171</a></p>
<p id='n172' class='pln'><a href='#n172'>172</a></p>
<p id='n173' class='stm run hide_run'><a href='#n173'>173</a></p>
<p id='n174' class='pln'><a href='#n174'>174</a></p>
<p id='n175' class='stm run hide_run'><a href='#n175'>175</a></p>
<p id='n176' class='pln'><a href='#n176'>176</a></p>
<p id='n177' class='pln'><a href='#n177'>177</a></p>
<p id='n178' class='pln'><a href='#n178'>178</a></p>
<p id='n179' class='pln'><a href='#n179'>179</a></p>
<p id='n180' class='pln'><a href='#n180'>180</a></p>
<p id='n181' class='stm run hide_run'><a href='#n181'>181</a></p>
<p id='n182' class='pln'><a href='#n182'>182</a></p>
<p id='n183' class='pln'><a href='#n183'>183</a></p>
<p id='n184' class='pln'><a href='#n184'>184</a></p>
<p id='n185' class='pln'><a href='#n185'>185</a></p>
<p id='n186' class='pln'><a href='#n186'>186</a></p>
<p id='n187' class='pln'><a href='#n187'>187</a></p>
<p id='n188' class='stm run hide_run'><a href='#n188'>188</a></p>
<p id='n189' class='pln'><a href='#n189'>189</a></p>
<p id='n190' class='stm run hide_run'><a href='#n190'>190</a></p>
<p id='n191' class='pln'><a href='#n191'>191</a></p>
<p id='n192' class='pln'><a href='#n192'>192</a></p>
<p id='n193' class='stm run hide_run'><a href='#n193'>193</a></p>
<p id='n194' class='pln'><a href='#n194'>194</a></p>
<p id='n195' class='stm run hide_run'><a href='#n195'>195</a></p>
<p id='n196' class='pln'><a href='#n196'>196</a></p>
<p id='n197' class='stm run hide_run'><a href='#n197'>197</a></p>
<p id='n198' class='pln'><a href='#n198'>198</a></p>
<p id='n199' class='pln'><a href='#n199'>199</a></p>
<p id='n200' class='stm run hide_run'><a href='#n200'>200</a></p>
<p id='n201' class='stm run hide_run'><a href='#n201'>201</a></p>
<p id='n202' class='pln'><a href='#n202'>202</a></p>
<p id='n203' class='pln'><a href='#n203'>203</a></p>
<p id='n204' class='pln'><a href='#n204'>204</a></p>
<p id='n205' class='stm run hide_run'><a href='#n205'>205</a></p>
<p id='n206' class='stm run hide_run'><a href='#n206'>206</a></p>
<p id='n207' class='pln'><a href='#n207'>207</a></p>
<p id='n208' class='pln'><a href='#n208'>208</a></p>
<p id='n209' class='stm run hide_run'><a href='#n209'>209</a></p>
<p id='n210' class='pln'><a href='#n210'>210</a></p>
<p id='n211' class='stm run hide_run'><a href='#n211'>211</a></p>
<p id='n212' class='pln'><a href='#n212'>212</a></p>
<p id='n213' class='pln'><a href='#n213'>213</a></p>
<p id='n214' class='pln'><a href='#n214'>214</a></p>
<p id='n215' class='pln'><a href='#n215'>215</a></p>
<p id='n216' class='pln'><a href='#n216'>216</a></p>
<p id='n217' class='pln'><a href='#n217'>217</a></p>
<p id='n218' class='stm run hide_run'><a href='#n218'>218</a></p>
<p id='n219' class='stm mis'><a href='#n219'>219</a></p>
<p id='n220' class='pln'><a href='#n220'>220</a></p>
<p id='n221' class='stm run hide_run'><a href='#n221'>221</a></p>
<p id='n222' class='pln'><a href='#n222'>222</a></p>
<p id='n223' class='stm run hide_run'><a href='#n223'>223</a></p>
<p id='n224' class='pln'><a href='#n224'>224</a></p>
<p id='n225' class='pln'><a href='#n225'>225</a></p>
<p id='n226' class='pln'><a href='#n226'>226</a></p>
</td>
<td class='text' valign='top'>
<p id='t1' class='pln'><span class='str'>"""</span><span class='strut'> </span></p>
<p id='t2' class='pln'><span class='str'>Provides various throttling policies.</span><span class='strut'> </span></p>
<p id='t3' class='pln'><span class='str'>"""</span><span class='strut'> </span></p>
<p id='t4' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>__future__</span> <span class='key'>import</span> <span class='nam'>unicode_literals</span><span class='strut'> </span></p>
<p id='t5' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>django</span><span class='op'>.</span><span class='nam'>core</span><span class='op'>.</span><span class='nam'>cache</span> <span class='key'>import</span> <span class='nam'>cache</span><span class='strut'> </span></p>
<p id='t6' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>django</span><span class='op'>.</span><span class='nam'>core</span><span class='op'>.</span><span class='nam'>exceptions</span> <span class='key'>import</span> <span class='nam'>ImproperlyConfigured</span><span class='strut'> </span></p>
<p id='t7' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>rest_framework</span><span class='op'>.</span><span class='nam'>settings</span> <span class='key'>import</span> <span class='nam'>api_settings</span><span class='strut'> </span></p>
<p id='t8' class='stm run hide_run'><span class='key'>import</span> <span class='nam'>time</span><span class='strut'> </span></p>
<p id='t9' class='pln'><span class='strut'> </span></p>
<p id='t10' class='pln'><span class='strut'> </span></p>
<p id='t11' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>BaseThrottle</span><span class='op'>(</span><span class='nam'>object</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t12' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t13' class='pln'><span class='str'> Rate throttling of requests.</span><span class='strut'> </span></p>
<p id='t14' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t15' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>allow_request</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t16' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t17' class='pln'><span class='str'> Return `True` if the request should be allowed, `False` otherwise.</span><span class='strut'> </span></p>
<p id='t18' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t19' class='stm mis'> <span class='key'>raise</span> <span class='nam'>NotImplementedError</span><span class='op'>(</span><span class='str'>'.allow_request() must be overridden'</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t20' class='pln'><span class='strut'> </span></p>
<p id='t21' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>wait</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t22' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t23' class='pln'><span class='str'> Optionally, return a recommended number of seconds to wait before</span><span class='strut'> </span></p>
<p id='t24' class='pln'><span class='str'> the next request.</span><span class='strut'> </span></p>
<p id='t25' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t26' class='stm mis'> <span class='key'>return</span> <span class='nam'>None</span><span class='strut'> </span></p>
<p id='t27' class='pln'><span class='strut'> </span></p>
<p id='t28' class='pln'><span class='strut'> </span></p>
<p id='t29' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>SimpleRateThrottle</span><span class='op'>(</span><span class='nam'>BaseThrottle</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t30' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t31' class='pln'><span class='str'> A simple cache implementation, that only requires `.get_cache_key()`</span><span class='strut'> </span></p>
<p id='t32' class='pln'><span class='str'> to be overridden.</span><span class='strut'> </span></p>
<p id='t33' class='pln'><span class='strut'> </span></p>
<p id='t34' class='pln'><span class='str'> The rate (requests / seconds) is set by a `throttle` attribute on the View</span><span class='strut'> </span></p>
<p id='t35' class='pln'><span class='str'> class. The attribute is a string of the form 'number_of_requests/period'.</span><span class='strut'> </span></p>
<p id='t36' class='pln'><span class='strut'> </span></p>
<p id='t37' class='pln'><span class='str'> Period should be one of: ('s', 'sec', 'm', 'min', 'h', 'hour', 'd', 'day')</span><span class='strut'> </span></p>
<p id='t38' class='pln'><span class='strut'> </span></p>
<p id='t39' class='pln'><span class='str'> Previous request information used for throttling is stored in the cache.</span><span class='strut'> </span></p>
<p id='t40' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t41' class='pln'><span class='strut'> </span></p>
<p id='t42' class='stm run hide_run'> <span class='nam'>timer</span> <span class='op'>=</span> <span class='nam'>time</span><span class='op'>.</span><span class='nam'>time</span><span class='strut'> </span></p>
<p id='t43' class='stm run hide_run'> <span class='nam'>cache_format</span> <span class='op'>=</span> <span class='str'>'throtte_%(scope)s_%(ident)s'</span><span class='strut'> </span></p>
<p id='t44' class='stm run hide_run'> <span class='nam'>scope</span> <span class='op'>=</span> <span class='nam'>None</span><span class='strut'> </span></p>
<p id='t45' class='stm run hide_run'> <span class='nam'>THROTTLE_RATES</span> <span class='op'>=</span> <span class='nam'>api_settings</span><span class='op'>.</span><span class='nam'>DEFAULT_THROTTLE_RATES</span><span class='strut'> </span></p>
<p id='t46' class='pln'><span class='strut'> </span></p>
<p id='t47' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>__init__</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t48' class='stm run hide_run'> <span class='key'>if</span> <span class='key'>not</span> <span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='str'>'rate'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t49' class='stm mis'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>rate</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>get_rate</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t50' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>num_requests</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>parse_rate</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>rate</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t51' class='pln'><span class='strut'> </span></p>
<p id='t52' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>get_cache_key</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t53' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t54' class='pln'><span class='str'> Should return a unique cache-key which can be used for throttling.</span><span class='strut'> </span></p>
<p id='t55' class='pln'><span class='str'> Must be overridden.</span><span class='strut'> </span></p>
<p id='t56' class='pln'><span class='strut'> </span></p>
<p id='t57' class='pln'><span class='str'> May return `None` if the request should not be throttled.</span><span class='strut'> </span></p>
<p id='t58' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t59' class='stm mis'> <span class='key'>raise</span> <span class='nam'>NotImplementedError</span><span class='op'>(</span><span class='str'>'.get_cache_key() must be overridden'</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t60' class='pln'><span class='strut'> </span></p>
<p id='t61' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>get_rate</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t62' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t63' class='pln'><span class='str'> Determine the string representation of the allowed request rate.</span><span class='strut'> </span></p>
<p id='t64' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t65' class='stm run hide_run'> <span class='key'>if</span> <span class='key'>not</span> <span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='str'>'scope'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t66' class='stm mis'> <span class='nam'>msg</span> <span class='op'>=</span> <span class='op'>(</span><span class='str'>"You must set either `.scope` or `.rate` for '%s' throttle"</span> <span class='op'>%</span><span class='strut'> </span></p>
<p id='t67' class='pln'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>__class__</span><span class='op'>.</span><span class='nam'>__name__</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t68' class='stm mis'> <span class='key'>raise</span> <span class='nam'>ImproperlyConfigured</span><span class='op'>(</span><span class='nam'>msg</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t69' class='pln'><span class='strut'> </span></p>
<p id='t70' class='stm run hide_run'> <span class='key'>try</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t71' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>THROTTLE_RATES</span><span class='op'>[</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='op'>]</span><span class='strut'> </span></p>
<p id='t72' class='stm mis'> <span class='key'>except</span> <span class='nam'>KeyError</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t73' class='stm mis'> <span class='nam'>msg</span> <span class='op'>=</span> <span class='str'>"No default throttle rate set for '%s' scope"</span> <span class='op'>%</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='strut'> </span></p>
<p id='t74' class='stm mis'> <span class='key'>raise</span> <span class='nam'>ImproperlyConfigured</span><span class='op'>(</span><span class='nam'>msg</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t75' class='pln'><span class='strut'> </span></p>
<p id='t76' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>parse_rate</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>rate</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t77' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t78' class='pln'><span class='str'> Given the request rate string, return a two tuple of:</span><span class='strut'> </span></p>
<p id='t79' class='pln'><span class='str'> <allowed number of requests>, <period of time in seconds></span><span class='strut'> </span></p>
<p id='t80' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t81' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>rate</span> <span class='key'>is</span> <span class='nam'>None</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t82' class='stm mis'> <span class='key'>return</span> <span class='op'>(</span><span class='nam'>None</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t83' class='stm run hide_run'> <span class='nam'>num</span><span class='op'>,</span> <span class='nam'>period</span> <span class='op'>=</span> <span class='nam'>rate</span><span class='op'>.</span><span class='nam'>split</span><span class='op'>(</span><span class='str'>'/'</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t84' class='stm run hide_run'> <span class='nam'>num_requests</span> <span class='op'>=</span> <span class='nam'>int</span><span class='op'>(</span><span class='nam'>num</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t85' class='stm run hide_run'> <span class='nam'>duration</span> <span class='op'>=</span> <span class='op'>{</span><span class='str'>'s'</span><span class='op'>:</span> <span class='num'>1</span><span class='op'>,</span> <span class='str'>'m'</span><span class='op'>:</span> <span class='num'>60</span><span class='op'>,</span> <span class='str'>'h'</span><span class='op'>:</span> <span class='num'>3600</span><span class='op'>,</span> <span class='str'>'d'</span><span class='op'>:</span> <span class='num'>86400</span><span class='op'>}</span><span class='op'>[</span><span class='nam'>period</span><span class='op'>[</span><span class='num'>0</span><span class='op'>]</span><span class='op'>]</span><span class='strut'> </span></p>
<p id='t86' class='stm run hide_run'> <span class='key'>return</span> <span class='op'>(</span><span class='nam'>num_requests</span><span class='op'>,</span> <span class='nam'>duration</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t87' class='pln'><span class='strut'> </span></p>
<p id='t88' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>allow_request</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t89' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t90' class='pln'><span class='str'> Implement the check to see if the request should be throttled.</span><span class='strut'> </span></p>
<p id='t91' class='pln'><span class='strut'> </span></p>
<p id='t92' class='pln'><span class='str'> On success calls `throttle_success`.</span><span class='strut'> </span></p>
<p id='t93' class='pln'><span class='str'> On failure calls `throttle_failure`.</span><span class='strut'> </span></p>
<p id='t94' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t95' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>rate</span> <span class='key'>is</span> <span class='nam'>None</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t96' class='stm mis'> <span class='key'>return</span> <span class='nam'>True</span><span class='strut'> </span></p>
<p id='t97' class='pln'><span class='strut'> </span></p>
<p id='t98' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>key</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>get_cache_key</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t99' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span> <span class='op'>=</span> <span class='nam'>cache</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>key</span><span class='op'>,</span> <span class='op'>[</span><span class='op'>]</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t100' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>now</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>timer</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t101' class='pln'><span class='strut'> </span></p>
<p id='t102' class='pln'> <span class='com'># Drop any requests from the history which have now passed the</span><span class='strut'> </span></p>
<p id='t103' class='pln'> <span class='com'># throttle duration</span><span class='strut'> </span></p>
<p id='t104' class='stm run hide_run'> <span class='key'>while</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span> <span class='key'>and</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>[</span><span class='op'>-</span><span class='num'>1</span><span class='op'>]</span> <span class='op'><=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>now</span> <span class='op'>-</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t105' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>.</span><span class='nam'>pop</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t106' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>len</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>)</span> <span class='op'>>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>num_requests</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t107' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>throttle_failure</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t108' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>throttle_success</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t109' class='pln'><span class='strut'> </span></p>
<p id='t110' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>throttle_success</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t111' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t112' class='pln'><span class='str'> Inserts the current request's timestamp along with the key</span><span class='strut'> </span></p>
<p id='t113' class='pln'><span class='str'> into the cache.</span><span class='strut'> </span></p>
<p id='t114' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t115' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>.</span><span class='nam'>insert</span><span class='op'>(</span><span class='num'>0</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>now</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t116' class='stm run hide_run'> <span class='nam'>cache</span><span class='op'>.</span><span class='nam'>set</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>key</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t117' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>True</span><span class='strut'> </span></p>
<p id='t118' class='pln'><span class='strut'> </span></p>
<p id='t119' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>throttle_failure</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t120' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t121' class='pln'><span class='str'> Called when a request to the API has failed due to throttling.</span><span class='strut'> </span></p>
<p id='t122' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t123' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>False</span><span class='strut'> </span></p>
<p id='t124' class='pln'><span class='strut'> </span></p>
<p id='t125' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>wait</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t126' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t127' class='pln'><span class='str'> Returns the recommended next request time in seconds.</span><span class='strut'> </span></p>
<p id='t128' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t129' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t130' class='stm run hide_run'> <span class='nam'>remaining_duration</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span> <span class='op'>-</span> <span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>now</span> <span class='op'>-</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>[</span><span class='op'>-</span><span class='num'>1</span><span class='op'>]</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t131' class='pln'> <span class='key'>else</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t132' class='stm mis'> <span class='nam'>remaining_duration</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span><span class='strut'> </span></p>
<p id='t133' class='pln'><span class='strut'> </span></p>
<p id='t134' class='stm run hide_run'> <span class='nam'>available_requests</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>num_requests</span> <span class='op'>-</span> <span class='nam'>len</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>history</span><span class='op'>)</span> <span class='op'>+</span> <span class='num'>1</span><span class='strut'> </span></p>
<p id='t135' class='pln'><span class='strut'> </span></p>
<p id='t136' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>remaining_duration</span> <span class='op'>/</span> <span class='nam'>float</span><span class='op'>(</span><span class='nam'>available_requests</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t137' class='pln'><span class='strut'> </span></p>
<p id='t138' class='pln'><span class='strut'> </span></p>
<p id='t139' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>AnonRateThrottle</span><span class='op'>(</span><span class='nam'>SimpleRateThrottle</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t140' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t141' class='pln'><span class='str'> Limits the rate of API calls that may be made by a anonymous users.</span><span class='strut'> </span></p>
<p id='t142' class='pln'><span class='strut'> </span></p>
<p id='t143' class='pln'><span class='str'> The IP address of the request will be used as the unique cache key.</span><span class='strut'> </span></p>
<p id='t144' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t145' class='stm run hide_run'> <span class='nam'>scope</span> <span class='op'>=</span> <span class='str'>'anon'</span><span class='strut'> </span></p>
<p id='t146' class='pln'><span class='strut'> </span></p>
<p id='t147' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>get_cache_key</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t148' class='stm mis'> <span class='key'>if</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>user</span><span class='op'>.</span><span class='nam'>is_authenticated</span><span class='op'>(</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t149' class='stm mis'> <span class='key'>return</span> <span class='nam'>None</span> <span class='com'># Only throttle unauthenticated requests.</span><span class='strut'> </span></p>
<p id='t150' class='pln'><span class='strut'> </span></p>
<p id='t151' class='stm mis'> <span class='nam'>ident</span> <span class='op'>=</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>META</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='str'>'REMOTE_ADDR'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t152' class='pln'><span class='strut'> </span></p>
<p id='t153' class='stm mis'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>cache_format</span> <span class='op'>%</span> <span class='op'>{</span><span class='strut'> </span></p>
<p id='t154' class='pln'> <span class='str'>'scope'</span><span class='op'>:</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='op'>,</span><span class='strut'> </span></p>
<p id='t155' class='pln'> <span class='str'>'ident'</span><span class='op'>:</span> <span class='nam'>ident</span><span class='strut'> </span></p>
<p id='t156' class='pln'> <span class='op'>}</span><span class='strut'> </span></p>
<p id='t157' class='pln'><span class='strut'> </span></p>
<p id='t158' class='pln'><span class='strut'> </span></p>
<p id='t159' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>UserRateThrottle</span><span class='op'>(</span><span class='nam'>SimpleRateThrottle</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t160' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t161' class='pln'><span class='str'> Limits the rate of API calls that may be made by a given user.</span><span class='strut'> </span></p>
<p id='t162' class='pln'><span class='strut'> </span></p>
<p id='t163' class='pln'><span class='str'> The user id will be used as a unique cache key if the user is</span><span class='strut'> </span></p>
<p id='t164' class='pln'><span class='str'> authenticated. For anonymous requests, the IP address of the request will</span><span class='strut'> </span></p>
<p id='t165' class='pln'><span class='str'> be used.</span><span class='strut'> </span></p>
<p id='t166' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t167' class='stm run hide_run'> <span class='nam'>scope</span> <span class='op'>=</span> <span class='str'>'user'</span><span class='strut'> </span></p>
<p id='t168' class='pln'><span class='strut'> </span></p>
<p id='t169' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>get_cache_key</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t170' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>user</span><span class='op'>.</span><span class='nam'>is_authenticated</span><span class='op'>(</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t171' class='stm run hide_run'> <span class='nam'>ident</span> <span class='op'>=</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>user</span><span class='op'>.</span><span class='nam'>id</span><span class='strut'> </span></p>
<p id='t172' class='pln'> <span class='key'>else</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t173' class='stm run hide_run'> <span class='nam'>ident</span> <span class='op'>=</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>META</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='str'>'REMOTE_ADDR'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t174' class='pln'><span class='strut'> </span></p>
<p id='t175' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>cache_format</span> <span class='op'>%</span> <span class='op'>{</span><span class='strut'> </span></p>
<p id='t176' class='pln'> <span class='str'>'scope'</span><span class='op'>:</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='op'>,</span><span class='strut'> </span></p>
<p id='t177' class='pln'> <span class='str'>'ident'</span><span class='op'>:</span> <span class='nam'>ident</span><span class='strut'> </span></p>
<p id='t178' class='pln'> <span class='op'>}</span><span class='strut'> </span></p>
<p id='t179' class='pln'><span class='strut'> </span></p>
<p id='t180' class='pln'><span class='strut'> </span></p>
<p id='t181' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>ScopedRateThrottle</span><span class='op'>(</span><span class='nam'>SimpleRateThrottle</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t182' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t183' class='pln'><span class='str'> Limits the rate of API calls by different amounts for various parts of</span><span class='strut'> </span></p>
<p id='t184' class='pln'><span class='str'> the API. Any view that has the `throttle_scope` property set will be</span><span class='strut'> </span></p>
<p id='t185' class='pln'><span class='str'> throttled. The unique cache key will be generated by concatenating the</span><span class='strut'> </span></p>
<p id='t186' class='pln'><span class='str'> user id of the request, and the scope of the view being accessed.</span><span class='strut'> </span></p>
<p id='t187' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t188' class='stm run hide_run'> <span class='nam'>scope_attr</span> <span class='op'>=</span> <span class='str'>'throttle_scope'</span><span class='strut'> </span></p>
<p id='t189' class='pln'><span class='strut'> </span></p>
<p id='t190' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>__init__</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t191' class='pln'> <span class='com'># Override the usual SimpleRateThrottle, because we can't determine</span><span class='strut'> </span></p>
<p id='t192' class='pln'> <span class='com'># the rate until called by the view.</span><span class='strut'> </span></p>
<p id='t193' class='stm run hide_run'> <span class='key'>pass</span><span class='strut'> </span></p>
<p id='t194' class='pln'><span class='strut'> </span></p>
<p id='t195' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>allow_request</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t196' class='pln'> <span class='com'># We can only determine the scope once we're called by the view.</span><span class='strut'> </span></p>
<p id='t197' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span> <span class='op'>=</span> <span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>view</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope_attr</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t198' class='pln'><span class='strut'> </span></p>
<p id='t199' class='pln'> <span class='com'># If a view does not have a `throttle_scope` always allow the request</span><span class='strut'> </span></p>
<p id='t200' class='stm run hide_run'> <span class='key'>if</span> <span class='key'>not</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t201' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>True</span><span class='strut'> </span></p>
<p id='t202' class='pln'><span class='strut'> </span></p>
<p id='t203' class='pln'> <span class='com'># Determine the allowed request rate as we normally would during</span><span class='strut'> </span></p>
<p id='t204' class='pln'> <span class='com'># the `__init__` call.</span><span class='strut'> </span></p>
<p id='t205' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>rate</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>get_rate</span><span class='op'>(</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t206' class='stm run hide_run'> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>num_requests</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>duration</span> <span class='op'>=</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>parse_rate</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>.</span><span class='nam'>rate</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t207' class='pln'><span class='strut'> </span></p>
<p id='t208' class='pln'> <span class='com'># We can now proceed as normal.</span><span class='strut'> </span></p>
<p id='t209' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>super</span><span class='op'>(</span><span class='nam'>ScopedRateThrottle</span><span class='op'>,</span> <span class='nam'>self</span><span class='op'>)</span><span class='op'>.</span><span class='nam'>allow_request</span><span class='op'>(</span><span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t210' class='pln'><span class='strut'> </span></p>
<p id='t211' class='stm run hide_run'> <span class='key'>def</span> <span class='nam'>get_cache_key</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>request</span><span class='op'>,</span> <span class='nam'>view</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t212' class='pln'> <span class='str'>"""</span><span class='strut'> </span></p>
<p id='t213' class='pln'><span class='str'> If `view.throttle_scope` is not set, don't apply this throttle.</span><span class='strut'> </span></p>
<p id='t214' class='pln'><span class='strut'> </span></p>
<p id='t215' class='pln'><span class='str'> Otherwise generate the unique cache key by concatenating the user id</span><span class='strut'> </span></p>
<p id='t216' class='pln'><span class='str'> with the '.throttle_scope` property of the view.</span><span class='strut'> </span></p>
<p id='t217' class='pln'><span class='str'> """</span><span class='strut'> </span></p>
<p id='t218' class='stm run hide_run'> <span class='key'>if</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>user</span><span class='op'>.</span><span class='nam'>is_authenticated</span><span class='op'>(</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t219' class='stm mis'> <span class='nam'>ident</span> <span class='op'>=</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>user</span><span class='op'>.</span><span class='nam'>id</span><span class='strut'> </span></p>
<p id='t220' class='pln'> <span class='key'>else</span><span class='op'>:</span><span class='strut'> </span></p>
<p id='t221' class='stm run hide_run'> <span class='nam'>ident</span> <span class='op'>=</span> <span class='nam'>request</span><span class='op'>.</span><span class='nam'>META</span><span class='op'>.</span><span class='nam'>get</span><span class='op'>(</span><span class='str'>'REMOTE_ADDR'</span><span class='op'>,</span> <span class='nam'>None</span><span class='op'>)</span><span class='strut'> </span></p>
<p id='t222' class='pln'><span class='strut'> </span></p>
<p id='t223' class='stm run hide_run'> <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>cache_format</span> <span class='op'>%</span> <span class='op'>{</span><span class='strut'> </span></p>
<p id='t224' class='pln'> <span class='str'>'scope'</span><span class='op'>:</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>scope</span><span class='op'>,</span><span class='strut'> </span></p>
<p id='t225' class='pln'> <span class='str'>'ident'</span><span class='op'>:</span> <span class='nam'>ident</span><span class='strut'> </span></p>
<p id='t226' class='pln'> <span class='op'>}</span><span class='strut'> </span></p>
</td>
</tr>
</table>
</div>
<div id='footer'>
<div class='content'>
<p>
<a class='nav' href='index.html'>« index</a> <a class='nav' href='http://nedbatchelder.com/code/coverage'>coverage.py v3.5.1</a>
</p>
</div>
</div>
</body>
</html>
|
