This file is indexed.

/usr/share/doc/python-django-braces-doc/html/other.html is in python-django-braces-doc 1.9.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Other Mixins &mdash; django-braces 1.9.0 documentation</title>
    
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.9.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="django-braces 1.9.0 documentation" href="index.html" />
    <link rel="prev" title="Form Mixins" href="form.html" /> 
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="form.html" title="Form Mixins"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">django-braces 1.9.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="other-mixins">
<h1><a class="toc-backref" href="#id12">Other Mixins</a><a class="headerlink" href="#other-mixins" title="Permalink to this headline"></a></h1>
<p>These mixins handle other random bits of Django&#8217;s views, like controlling output, controlling content types, or setting values in the context.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#other-mixins" id="id12">Other Mixins</a><ul>
<li><a class="reference internal" href="#setheadlinemixin" id="id13">SetHeadlineMixin</a><ul>
<li><a class="reference internal" href="#static-example" id="id14">Static Example</a></li>
<li><a class="reference internal" href="#dynamic-example" id="id15">Dynamic Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#staticcontextmixin" id="id16">StaticContextMixin</a><ul>
<li><a class="reference internal" href="#view-example" id="id17">View Example</a></li>
<li><a class="reference internal" href="#url-example" id="id18">URL Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#selectrelatedmixin" id="id19">SelectRelatedMixin</a></li>
<li><a class="reference internal" href="#prefetchrelatedmixin" id="id20">PrefetchRelatedMixin</a></li>
<li><a class="reference internal" href="#jsonresponsemixin" id="id21">JSONResponseMixin</a></li>
<li><a class="reference internal" href="#jsonrequestresponsemixin" id="id22">JsonRequestResponseMixin</a></li>
<li><a class="reference internal" href="#ajaxresponsemixin" id="id23">AjaxResponseMixin</a></li>
<li><a class="reference internal" href="#orderablelistmixin" id="id24">OrderableListMixin</a></li>
<li><a class="reference internal" href="#canonicalslugdetailmixin" id="id25">CanonicalSlugDetailMixin</a></li>
<li><a class="reference internal" href="#messagemixin" id="id26">MessageMixin</a></li>
<li><a class="reference internal" href="#allverbsmixin" id="id27">AllVerbsMixin</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="setheadlinemixin">
<span id="id1"></span><h2><a class="toc-backref" href="#id13">SetHeadlineMixin</a><a class="headerlink" href="#setheadlinemixin" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal"><span class="pre">SetHeadlineMixin</span></code> allows you to <em>statically</em> or <em>programmatically</em> set the headline of any of your views. Ideally, you&#8217;ll write as few templates as possible, so a mixin like this helps you reuse generic templates. Its usage is amazingly straightforward and works much like Django&#8217;s built-in <code class="docutils literal"><span class="pre">get_queryset</span></code> method. This mixin has two ways of being used:</p>
<div class="section" id="static-example">
<h3><a class="toc-backref" href="#id14">Static Example</a><a class="headerlink" href="#static-example" title="Permalink to this headline"></a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="k">import</span> <span class="n">ugettext_lazy</span> <span class="k">as</span> <span class="n">_</span>
<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">SetHeadlineMixin</span>


<span class="k">class</span> <span class="nc">HeadlineView</span><span class="p">(</span><span class="n">SetHeadlineMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="n">headline</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">u&quot;This is our headline&quot;</span><span class="p">)</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">u&quot;path/to/template.html&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="dynamic-example">
<h3><a class="toc-backref" href="#id15">Dynamic Example</a><a class="headerlink" href="#dynamic-example" title="Permalink to this headline"></a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">date</span>

<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">SetHeadlineMixin</span>


<span class="k">class</span> <span class="nc">HeadlineView</span><span class="p">(</span><span class="n">SetHeadlineMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">u&quot;path/to/template.html&quot;</span>

    <span class="k">def</span> <span class="nf">get_headline</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">u&quot;This is our headline for </span><span class="si">{0}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">())</span>
</pre></div>
</div>
<p>For both usages, the context now contains a <code class="docutils literal"><span class="pre">headline</span></code> key with your headline.</p>
</div>
</div>
<div class="section" id="staticcontextmixin">
<span id="id2"></span><h2><a class="toc-backref" href="#id16">StaticContextMixin</a><a class="headerlink" href="#staticcontextmixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.4.</span></p>
</div>
<p>The <code class="docutils literal"><span class="pre">StaticContextMixin</span></code> allows you to easily set static context data by using the <code class="docutils literal"><span class="pre">static_context</span></code> property.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">While it&#8217;s possible to override the <code class="docutils literal"><span class="pre">StaticContextMixin.get_static_context</span> <span class="pre">method</span></code>, it&#8217;s not very practical. If you have a need to override a method for dynamic context data it&#8217;s best to override the standard <code class="docutils literal"><span class="pre">get_context_data</span></code> method of Django&#8217;s generic class-based views.</p>
</div>
<div class="section" id="view-example">
<h3><a class="toc-backref" href="#id17">View Example</a><a class="headerlink" href="#view-example" title="Permalink to this headline"></a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>

<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">StaticContextMixin</span>


<span class="k">class</span> <span class="nc">ContextTemplateView</span><span class="p">(</span><span class="n">StaticContextMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="n">static_context</span> <span class="o">=</span> <span class="p">{</span><span class="s2">u&quot;nav_home&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="url-example">
<h3><a class="toc-backref" href="#id18">URL Example</a><a class="headerlink" href="#url-example" title="Permalink to this headline"></a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># urls.py</span>

<span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span>
    <span class="s1">&#39;&#39;</span><span class="p">,</span>
    <span class="n">url</span><span class="p">(</span><span class="s2">ur&quot;^$&quot;</span><span class="p">,</span>
        <span class="n">ContextTemplateView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(</span>
            <span class="n">template_name</span><span class="o">=</span><span class="s2">u&quot;index.html&quot;</span><span class="p">,</span>
            <span class="n">static_context</span><span class="o">=</span><span class="p">{</span><span class="s2">u&quot;nav_home&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
        <span class="p">),</span>
        <span class="n">name</span><span class="o">=</span><span class="s2">u&quot;index&quot;</span><span class="p">)</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="selectrelatedmixin">
<span id="id3"></span><h2><a class="toc-backref" href="#id19">SelectRelatedMixin</a><a class="headerlink" href="#selectrelatedmixin" title="Permalink to this headline"></a></h2>
<p>A simple mixin which allows you to specify a list or tuple of foreign key fields to perform a <a class="reference external" href="https://docs.djangoproject.com/en/dev/ref/models/querysets/#select-related">select_related</a> on.  See Django&#8217;s docs for more information on <a class="reference external" href="https://docs.djangoproject.com/en/dev/ref/models/querysets/#select-related">select_related</a>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">DetailView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">SelectRelatedMixin</span>

<span class="kn">from</span> <span class="nn">profiles.models</span> <span class="k">import</span> <span class="n">Profile</span>


<span class="k">class</span> <span class="nc">UserProfileView</span><span class="p">(</span><span class="n">SelectRelatedMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Profile</span>
    <span class="n">select_related</span> <span class="o">=</span> <span class="p">[</span><span class="s2">u&quot;user&quot;</span><span class="p">]</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">u&quot;profiles/detail.html&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="prefetchrelatedmixin">
<span id="id4"></span><h2><a class="toc-backref" href="#id20">PrefetchRelatedMixin</a><a class="headerlink" href="#prefetchrelatedmixin" title="Permalink to this headline"></a></h2>
<p>A simple mixin which allows you to specify a list or tuple of reverse foreign key or ManyToMany fields to perform a <a class="reference external" href="https://docs.djangoproject.com/en/dev/ref/models/querysets/#prefetch-related">prefetch_related</a> on. See Django&#8217;s docs for more information on <a class="reference external" href="https://docs.djangoproject.com/en/dev/ref/models/querysets/#prefetch-related">prefetch_related</a>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.contrib.auth.models</span> <span class="k">import</span> <span class="n">User</span>
<span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">DetailView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">PrefetchRelatedMixin</span>


<span class="k">class</span> <span class="nc">UserView</span><span class="p">(</span><span class="n">PrefetchRelatedMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">User</span>
    <span class="n">prefetch_related</span> <span class="o">=</span> <span class="p">[</span><span class="s2">u&quot;post_set&quot;</span><span class="p">]</span>  <span class="c1"># where the Post model has an FK to the User model as an author.</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">u&quot;users/detail.html&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="jsonresponsemixin">
<span id="id5"></span><h2><a class="toc-backref" href="#id21">JSONResponseMixin</a><a class="headerlink" href="#jsonresponsemixin" title="Permalink to this headline"></a></h2>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1: </span><code class="docutils literal"><span class="pre">render_json_response</span></code> now accepts a <code class="docutils literal"><span class="pre">status</span></code> keyword argument.
<code class="docutils literal"><span class="pre">json_dumps_kwargs</span></code> class-attribute and <code class="docutils literal"><span class="pre">get_json_dumps_kwargs</span></code> method to provide arguments to the <code class="docutils literal"><span class="pre">json.dumps()</span></code> method.</p>
</div>
<p>A simple mixin to handle very simple serialization as a response to the browser.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">DetailView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">JSONResponseMixin</span>

<span class="k">class</span> <span class="nc">UserProfileAJAXView</span><span class="p">(</span><span class="n">JSONResponseMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Profile</span>
    <span class="n">json_dumps_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s2">u&quot;indent&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span>

    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>

        <span class="n">context_dict</span> <span class="o">=</span> <span class="p">{</span>
            <span class="s2">u&quot;name&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
            <span class="s2">u&quot;location&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="o">.</span><span class="n">location</span>
        <span class="p">}</span>

        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_response</span><span class="p">(</span><span class="n">context_dict</span><span class="p">)</span>
</pre></div>
</div>
<p>You can additionally use the <cite>AjaxResponseMixin</cite></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">DetailView</span>

<span class="kn">from</span> <span class="nn">braces</span> <span class="k">import</span> <span class="n">views</span>


<span class="k">class</span> <span class="nc">UserProfileView</span><span class="p">(</span><span class="n">views</span><span class="o">.</span><span class="n">JSONResponseMixin</span><span class="p">,</span>
                      <span class="n">views</span><span class="o">.</span><span class="n">AjaxResponseMixin</span><span class="p">,</span>
                      <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Profile</span>

    <span class="k">def</span> <span class="nf">get_ajax</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_object_response</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">())</span>
</pre></div>
</div>
<p>The <cite>JSONResponseMixin</cite> provides a class-level variable to control the response
type as well. By default it is <cite>application/json</cite>, but you can override that by
providing the <cite>content_type</cite> variable a different value or, programmatically, by
overriding the <cite>get_content_type()</cite> method.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">DetailView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">JSONResponseMixin</span>


<span class="k">class</span> <span class="nc">UserProfileAJAXView</span><span class="p">(</span><span class="n">JSONResponseMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">content_type</span> <span class="o">=</span> <span class="s2">u&quot;application/javascript&quot;</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Profile</span>

    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>

        <span class="n">context_dict</span> <span class="o">=</span> <span class="p">{</span>
            <span class="s2">u&quot;name&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
            <span class="s2">u&quot;location&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="o">.</span><span class="n">location</span>
        <span class="p">}</span>

        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_response</span><span class="p">(</span><span class="n">context_dict</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">get_content_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="c1"># Shown just for illustrative purposes</span>
        <span class="k">return</span> <span class="s2">u&quot;application/javascript&quot;</span>
</pre></div>
</div>
<p>The <cite>JSONResponseMixin</cite> provides another class-level variable
<cite>json_encoder_class</cite> to use a custom json encoder with <cite>json.dumps</cite>.
By default it is <cite>django.core.serializers.json.DjangoJsonEncoder</cite></p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.core.serializers.json</span> <span class="k">import</span> <span class="n">DjangoJSONEncoder</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">JSONResponseMixin</span>


<span class="k">class</span> <span class="nc">SetJSONEncoder</span><span class="p">(</span><span class="n">DjangoJSONEncoder</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    A custom JSONEncoder extending `DjangoJSONEncoder` to handle serialization</span>
<span class="sd">    of `set`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
            <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">DjangoJSONEncoder</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>


<span class="k">class</span> <span class="nc">GetSetDataView</span><span class="p">(</span><span class="n">JSONResponseMixin</span><span class="p">,</span> <span class="n">View</span><span class="p">):</span>
    <span class="n">json_encoder_class</span> <span class="o">=</span> <span class="n">SetJSONEncoder</span>

    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="n">numbers_set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span>
        <span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;numbers&#39;</span><span class="p">:</span> <span class="n">numbers_set</span><span class="p">}</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_response</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="jsonrequestresponsemixin">
<span id="id6"></span><h2><a class="toc-backref" href="#id22">JsonRequestResponseMixin</a><a class="headerlink" href="#jsonrequestresponsemixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.3.</span></p>
</div>
<p>A mixin that attempts to parse the request as JSON.  If the request is properly formatted, the JSON is saved to <code class="docutils literal"><span class="pre">self.request_json</span></code> as a Python object.  <code class="docutils literal"><span class="pre">request_json</span></code> will be <code class="docutils literal"><span class="pre">None</span></code> for imparsible requests.</p>
<p>To catch requests that aren&#8217;t JSON-formatted, set the class attribute <code class="docutils literal"><span class="pre">require_json</span></code> to <code class="docutils literal"><span class="pre">True</span></code>.</p>
<p>Override the class attribute <code class="docutils literal"><span class="pre">error_response_dict</span></code> to customize the default error message.</p>
<p>It extends <a class="reference internal" href="#jsonresponsemixin"><span class="std std-ref">JSONResponseMixin</span></a>, so those utilities are available as well.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To allow public access to your view, you&#8217;ll need to use the <code class="docutils literal"><span class="pre">csrf_exempt</span></code> decorator or <a class="reference internal" href="form.html#csrfexemptmixin"><span class="std std-ref">CsrfExemptMixin</span></a>.</p>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">View</span>

<span class="kn">from</span> <span class="nn">braces</span> <span class="k">import</span> <span class="n">views</span>

<span class="k">class</span> <span class="nc">SomeView</span><span class="p">(</span><span class="n">views</span><span class="o">.</span><span class="n">CsrfExemptMixin</span><span class="p">,</span> <span class="n">views</span><span class="o">.</span><span class="n">JsonRequestResponseMixin</span><span class="p">,</span> <span class="n">View</span><span class="p">):</span>
    <span class="n">require_json</span> <span class="o">=</span> <span class="kc">True</span>

    <span class="k">def</span> <span class="nf">post</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">burrito</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">request_json</span><span class="p">[</span><span class="s2">u&quot;burrito&quot;</span><span class="p">]</span>
            <span class="n">toppings</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">request_json</span><span class="p">[</span><span class="s2">u&quot;toppings&quot;</span><span class="p">]</span>
        <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
            <span class="n">error_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s2">u&quot;message&quot;</span><span class="p">:</span>
               <span class="s2">u&quot;your order must include a burrito AND toppings&quot;</span><span class="p">}</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_bad_request_response</span><span class="p">(</span><span class="n">error_dict</span><span class="p">)</span>
        <span class="n">place_order</span><span class="p">(</span><span class="n">burrito</span><span class="p">,</span> <span class="n">toppings</span><span class="p">)</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_response</span><span class="p">(</span>
            <span class="p">{</span><span class="s2">u&quot;message&quot;</span><span class="p">:</span> <span class="s2">u&quot;Your order has been placed!&quot;</span><span class="p">})</span>
</pre></div>
</div>
</div>
<div class="section" id="ajaxresponsemixin">
<span id="id7"></span><h2><a class="toc-backref" href="#id23">AjaxResponseMixin</a><a class="headerlink" href="#ajaxresponsemixin" title="Permalink to this headline"></a></h2>
<p>This mixin provides hooks for altenate processing of AJAX requests based on HTTP verb.</p>
<p>To control AJAX-specific behavior, override <code class="docutils literal"><span class="pre">get_ajax</span></code>, <code class="docutils literal"><span class="pre">post_ajax</span></code>, <code class="docutils literal"><span class="pre">put_ajax</span></code>, or <code class="docutils literal"><span class="pre">delete_ajax</span></code>. All four methods take <code class="docutils literal"><span class="pre">request</span></code>, <code class="docutils literal"><span class="pre">*args</span></code>, and <code class="docutils literal"><span class="pre">**kwargs</span></code> like the standard view methods.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">View</span>

<span class="kn">from</span> <span class="nn">braces</span> <span class="k">import</span> <span class="n">views</span>

<span class="k">class</span> <span class="nc">SomeView</span><span class="p">(</span><span class="n">views</span><span class="o">.</span><span class="n">JSONResponseMixin</span><span class="p">,</span> <span class="n">views</span><span class="o">.</span><span class="n">AjaxResponseMixin</span><span class="p">,</span> <span class="n">View</span><span class="p">):</span>
    <span class="k">def</span> <span class="nf">get_ajax</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="n">json_dict</span> <span class="o">=</span> <span class="p">{</span>
            <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s2">&quot;Benny&#39;s Burritos&quot;</span><span class="p">,</span>
            <span class="s1">&#39;location&#39;</span><span class="p">:</span> <span class="s2">&quot;New York, NY&quot;</span>
        <span class="p">}</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_json_response</span><span class="p">(</span><span class="n">json_dict</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This mixin is only useful if you need to have behavior in your view fork based on <code class="docutils literal"><span class="pre">request.is_ajax()</span></code>.</p>
</div>
</div>
<div class="section" id="orderablelistmixin">
<span id="id8"></span><h2><a class="toc-backref" href="#id24">OrderableListMixin</a><a class="headerlink" href="#orderablelistmixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.</span></p>
</div>
<p>A mixin to allow easy ordering of your queryset basing on the GET parameters. Works with <cite>ListView</cite>.</p>
<p>To use it, define columns that the data can be ordered by, as well as the default column to order by in your view. This can be done either by simply setting the class attributes:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">ListView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">OrderableListMixin</span>


<span class="k">class</span> <span class="nc">OrderableListView</span><span class="p">(</span><span class="n">OrderableListMixin</span><span class="p">,</span> <span class="n">ListView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Article</span>
    <span class="n">orderable_columns</span> <span class="o">=</span> <span class="p">(</span><span class="s2">u&quot;id&quot;</span><span class="p">,</span> <span class="s2">u&quot;title&quot;</span><span class="p">,)</span>
    <span class="n">orderable_columns_default</span> <span class="o">=</span> <span class="s2">u&quot;id&quot;</span>
</pre></div>
</div>
<p>Or by using similarly-named methods to set the ordering constraints more dynamically:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># views.py</span>
<span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">ListView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">OrderableListMixin</span>


<span class="k">class</span> <span class="nc">OrderableListView</span><span class="p">(</span><span class="n">OrderableListMixin</span><span class="p">,</span> <span class="n">ListView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Article</span>

    <span class="k">def</span> <span class="nf">get_orderable_columns</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="c1"># return an iterable</span>
        <span class="k">return</span> <span class="p">(</span><span class="s2">u&quot;id&quot;</span><span class="p">,</span> <span class="s2">u&quot;title&quot;</span><span class="p">,)</span>

    <span class="k">def</span> <span class="nf">get_orderable_columns_default</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="c1"># return a string</span>
        <span class="k">return</span> <span class="s2">u&quot;id&quot;</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">orderable_columns</span></code> restriction is here in order to stop your users from launching inefficient queries, like ordering by binary columns.</p>
<p><code class="docutils literal"><span class="pre">OrderableListMixin</span></code> will order your queryset basing on following GET params:</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal"><span class="pre">order_by</span></code>: column name, e.g. <code class="docutils literal"><span class="pre">&quot;title&quot;</span></code></li>
<li><code class="docutils literal"><span class="pre">ordering</span></code>: <code class="docutils literal"><span class="pre">&quot;asc&quot;</span></code> (default) or <code class="docutils literal"><span class="pre">&quot;desc&quot;</span></code></li>
</ul>
</div></blockquote>
<p>Example url: <cite>http://127.0.0.1:8000/articles/?order_by=title&amp;ordering=asc</cite></p>
<p><strong>Front-end Example Usage</strong></p>
<p>If you&#8217;re using bootstrap you could create a template like the following:</p>
<div class="code html highlight-default"><div class="highlight"><pre><span></span>&lt;div class=&quot;table-responsive&quot;&gt;
    &lt;table class=&quot;table table-striped table-bordered&quot;&gt;
        &lt;tr&gt;
            &lt;th&gt;&lt;a class=&quot;order-by-column&quot; data-column=&quot;id&quot; href=&quot;#&quot;&gt;ID&lt;/a&gt;&lt;/th&gt;
            &lt;th&gt;&lt;a class=&quot;order-by-column&quot; data-column=&quot;title&quot; href=&quot;#&quot;&gt;Title&lt;/a&gt;&lt;/th&gt;
        &lt;/tr&gt;
        {% for object in object_list %}
            &lt;tr&gt;
                &lt;td&gt;{{ object.id }}&lt;/td&gt;
                &lt;td&gt;{{ object.title }}&lt;/td&gt;
            &lt;/tr&gt;
        {% endfor %}
    &lt;/table&gt;
&lt;/div&gt;

&lt;script&gt;
function setupOrderedColumns(order_by, orderin) {

    $(&#39;.order-by-column&#39;).each(function() {

        var $el = $(this),
            column_name = $el.data(&#39;column&#39;),
            href = location.href,
            next_order = &#39;asc&#39;,
            has_query_string = (href.indexOf(&#39;?&#39;) !== -1),
            order_by_param,
            ordering_param;

        if (order_by === column_name) {
            $el.addClass(&#39;current&#39;);
            $el.addClass(ordering);
            $el.append(&#39;&lt;span class=&quot;caret&quot;&gt;&lt;/span&gt;&#39;);
            if (ordering === &#39;asc&#39;) {
                $el.addClass(&#39;dropup&#39;);
                next_order = &#39;desc&#39;;
            }
        }

        order_by_param = &quot;order_by=&quot; + column_name;
        ordering_param = &quot;ordering=&quot; + next_order;

        if (!has_query_string) {
            href = &#39;?&#39; + order_by_param + &#39;&amp;&#39; + ordering_param;
        } else {
            if (href.match(/ordering=(asc|desc)/)) {
                href = href.replace(/ordering=(asc|desc)/, ordering_param);
            } else {
                href += &#39;&amp;&#39; + ordering_param;
            }

            if (href.match(/order_by=[_\w]+/)) {
                href = href.replace(/order_by=([_\w]+)/, order_by_param);
            } else {
                href += &#39;&amp;&#39; + order_by_param;
            }

        }

        $el.attr(&#39;href&#39;, href);

    });
}
setupOrderedColumns(&#39;{{ order_by }}&#39;, &#39;{{ ordering }}&#39;);
&lt;/script&gt;
</pre></div>
</div>
</div>
<div class="section" id="canonicalslugdetailmixin">
<span id="id9"></span><h2><a class="toc-backref" href="#id25">CanonicalSlugDetailMixin</a><a class="headerlink" href="#canonicalslugdetailmixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.3.</span></p>
</div>
<p>A mixin that enforces a canonical slug in the URL. Works with <code class="docutils literal"><span class="pre">DetailView</span></code>.</p>
<p>If a <code class="docutils literal"><span class="pre">urlpattern</span></code> takes a object&#8217;s <code class="docutils literal"><span class="pre">pk</span></code> and <code class="docutils literal"><span class="pre">slug</span></code> as arguments and the <code class="docutils literal"><span class="pre">slug</span></code> URL argument does not equal the object&#8217;s canonical slug, this mixin will redirect to the URL containing the canonical slug.</p>
<p>To use it, the <code class="docutils literal"><span class="pre">urlpattern</span></code> must accept both a <code class="docutils literal"><span class="pre">pk</span></code> and <code class="docutils literal"><span class="pre">slug</span></code> argument in its regex:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># urls.py</span>
<span class="n">urlpatterns</span> <span class="o">=</span> <span class="n">patterns</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span>
    <span class="n">url</span><span class="p">(</span><span class="s2">r&quot;^article/(?P&lt;pk&gt;\d+)-(?P&lt;slug&gt;[-\w]+)$&quot;</span><span class="p">)</span>
    <span class="n">ArticleView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span>
    <span class="s2">&quot;view_article&quot;</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Then create a standard <code class="docutils literal"><span class="pre">DetailView</span></code> that inherits this mixin:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">ArticleView</span><span class="p">(</span><span class="n">CanonicalSlugDetailMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Article</span>
</pre></div>
</div>
<p>Now, given an <code class="docutils literal"><span class="pre">Article</span></code> object with <code class="docutils literal"><span class="pre">{pk:</span> <span class="pre">1,</span> <span class="pre">slug:</span> <span class="pre">'hello-world'}</span></code>, the URL <cite>http://127.0.0.1:8000/article/1-goodbye-moon</cite> will redirect to <cite>http://127.0.0.1:8000/article/1-hello-world</cite> with the HTTP status code 301 Moved Permanently. Any other non-canonical slug, not just &#8216;goodbye-moon&#8217;, will trigger the redirect as well.</p>
<p>Control the canonical slug by either implementing the method <code class="docutils literal"><span class="pre">get_canonical_slug()</span></code> on the model class:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Article</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
    <span class="n">blog</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="s1">&#39;Blog&#39;</span><span class="p">)</span>
    <span class="n">slug</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">SlugField</span><span class="p">()</span>

    <span class="k">def</span> <span class="nf">get_canonical_slug</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
      <span class="k">return</span> <span class="s2">&quot;</span><span class="si">{0}</span><span class="s2">-</span><span class="si">{1}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">blog</span><span class="o">.</span><span class="n">get_canonical_slug</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">slug</span><span class="p">)</span>
</pre></div>
</div>
<p>Or by overriding the <code class="docutils literal"><span class="pre">get_canonical_slug()</span></code> method on the view:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">ArticleView</span><span class="p">(</span><span class="n">CanonicalSlugDetailMixin</span><span class="p">,</span> <span class="n">DetailView</span><span class="p">):</span>
    <span class="n">model</span> <span class="o">=</span> <span class="n">Article</span>

    <span class="k">def</span> <span class="nf">get_canonical_slug</span><span class="p">():</span>
        <span class="kn">import</span> <span class="nn">codecs</span>
        <span class="k">return</span> <span class="n">codecs</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span><span class="o">.</span><span class="n">slug</span><span class="p">,</span> <span class="s2">&quot;rot_13&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>Given the same Article as before, this will generate urls of <cite>http://127.0.0.1:8000/article/1-my-blog-hello-world</cite> and <cite>http://127.0.0.1:8000/article/1-uryyb-jbeyq</cite>, respectively.</p>
</div>
<div class="section" id="messagemixin">
<span id="id10"></span><h2><a class="toc-backref" href="#id26">MessageMixin</a><a class="headerlink" href="#messagemixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.4.</span></p>
</div>
<p>A mixin that adds a <code class="docutils literal"><span class="pre">messages</span></code> attribute on the view which acts as a wrapper
to <code class="docutils literal"><span class="pre">django.contrib.messages</span></code> and passes the <code class="docutils literal"><span class="pre">request</span></code> object automatically.</p>
<blockquote>
<div><div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you&#8217;re using Django 1.4, then the <code class="docutils literal"><span class="pre">message</span></code> attribute is only
available after the base view&#8217;s <code class="docutils literal"><span class="pre">dispatch</span></code> method has been called
(so our second example would not work for instance).</p>
</div>
</div></blockquote>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">MessageMixin</span>


<span class="k">class</span> <span class="nc">MyView</span><span class="p">(</span><span class="n">MessageMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This view will add a debug message which can then be displayed</span>
<span class="sd">    in the template.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">&quot;my_template.html&quot;</span>

    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;This is a debug message.&quot;</span><span class="p">)</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">MyView</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.contrib</span> <span class="k">import</span> <span class="n">messages</span>
<span class="kn">from</span> <span class="nn">django.views.generic</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">MessageMixin</span>


<span class="k">class</span> <span class="nc">OnlyWarningView</span><span class="p">(</span><span class="n">MessageMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This view will only show messages that have a level</span>
<span class="sd">    above `warning`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">&quot;my_template.html&quot;</span>

    <span class="k">def</span> <span class="nf">dispatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">set_level</span><span class="p">(</span><span class="n">messages</span><span class="o">.</span><span class="n">WARNING</span><span class="p">)</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">OnlyWarningView</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">dispatch</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="allverbsmixin">
<span id="id11"></span><h2><a class="toc-backref" href="#id27">AllVerbsMixin</a><a class="headerlink" href="#allverbsmixin" title="Permalink to this headline"></a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.4.</span></p>
</div>
<p>This mixin allows you to specify a single method that will response to all HTTP verbs, making a class-based view behave much like a function-based view.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.views</span> <span class="k">import</span> <span class="n">TemplateView</span>

<span class="kn">from</span> <span class="nn">braces.views</span> <span class="k">import</span> <span class="n">AllVerbsMixin</span>


<span class="k">class</span> <span class="nc">JustShowItView</span><span class="p">(</span><span class="n">AllVerbsMixin</span><span class="p">,</span> <span class="n">TemplateView</span><span class="p">):</span>
    <span class="n">template_name</span> <span class="o">=</span> <span class="s2">&quot;just/show_it.html&quot;</span>

    <span class="k">def</span> <span class="nf">all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">JustShowItView</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>If you need to change the name of the method called, provide a new value to the <code class="docutils literal"><span class="pre">all_handler</span></code> attribute (default is <code class="docutils literal"><span class="pre">'all'</span></code>)</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Other Mixins</a><ul>
<li><a class="reference internal" href="#setheadlinemixin">SetHeadlineMixin</a><ul>
<li><a class="reference internal" href="#static-example">Static Example</a></li>
<li><a class="reference internal" href="#dynamic-example">Dynamic Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#staticcontextmixin">StaticContextMixin</a><ul>
<li><a class="reference internal" href="#view-example">View Example</a></li>
<li><a class="reference internal" href="#url-example">URL Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#selectrelatedmixin">SelectRelatedMixin</a></li>
<li><a class="reference internal" href="#prefetchrelatedmixin">PrefetchRelatedMixin</a></li>
<li><a class="reference internal" href="#jsonresponsemixin">JSONResponseMixin</a></li>
<li><a class="reference internal" href="#jsonrequestresponsemixin">JsonRequestResponseMixin</a></li>
<li><a class="reference internal" href="#ajaxresponsemixin">AjaxResponseMixin</a></li>
<li><a class="reference internal" href="#orderablelistmixin">OrderableListMixin</a></li>
<li><a class="reference internal" href="#canonicalslugdetailmixin">CanonicalSlugDetailMixin</a></li>
<li><a class="reference internal" href="#messagemixin">MessageMixin</a></li>
<li><a class="reference internal" href="#allverbsmixin">AllVerbsMixin</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="form.html"
                        title="previous chapter">Form Mixins</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/other.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="form.html" title="Form Mixins"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">django-braces 1.9.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2016, Kenneth Love and Chris Jones.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.4.
    </div>
  </body>
</html>