views.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>flask.views &#8212; proxypool documentation</title>
  7. <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="index" title="Index" href="../../genindex.html" />
  22. <link rel="search" title="Search" href="../../search.html" />
  23. <link rel="top" title="proxypool documentation" href="../../index.html" />
  24. <link rel="up" title="Module code" href="../index.html" />
  25. <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body role="document">
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <h1>Source code for flask.views</h1><div class="highlight"><pre>
  34. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  35. <span class="sd">&quot;&quot;&quot;</span>
  36. <span class="sd"> flask.views</span>
  37. <span class="sd"> ~~~~~~~~~~~</span>
  38. <span class="sd"> This module provides class-based views inspired by the ones in Django.</span>
  39. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  40. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  41. <span class="sd">&quot;&quot;&quot;</span>
  42. <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">request</span>
  43. <span class="kn">from</span> <span class="nn">._compat</span> <span class="k">import</span> <span class="n">with_metaclass</span>
  44. <span class="n">http_method_funcs</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="s1">&#39;get&#39;</span><span class="p">,</span> <span class="s1">&#39;post&#39;</span><span class="p">,</span> <span class="s1">&#39;head&#39;</span><span class="p">,</span> <span class="s1">&#39;options&#39;</span><span class="p">,</span>
  45. <span class="s1">&#39;delete&#39;</span><span class="p">,</span> <span class="s1">&#39;put&#39;</span><span class="p">,</span> <span class="s1">&#39;trace&#39;</span><span class="p">,</span> <span class="s1">&#39;patch&#39;</span><span class="p">])</span>
  46. <div class="viewcode-block" id="View"><a class="viewcode-back" href="../../flask/flask.html#flask.views.View">[docs]</a><span class="k">class</span> <span class="nc">View</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  47. <span class="sd">&quot;&quot;&quot;Alternative way to use view functions. A subclass has to implement</span>
  48. <span class="sd"> :meth:`dispatch_request` which is called with the view arguments from</span>
  49. <span class="sd"> the URL routing system. If :attr:`methods` is provided the methods</span>
  50. <span class="sd"> do not have to be passed to the :meth:`~flask.Flask.add_url_rule`</span>
  51. <span class="sd"> method explicitly::</span>
  52. <span class="sd"> class MyView(View):</span>
  53. <span class="sd"> methods = [&#39;GET&#39;]</span>
  54. <span class="sd"> def dispatch_request(self, name):</span>
  55. <span class="sd"> return &#39;Hello %s!&#39; % name</span>
  56. <span class="sd"> app.add_url_rule(&#39;/hello/&lt;name&gt;&#39;, view_func=MyView.as_view(&#39;myview&#39;))</span>
  57. <span class="sd"> When you want to decorate a pluggable view you will have to either do that</span>
  58. <span class="sd"> when the view function is created (by wrapping the return value of</span>
  59. <span class="sd"> :meth:`as_view`) or you can use the :attr:`decorators` attribute::</span>
  60. <span class="sd"> class SecretView(View):</span>
  61. <span class="sd"> methods = [&#39;GET&#39;]</span>
  62. <span class="sd"> decorators = [superuser_required]</span>
  63. <span class="sd"> def dispatch_request(self):</span>
  64. <span class="sd"> ...</span>
  65. <span class="sd"> The decorators stored in the decorators list are applied one after another</span>
  66. <span class="sd"> when the view function is created. Note that you can *not* use the class</span>
  67. <span class="sd"> based decorators since those would decorate the view class and not the</span>
  68. <span class="sd"> generated view function!</span>
  69. <span class="sd"> &quot;&quot;&quot;</span>
  70. <span class="c1">#: A list of methods this view can handle.</span>
  71. <span class="n">methods</span> <span class="o">=</span> <span class="kc">None</span>
  72. <span class="c1">#: The canonical way to decorate class-based views is to decorate the</span>
  73. <span class="c1">#: return value of as_view(). However since this moves parts of the</span>
  74. <span class="c1">#: logic from the class declaration to the place where it&#39;s hooked</span>
  75. <span class="c1">#: into the routing system.</span>
  76. <span class="c1">#:</span>
  77. <span class="c1">#: You can place one or more decorators in this list and whenever the</span>
  78. <span class="c1">#: view function is created the result is automatically decorated.</span>
  79. <span class="c1">#:</span>
  80. <span class="c1">#: .. versionadded:: 0.8</span>
  81. <span class="n">decorators</span> <span class="o">=</span> <span class="p">()</span>
  82. <div class="viewcode-block" id="View.dispatch_request"><a class="viewcode-back" href="../../flask/flask.html#flask.views.View.dispatch_request">[docs]</a> <span class="k">def</span> <span class="nf">dispatch_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  83. <span class="sd">&quot;&quot;&quot;Subclasses have to override this method to implement the</span>
  84. <span class="sd"> actual view function code. This method is called with all</span>
  85. <span class="sd"> the arguments from the URL rule.</span>
  86. <span class="sd"> &quot;&quot;&quot;</span>
  87. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
  88. <span class="nd">@classmethod</span>
  89. <div class="viewcode-block" id="View.as_view"><a class="viewcode-back" href="../../flask/flask.html#flask.views.View.as_view">[docs]</a> <span class="k">def</span> <span class="nf">as_view</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="o">*</span><span class="n">class_args</span><span class="p">,</span> <span class="o">**</span><span class="n">class_kwargs</span><span class="p">):</span>
  90. <span class="sd">&quot;&quot;&quot;Converts the class into an actual view function that can be used</span>
  91. <span class="sd"> with the routing system. Internally this generates a function on the</span>
  92. <span class="sd"> fly which will instantiate the :class:`View` on each request and call</span>
  93. <span class="sd"> the :meth:`dispatch_request` method on it.</span>
  94. <span class="sd"> The arguments passed to :meth:`as_view` are forwarded to the</span>
  95. <span class="sd"> constructor of the class.</span>
  96. <span class="sd"> &quot;&quot;&quot;</span>
  97. <span class="k">def</span> <span class="nf">view</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>
  98. <span class="bp">self</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">view_class</span><span class="p">(</span><span class="o">*</span><span class="n">class_args</span><span class="p">,</span> <span class="o">**</span><span class="n">class_kwargs</span><span class="p">)</span>
  99. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispatch_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>
  100. <span class="k">if</span> <span class="n">cls</span><span class="o">.</span><span class="n">decorators</span><span class="p">:</span>
  101. <span class="n">view</span><span class="o">.</span><span class="n">__name__</span> <span class="o">=</span> <span class="n">name</span>
  102. <span class="n">view</span><span class="o">.</span><span class="n">__module__</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">__module__</span>
  103. <span class="k">for</span> <span class="n">decorator</span> <span class="ow">in</span> <span class="n">cls</span><span class="o">.</span><span class="n">decorators</span><span class="p">:</span>
  104. <span class="n">view</span> <span class="o">=</span> <span class="n">decorator</span><span class="p">(</span><span class="n">view</span><span class="p">)</span>
  105. <span class="c1"># We attach the view class to the view function for two reasons:</span>
  106. <span class="c1"># first of all it allows us to easily figure out what class-based</span>
  107. <span class="c1"># view this thing came from, secondly it&#39;s also used for instantiating</span>
  108. <span class="c1"># the view class so you can actually replace it with something else</span>
  109. <span class="c1"># for testing purposes and debugging.</span>
  110. <span class="n">view</span><span class="o">.</span><span class="n">view_class</span> <span class="o">=</span> <span class="n">cls</span>
  111. <span class="n">view</span><span class="o">.</span><span class="n">__name__</span> <span class="o">=</span> <span class="n">name</span>
  112. <span class="n">view</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">__doc__</span>
  113. <span class="n">view</span><span class="o">.</span><span class="n">__module__</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">__module__</span>
  114. <span class="n">view</span><span class="o">.</span><span class="n">methods</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">methods</span>
  115. <span class="k">return</span> <span class="n">view</span></div></div>
  116. <div class="viewcode-block" id="MethodViewType"><a class="viewcode-back" href="../../flask/flask.html#flask.views.MethodViewType">[docs]</a><span class="k">class</span> <span class="nc">MethodViewType</span><span class="p">(</span><span class="nb">type</span><span class="p">):</span>
  117. <span class="k">def</span> <span class="nf">__new__</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>
  118. <span class="n">rv</span> <span class="o">=</span> <span class="nb">type</span><span class="o">.</span><span class="n">__new__</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">d</span><span class="p">)</span>
  119. <span class="k">if</span> <span class="s1">&#39;methods&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">d</span><span class="p">:</span>
  120. <span class="n">methods</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">rv</span><span class="o">.</span><span class="n">methods</span> <span class="ow">or</span> <span class="p">[])</span>
  121. <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">d</span><span class="p">:</span>
  122. <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">http_method_funcs</span><span class="p">:</span>
  123. <span class="n">methods</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">key</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
  124. <span class="c1"># If we have no method at all in there we don&#39;t want to</span>
  125. <span class="c1"># add a method list. (This is for instance the case for</span>
  126. <span class="c1"># the base class or another subclass of a base method view</span>
  127. <span class="c1"># that does not introduce new methods).</span>
  128. <span class="k">if</span> <span class="n">methods</span><span class="p">:</span>
  129. <span class="n">rv</span><span class="o">.</span><span class="n">methods</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">methods</span><span class="p">)</span>
  130. <span class="k">return</span> <span class="n">rv</span></div>
  131. <div class="viewcode-block" id="MethodView"><a class="viewcode-back" href="../../flask/flask.html#flask.views.MethodView">[docs]</a><span class="k">class</span> <span class="nc">MethodView</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">MethodViewType</span><span class="p">,</span> <span class="n">View</span><span class="p">)):</span>
  132. <span class="sd">&quot;&quot;&quot;Like a regular class-based view but that dispatches requests to</span>
  133. <span class="sd"> particular methods. For instance if you implement a method called</span>
  134. <span class="sd"> :meth:`get` it means you will response to ``&#39;GET&#39;`` requests and</span>
  135. <span class="sd"> the :meth:`dispatch_request` implementation will automatically</span>
  136. <span class="sd"> forward your request to that. Also :attr:`options` is set for you</span>
  137. <span class="sd"> automatically::</span>
  138. <span class="sd"> class CounterAPI(MethodView):</span>
  139. <span class="sd"> def get(self):</span>
  140. <span class="sd"> return session.get(&#39;counter&#39;, 0)</span>
  141. <span class="sd"> def post(self):</span>
  142. <span class="sd"> session[&#39;counter&#39;] = session.get(&#39;counter&#39;, 0) + 1</span>
  143. <span class="sd"> return &#39;OK&#39;</span>
  144. <span class="sd"> app.add_url_rule(&#39;/counter&#39;, view_func=CounterAPI.as_view(&#39;counter&#39;))</span>
  145. <span class="sd"> &quot;&quot;&quot;</span>
  146. <div class="viewcode-block" id="MethodView.dispatch_request"><a class="viewcode-back" href="../../flask/flask.html#flask.views.MethodView.dispatch_request">[docs]</a> <span class="k">def</span> <span class="nf">dispatch_request</span><span class="p">(</span><span class="bp">self</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>
  147. <span class="n">meth</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
  148. <span class="c1"># If the request method is HEAD and we don&#39;t have a handler for it</span>
  149. <span class="c1"># retry with GET.</span>
  150. <span class="k">if</span> <span class="n">meth</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">request</span><span class="o">.</span><span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;HEAD&#39;</span><span class="p">:</span>
  151. <span class="n">meth</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;get&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
  152. <span class="k">assert</span> <span class="n">meth</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;Unimplemented method </span><span class="si">%r</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">method</span>
  153. <span class="k">return</span> <span class="n">meth</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></div></div>
  154. </pre></div>
  155. </div>
  156. </div>
  157. </div>
  158. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  159. <div class="sphinxsidebarwrapper"><div class="relations">
  160. <h3>Related Topics</h3>
  161. <ul>
  162. <li><a href="../../index.html">Documentation overview</a><ul>
  163. <li><a href="../index.html">Module code</a><ul>
  164. </ul></li>
  165. </ul></li>
  166. </ul>
  167. </div>
  168. <div id="searchbox" style="display: none" role="search">
  169. <h3>Quick search</h3>
  170. <form class="search" action="../../search.html" method="get">
  171. <div><input type="text" name="q" /></div>
  172. <div><input type="submit" value="Go" /></div>
  173. <input type="hidden" name="check_keywords" value="yes" />
  174. <input type="hidden" name="area" value="default" />
  175. </form>
  176. </div>
  177. <script type="text/javascript">$('#searchbox').show(0);</script>
  178. </div>
  179. </div>
  180. <div class="clearer"></div>
  181. </div>
  182. <div class="footer">
  183. &copy;2016, Author.
  184. |
  185. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  186. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  187. </div>
  188. </body>
  189. </html>