wrappers.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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.wrappers &#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.wrappers</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.wrappers</span>
  37. <span class="sd"> ~~~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements the WSGI wrappers (request and response).</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">werkzeug.wrappers</span> <span class="k">import</span> <span class="n">Request</span> <span class="k">as</span> <span class="n">RequestBase</span><span class="p">,</span> <span class="n">Response</span> <span class="k">as</span> <span class="n">ResponseBase</span>
  43. <span class="kn">from</span> <span class="nn">werkzeug.exceptions</span> <span class="k">import</span> <span class="n">BadRequest</span>
  44. <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">json</span>
  45. <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
  46. <span class="n">_missing</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
  47. <span class="k">def</span> <span class="nf">_get_data</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">cache</span><span class="p">):</span>
  48. <span class="n">getter</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="s1">&#39;get_data&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
  49. <span class="k">if</span> <span class="n">getter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  50. <span class="k">return</span> <span class="n">getter</span><span class="p">(</span><span class="n">cache</span><span class="o">=</span><span class="n">cache</span><span class="p">)</span>
  51. <span class="k">return</span> <span class="n">req</span><span class="o">.</span><span class="n">data</span>
  52. <div class="viewcode-block" id="Request"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Request">[docs]</a><span class="k">class</span> <span class="nc">Request</span><span class="p">(</span><span class="n">RequestBase</span><span class="p">):</span>
  53. <span class="sd">&quot;&quot;&quot;The request object used by default in Flask. Remembers the</span>
  54. <span class="sd"> matched endpoint and view arguments.</span>
  55. <span class="sd"> It is what ends up as :class:`~flask.request`. If you want to replace</span>
  56. <span class="sd"> the request object used you can subclass this and set</span>
  57. <span class="sd"> :attr:`~flask.Flask.request_class` to your subclass.</span>
  58. <span class="sd"> The request object is a :class:`~werkzeug.wrappers.Request` subclass and</span>
  59. <span class="sd"> provides all of the attributes Werkzeug defines plus a few Flask</span>
  60. <span class="sd"> specific ones.</span>
  61. <span class="sd"> &quot;&quot;&quot;</span>
  62. <span class="c1">#: The internal URL rule that matched the request. This can be</span>
  63. <span class="c1">#: useful to inspect which methods are allowed for the URL from</span>
  64. <span class="c1">#: a before/after handler (``request.url_rule.methods``) etc.</span>
  65. <span class="c1">#:</span>
  66. <span class="c1">#: .. versionadded:: 0.6</span>
  67. <span class="n">url_rule</span> <span class="o">=</span> <span class="kc">None</span>
  68. <span class="c1">#: A dict of view arguments that matched the request. If an exception</span>
  69. <span class="c1">#: happened when matching, this will be ``None``.</span>
  70. <span class="n">view_args</span> <span class="o">=</span> <span class="kc">None</span>
  71. <span class="c1">#: If matching the URL failed, this is the exception that will be</span>
  72. <span class="c1">#: raised / was raised as part of the request handling. This is</span>
  73. <span class="c1">#: usually a :exc:`~werkzeug.exceptions.NotFound` exception or</span>
  74. <span class="c1">#: something similar.</span>
  75. <span class="n">routing_exception</span> <span class="o">=</span> <span class="kc">None</span>
  76. <span class="c1"># Switched by the request context until 1.0 to opt in deprecated</span>
  77. <span class="c1"># module functionality.</span>
  78. <span class="n">_is_old_module</span> <span class="o">=</span> <span class="kc">False</span>
  79. <span class="nd">@property</span>
  80. <span class="k">def</span> <span class="nf">max_content_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  81. <span class="sd">&quot;&quot;&quot;Read-only view of the ``MAX_CONTENT_LENGTH`` config key.&quot;&quot;&quot;</span>
  82. <span class="n">ctx</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  83. <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  84. <span class="k">return</span> <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;MAX_CONTENT_LENGTH&#39;</span><span class="p">]</span>
  85. <span class="nd">@property</span>
  86. <span class="k">def</span> <span class="nf">endpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  87. <span class="sd">&quot;&quot;&quot;The endpoint that matched the request. This in combination with</span>
  88. <span class="sd"> :attr:`view_args` can be used to reconstruct the same or a</span>
  89. <span class="sd"> modified URL. If an exception happened when matching, this will</span>
  90. <span class="sd"> be ``None``.</span>
  91. <span class="sd"> &quot;&quot;&quot;</span>
  92. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_rule</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  93. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_rule</span><span class="o">.</span><span class="n">endpoint</span>
  94. <span class="nd">@property</span>
  95. <span class="k">def</span> <span class="nf">module</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  96. <span class="sd">&quot;&quot;&quot;The name of the current module if the request was dispatched</span>
  97. <span class="sd"> to an actual module. This is deprecated functionality, use blueprints</span>
  98. <span class="sd"> instead.</span>
  99. <span class="sd"> &quot;&quot;&quot;</span>
  100. <span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
  101. <span class="n">warn</span><span class="p">(</span><span class="ne">DeprecationWarning</span><span class="p">(</span><span class="s1">&#39;modules were deprecated in favor of &#39;</span>
  102. <span class="s1">&#39;blueprints. Use request.blueprint &#39;</span>
  103. <span class="s1">&#39;instead.&#39;</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
  104. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_old_module</span><span class="p">:</span>
  105. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span>
  106. <span class="nd">@property</span>
  107. <span class="k">def</span> <span class="nf">blueprint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  108. <span class="sd">&quot;&quot;&quot;The name of the current blueprint&quot;&quot;&quot;</span>
  109. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_rule</span> <span class="ow">and</span> <span class="s1">&#39;.&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_rule</span><span class="o">.</span><span class="n">endpoint</span><span class="p">:</span>
  110. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_rule</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  111. <span class="nd">@property</span>
  112. <span class="k">def</span> <span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  113. <span class="sd">&quot;&quot;&quot;If the mimetype is :mimetype:`application/json` this will contain the</span>
  114. <span class="sd"> parsed JSON data. Otherwise this will be ``None``.</span>
  115. <span class="sd"> The :meth:`get_json` method should be used instead.</span>
  116. <span class="sd"> &quot;&quot;&quot;</span>
  117. <span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
  118. <span class="n">warn</span><span class="p">(</span><span class="ne">DeprecationWarning</span><span class="p">(</span><span class="s1">&#39;json is deprecated. &#39;</span>
  119. <span class="s1">&#39;Use get_json() instead.&#39;</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
  120. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_json</span><span class="p">()</span>
  121. <span class="nd">@property</span>
  122. <span class="k">def</span> <span class="nf">is_json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  123. <span class="sd">&quot;&quot;&quot;Indicates if this request is JSON or not. By default a request</span>
  124. <span class="sd"> is considered to include JSON data if the mimetype is</span>
  125. <span class="sd"> :mimetype:`application/json` or :mimetype:`application/*+json`.</span>
  126. <span class="sd"> .. versionadded:: 0.11</span>
  127. <span class="sd"> &quot;&quot;&quot;</span>
  128. <span class="n">mt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mimetype</span>
  129. <span class="k">if</span> <span class="n">mt</span> <span class="o">==</span> <span class="s1">&#39;application/json&#39;</span><span class="p">:</span>
  130. <span class="k">return</span> <span class="kc">True</span>
  131. <span class="k">if</span> <span class="n">mt</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;application/&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">mt</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;+json&#39;</span><span class="p">):</span>
  132. <span class="k">return</span> <span class="kc">True</span>
  133. <span class="k">return</span> <span class="kc">False</span>
  134. <div class="viewcode-block" id="Request.get_json"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Request.get_json">[docs]</a> <span class="k">def</span> <span class="nf">get_json</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">silent</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">cache</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  135. <span class="sd">&quot;&quot;&quot;Parses the incoming JSON request data and returns it. By default</span>
  136. <span class="sd"> this function will return ``None`` if the mimetype is not</span>
  137. <span class="sd"> :mimetype:`application/json` but this can be overridden by the</span>
  138. <span class="sd"> ``force`` parameter. If parsing fails the</span>
  139. <span class="sd"> :meth:`on_json_loading_failed` method on the request object will be</span>
  140. <span class="sd"> invoked.</span>
  141. <span class="sd"> :param force: if set to ``True`` the mimetype is ignored.</span>
  142. <span class="sd"> :param silent: if set to ``True`` this method will fail silently</span>
  143. <span class="sd"> and return ``None``.</span>
  144. <span class="sd"> :param cache: if set to ``True`` the parsed JSON data is remembered</span>
  145. <span class="sd"> on the request.</span>
  146. <span class="sd"> &quot;&quot;&quot;</span>
  147. <span class="n">rv</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;_cached_json&#39;</span><span class="p">,</span> <span class="n">_missing</span><span class="p">)</span>
  148. <span class="k">if</span> <span class="n">rv</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_missing</span><span class="p">:</span>
  149. <span class="k">return</span> <span class="n">rv</span>
  150. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">force</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_json</span><span class="p">):</span>
  151. <span class="k">return</span> <span class="kc">None</span>
  152. <span class="c1"># We accept a request charset against the specification as</span>
  153. <span class="c1"># certain clients have been using this in the past. This</span>
  154. <span class="c1"># fits our general approach of being nice in what we accept</span>
  155. <span class="c1"># and strict in what we send out.</span>
  156. <span class="n">request_charset</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mimetype_params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;charset&#39;</span><span class="p">)</span>
  157. <span class="k">try</span><span class="p">:</span>
  158. <span class="n">data</span> <span class="o">=</span> <span class="n">_get_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cache</span><span class="p">)</span>
  159. <span class="k">if</span> <span class="n">request_charset</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  160. <span class="n">rv</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">request_charset</span><span class="p">)</span>
  161. <span class="k">else</span><span class="p">:</span>
  162. <span class="n">rv</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
  163. <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
  164. <span class="k">if</span> <span class="n">silent</span><span class="p">:</span>
  165. <span class="n">rv</span> <span class="o">=</span> <span class="kc">None</span>
  166. <span class="k">else</span><span class="p">:</span>
  167. <span class="n">rv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_json_loading_failed</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
  168. <span class="k">if</span> <span class="n">cache</span><span class="p">:</span>
  169. <span class="bp">self</span><span class="o">.</span><span class="n">_cached_json</span> <span class="o">=</span> <span class="n">rv</span>
  170. <span class="k">return</span> <span class="n">rv</span></div>
  171. <div class="viewcode-block" id="Request.on_json_loading_failed"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Request.on_json_loading_failed">[docs]</a> <span class="k">def</span> <span class="nf">on_json_loading_failed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">e</span><span class="p">):</span>
  172. <span class="sd">&quot;&quot;&quot;Called if decoding of the JSON data failed. The return value of</span>
  173. <span class="sd"> this method is used by :meth:`get_json` when an error occurred. The</span>
  174. <span class="sd"> default implementation just raises a :class:`BadRequest` exception.</span>
  175. <span class="sd"> .. versionchanged:: 0.10</span>
  176. <span class="sd"> Removed buggy previous behavior of generating a random JSON</span>
  177. <span class="sd"> response. If you want that behavior back you can trivially</span>
  178. <span class="sd"> add it by subclassing.</span>
  179. <span class="sd"> .. versionadded:: 0.8</span>
  180. <span class="sd"> &quot;&quot;&quot;</span>
  181. <span class="n">ctx</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  182. <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;DEBUG&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
  183. <span class="k">raise</span> <span class="n">BadRequest</span><span class="p">(</span><span class="s1">&#39;Failed to decode JSON object: </span><span class="si">{0}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
  184. <span class="k">raise</span> <span class="n">BadRequest</span><span class="p">()</span></div>
  185. <span class="k">def</span> <span class="nf">_load_form_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  186. <span class="n">RequestBase</span><span class="o">.</span><span class="n">_load_form_data</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  187. <span class="c1"># In debug mode we&#39;re replacing the files multidict with an ad-hoc</span>
  188. <span class="c1"># subclass that raises a different error for key errors.</span>
  189. <span class="n">ctx</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  190. <span class="k">if</span> <span class="n">ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">ctx</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">debug</span> <span class="ow">and</span> \
  191. <span class="bp">self</span><span class="o">.</span><span class="n">mimetype</span> <span class="o">!=</span> <span class="s1">&#39;multipart/form-data&#39;</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">:</span>
  192. <span class="kn">from</span> <span class="nn">.debughelpers</span> <span class="k">import</span> <span class="n">attach_enctype_error_multidict</span>
  193. <span class="n">attach_enctype_error_multidict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
  194. <div class="viewcode-block" id="Response"><a class="viewcode-back" href="../../flask/flask.html#flask.app.Response">[docs]</a><span class="k">class</span> <span class="nc">Response</span><span class="p">(</span><span class="n">ResponseBase</span><span class="p">):</span>
  195. <span class="sd">&quot;&quot;&quot;The response object that is used by default in Flask. Works like the</span>
  196. <span class="sd"> response object from Werkzeug but is set to have an HTML mimetype by</span>
  197. <span class="sd"> default. Quite often you don&#39;t have to create this object yourself because</span>
  198. <span class="sd"> :meth:`~flask.Flask.make_response` will take care of that for you.</span>
  199. <span class="sd"> If you want to replace the response object used you can subclass this and</span>
  200. <span class="sd"> set :attr:`~flask.Flask.response_class` to your subclass.</span>
  201. <span class="sd"> &quot;&quot;&quot;</span>
  202. <span class="n">default_mimetype</span> <span class="o">=</span> <span class="s1">&#39;text/html&#39;</span></div>
  203. </pre></div>
  204. </div>
  205. </div>
  206. </div>
  207. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  208. <div class="sphinxsidebarwrapper"><div class="relations">
  209. <h3>Related Topics</h3>
  210. <ul>
  211. <li><a href="../../index.html">Documentation overview</a><ul>
  212. <li><a href="../index.html">Module code</a><ul>
  213. </ul></li>
  214. </ul></li>
  215. </ul>
  216. </div>
  217. <div id="searchbox" style="display: none" role="search">
  218. <h3>Quick search</h3>
  219. <form class="search" action="../../search.html" method="get">
  220. <div><input type="text" name="q" /></div>
  221. <div><input type="submit" value="Go" /></div>
  222. <input type="hidden" name="check_keywords" value="yes" />
  223. <input type="hidden" name="area" value="default" />
  224. </form>
  225. </div>
  226. <script type="text/javascript">$('#searchbox').show(0);</script>
  227. </div>
  228. </div>
  229. <div class="clearer"></div>
  230. </div>
  231. <div class="footer">
  232. &copy;2016, Author.
  233. |
  234. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  235. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  236. </div>
  237. </body>
  238. </html>