| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- <!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" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
- <title>flask.wrappers — proxypool documentation</title>
-
- <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
- <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../../',
- VERSION: '',
- 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="index" title="Index" href="../../genindex.html" />
- <link rel="search" title="Search" href="../../search.html" />
- <link rel="top" title="proxypool documentation" href="../../index.html" />
- <link rel="up" title="Module code" href="../index.html" />
-
- <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
-
-
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
- </head>
- <body role="document">
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <h1>Source code for flask.wrappers</h1><div class="highlight"><pre>
- <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
- <span class="sd">"""</span>
- <span class="sd"> flask.wrappers</span>
- <span class="sd"> ~~~~~~~~~~~~~~</span>
- <span class="sd"> Implements the WSGI wrappers (request and response).</span>
- <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
- <span class="sd"> :license: BSD, see LICENSE for more details.</span>
- <span class="sd">"""</span>
- <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>
- <span class="kn">from</span> <span class="nn">werkzeug.exceptions</span> <span class="k">import</span> <span class="n">BadRequest</span>
- <span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">json</span>
- <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
- <span class="n">_missing</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
- <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>
- <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">'get_data'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
- <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>
- <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>
- <span class="k">return</span> <span class="n">req</span><span class="o">.</span><span class="n">data</span>
- <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>
- <span class="sd">"""The request object used by default in Flask. Remembers the</span>
- <span class="sd"> matched endpoint and view arguments.</span>
- <span class="sd"> It is what ends up as :class:`~flask.request`. If you want to replace</span>
- <span class="sd"> the request object used you can subclass this and set</span>
- <span class="sd"> :attr:`~flask.Flask.request_class` to your subclass.</span>
- <span class="sd"> The request object is a :class:`~werkzeug.wrappers.Request` subclass and</span>
- <span class="sd"> provides all of the attributes Werkzeug defines plus a few Flask</span>
- <span class="sd"> specific ones.</span>
- <span class="sd"> """</span>
- <span class="c1">#: The internal URL rule that matched the request. This can be</span>
- <span class="c1">#: useful to inspect which methods are allowed for the URL from</span>
- <span class="c1">#: a before/after handler (``request.url_rule.methods``) etc.</span>
- <span class="c1">#:</span>
- <span class="c1">#: .. versionadded:: 0.6</span>
- <span class="n">url_rule</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="c1">#: A dict of view arguments that matched the request. If an exception</span>
- <span class="c1">#: happened when matching, this will be ``None``.</span>
- <span class="n">view_args</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="c1">#: If matching the URL failed, this is the exception that will be</span>
- <span class="c1">#: raised / was raised as part of the request handling. This is</span>
- <span class="c1">#: usually a :exc:`~werkzeug.exceptions.NotFound` exception or</span>
- <span class="c1">#: something similar.</span>
- <span class="n">routing_exception</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="c1"># Switched by the request context until 1.0 to opt in deprecated</span>
- <span class="c1"># module functionality.</span>
- <span class="n">_is_old_module</span> <span class="o">=</span> <span class="kc">False</span>
- <span class="nd">@property</span>
- <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>
- <span class="sd">"""Read-only view of the ``MAX_CONTENT_LENGTH`` config key."""</span>
- <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>
- <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>
- <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">'MAX_CONTENT_LENGTH'</span><span class="p">]</span>
- <span class="nd">@property</span>
- <span class="k">def</span> <span class="nf">endpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""The endpoint that matched the request. This in combination with</span>
- <span class="sd"> :attr:`view_args` can be used to reconstruct the same or a</span>
- <span class="sd"> modified URL. If an exception happened when matching, this will</span>
- <span class="sd"> be ``None``.</span>
- <span class="sd"> """</span>
- <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>
- <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="nd">@property</span>
- <span class="k">def</span> <span class="nf">module</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""The name of the current module if the request was dispatched</span>
- <span class="sd"> to an actual module. This is deprecated functionality, use blueprints</span>
- <span class="sd"> instead.</span>
- <span class="sd"> """</span>
- <span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
- <span class="n">warn</span><span class="p">(</span><span class="ne">DeprecationWarning</span><span class="p">(</span><span class="s1">'modules were deprecated in favor of '</span>
- <span class="s1">'blueprints. Use request.blueprint '</span>
- <span class="s1">'instead.'</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
- <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>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span>
- <span class="nd">@property</span>
- <span class="k">def</span> <span class="nf">blueprint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""The name of the current blueprint"""</span>
- <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">'.'</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>
- <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">'.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
- <span class="nd">@property</span>
- <span class="k">def</span> <span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""If the mimetype is :mimetype:`application/json` this will contain the</span>
- <span class="sd"> parsed JSON data. Otherwise this will be ``None``.</span>
- <span class="sd"> The :meth:`get_json` method should be used instead.</span>
- <span class="sd"> """</span>
- <span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
- <span class="n">warn</span><span class="p">(</span><span class="ne">DeprecationWarning</span><span class="p">(</span><span class="s1">'json is deprecated. '</span>
- <span class="s1">'Use get_json() instead.'</span><span class="p">),</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_json</span><span class="p">()</span>
- <span class="nd">@property</span>
- <span class="k">def</span> <span class="nf">is_json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="sd">"""Indicates if this request is JSON or not. By default a request</span>
- <span class="sd"> is considered to include JSON data if the mimetype is</span>
- <span class="sd"> :mimetype:`application/json` or :mimetype:`application/*+json`.</span>
- <span class="sd"> .. versionadded:: 0.11</span>
- <span class="sd"> """</span>
- <span class="n">mt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mimetype</span>
- <span class="k">if</span> <span class="n">mt</span> <span class="o">==</span> <span class="s1">'application/json'</span><span class="p">:</span>
- <span class="k">return</span> <span class="kc">True</span>
- <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">'application/'</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">'+json'</span><span class="p">):</span>
- <span class="k">return</span> <span class="kc">True</span>
- <span class="k">return</span> <span class="kc">False</span>
- <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>
- <span class="sd">"""Parses the incoming JSON request data and returns it. By default</span>
- <span class="sd"> this function will return ``None`` if the mimetype is not</span>
- <span class="sd"> :mimetype:`application/json` but this can be overridden by the</span>
- <span class="sd"> ``force`` parameter. If parsing fails the</span>
- <span class="sd"> :meth:`on_json_loading_failed` method on the request object will be</span>
- <span class="sd"> invoked.</span>
- <span class="sd"> :param force: if set to ``True`` the mimetype is ignored.</span>
- <span class="sd"> :param silent: if set to ``True`` this method will fail silently</span>
- <span class="sd"> and return ``None``.</span>
- <span class="sd"> :param cache: if set to ``True`` the parsed JSON data is remembered</span>
- <span class="sd"> on the request.</span>
- <span class="sd"> """</span>
- <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">'_cached_json'</span><span class="p">,</span> <span class="n">_missing</span><span class="p">)</span>
- <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>
- <span class="k">return</span> <span class="n">rv</span>
- <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>
- <span class="k">return</span> <span class="kc">None</span>
- <span class="c1"># We accept a request charset against the specification as</span>
- <span class="c1"># certain clients have been using this in the past. This</span>
- <span class="c1"># fits our general approach of being nice in what we accept</span>
- <span class="c1"># and strict in what we send out.</span>
- <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">'charset'</span><span class="p">)</span>
- <span class="k">try</span><span class="p">:</span>
- <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>
- <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>
- <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>
- <span class="k">else</span><span class="p">:</span>
- <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="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">silent</span><span class="p">:</span>
- <span class="n">rv</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="k">else</span><span class="p">:</span>
- <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>
- <span class="k">if</span> <span class="n">cache</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">_cached_json</span> <span class="o">=</span> <span class="n">rv</span>
- <span class="k">return</span> <span class="n">rv</span></div>
- <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>
- <span class="sd">"""Called if decoding of the JSON data failed. The return value of</span>
- <span class="sd"> this method is used by :meth:`get_json` when an error occurred. The</span>
- <span class="sd"> default implementation just raises a :class:`BadRequest` exception.</span>
- <span class="sd"> .. versionchanged:: 0.10</span>
- <span class="sd"> Removed buggy previous behavior of generating a random JSON</span>
- <span class="sd"> response. If you want that behavior back you can trivially</span>
- <span class="sd"> add it by subclassing.</span>
- <span class="sd"> .. versionadded:: 0.8</span>
- <span class="sd"> """</span>
- <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>
- <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">'DEBUG'</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
- <span class="k">raise</span> <span class="n">BadRequest</span><span class="p">(</span><span class="s1">'Failed to decode JSON object: </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
- <span class="k">raise</span> <span class="n">BadRequest</span><span class="p">()</span></div>
- <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>
- <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>
- <span class="c1"># In debug mode we're replacing the files multidict with an ad-hoc</span>
- <span class="c1"># subclass that raises a different error for key errors.</span>
- <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>
- <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> \
- <span class="bp">self</span><span class="o">.</span><span class="n">mimetype</span> <span class="o">!=</span> <span class="s1">'multipart/form-data'</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>
- <span class="kn">from</span> <span class="nn">.debughelpers</span> <span class="k">import</span> <span class="n">attach_enctype_error_multidict</span>
- <span class="n">attach_enctype_error_multidict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
- <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>
- <span class="sd">"""The response object that is used by default in Flask. Works like the</span>
- <span class="sd"> response object from Werkzeug but is set to have an HTML mimetype by</span>
- <span class="sd"> default. Quite often you don't have to create this object yourself because</span>
- <span class="sd"> :meth:`~flask.Flask.make_response` will take care of that for you.</span>
- <span class="sd"> If you want to replace the response object used you can subclass this and</span>
- <span class="sd"> set :attr:`~flask.Flask.response_class` to your subclass.</span>
- <span class="sd"> """</span>
- <span class="n">default_mimetype</span> <span class="o">=</span> <span class="s1">'text/html'</span></div>
- </pre></div>
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper"><div class="relations">
- <h3>Related Topics</h3>
- <ul>
- <li><a href="../../index.html">Documentation overview</a><ul>
- <li><a href="../index.html">Module code</a><ul>
- </ul></li>
- </ul></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="footer">
- ©2016, Author.
-
- |
- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
-
- </div>
-
-
- </body>
- </html>
|