| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243 |
- <!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.debughelpers — 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.debughelpers</h1><div class="highlight"><pre>
- <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
- <span class="sd">"""</span>
- <span class="sd"> flask.debughelpers</span>
- <span class="sd"> ~~~~~~~~~~~~~~~~~~</span>
- <span class="sd"> Various helpers to make the development experience better.</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">._compat</span> <span class="k">import</span> <span class="n">implements_to_string</span><span class="p">,</span> <span class="n">text_type</span>
- <span class="kn">from</span> <span class="nn">.app</span> <span class="k">import</span> <span class="n">Flask</span>
- <span class="kn">from</span> <span class="nn">.blueprints</span> <span class="k">import</span> <span class="n">Blueprint</span>
- <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
- <div class="viewcode-block" id="UnexpectedUnicodeError"><a class="viewcode-back" href="../../flask/flask.html#flask.debughelpers.UnexpectedUnicodeError">[docs]</a><span class="k">class</span> <span class="nc">UnexpectedUnicodeError</span><span class="p">(</span><span class="ne">AssertionError</span><span class="p">,</span> <span class="ne">UnicodeError</span><span class="p">):</span>
- <span class="sd">"""Raised in places where we want some better error reporting for</span>
- <span class="sd"> unexpected unicode or binary data.</span>
- <span class="sd"> """</span></div>
- <span class="nd">@implements_to_string</span>
- <div class="viewcode-block" id="DebugFilesKeyError"><a class="viewcode-back" href="../../flask/flask.html#flask.debughelpers.DebugFilesKeyError">[docs]</a><span class="k">class</span> <span class="nc">DebugFilesKeyError</span><span class="p">(</span><span class="ne">KeyError</span><span class="p">,</span> <span class="ne">AssertionError</span><span class="p">):</span>
- <span class="sd">"""Raised from request.files during debugging. The idea is that it can</span>
- <span class="sd"> provide a better error message than just a generic KeyError/BadRequest.</span>
- <span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</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="n">key</span><span class="p">):</span>
- <span class="n">form_matches</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">getlist</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
- <span class="n">buf</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'You tried to access the file "</span><span class="si">%s</span><span class="s1">" in the request.files '</span>
- <span class="s1">'dictionary but it does not exist. The mimetype for the request '</span>
- <span class="s1">'is "</span><span class="si">%s</span><span class="s1">" instead of "multipart/form-data" which means that no '</span>
- <span class="s1">'file contents were transmitted. To fix this error you should '</span>
- <span class="s1">'provide enctype="multipart/form-data" in your form.'</span> <span class="o">%</span>
- <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">mimetype</span><span class="p">)]</span>
- <span class="k">if</span> <span class="n">form_matches</span><span class="p">:</span>
- <span class="n">buf</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'</span><span class="se">\n\n</span><span class="s1">The browser instead transmitted some file names. '</span>
- <span class="s1">'This was submitted: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'"</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">x</span>
- <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">form_matches</span><span class="p">))</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buf</span><span class="p">)</span>
- <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span></div>
- <div class="viewcode-block" id="FormDataRoutingRedirect"><a class="viewcode-back" href="../../flask/flask.html#flask.debughelpers.FormDataRoutingRedirect">[docs]</a><span class="k">class</span> <span class="nc">FormDataRoutingRedirect</span><span class="p">(</span><span class="ne">AssertionError</span><span class="p">):</span>
- <span class="sd">"""This exception is raised by Flask in debug mode if it detects a</span>
- <span class="sd"> redirect caused by the routing system when the request method is not</span>
- <span class="sd"> GET, HEAD or OPTIONS. Reasoning: form data will be dropped.</span>
- <span class="sd"> """</span>
- <span class="k">def</span> <span class="nf">__init__</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="n">exc</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">routing_exception</span>
- <span class="n">buf</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'A request was sent to this URL (</span><span class="si">%s</span><span class="s1">) but a redirect was '</span>
- <span class="s1">'issued automatically by the routing system to "</span><span class="si">%s</span><span class="s1">".'</span>
- <span class="o">%</span> <span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">exc</span><span class="o">.</span><span class="n">new_url</span><span class="p">)]</span>
- <span class="c1"># In case just a slash was appended we can be extra helpful</span>
- <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">base_url</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">==</span> <span class="n">exc</span><span class="o">.</span><span class="n">new_url</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'?'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]:</span>
- <span class="n">buf</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' The URL was defined with a trailing slash so '</span>
- <span class="s1">'Flask will automatically redirect to the URL '</span>
- <span class="s1">'with the trailing slash if it was accessed '</span>
- <span class="s1">'without one.'</span><span class="p">)</span>
- <span class="n">buf</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' Make sure to directly send your </span><span class="si">%s</span><span class="s1">-request to this URL '</span>
- <span class="s1">'since we can</span><span class="se">\'</span><span class="s1">t make browsers or HTTP clients redirect '</span>
- <span class="s1">'with form data reliably or without user interaction.'</span> <span class="o">%</span>
- <span class="n">request</span><span class="o">.</span><span class="n">method</span><span class="p">)</span>
- <span class="n">buf</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'</span><span class="se">\n\n</span><span class="s1">Note: this exception is only raised in debug mode'</span><span class="p">)</span>
- <span class="ne">AssertionError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buf</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">))</span></div>
- <div class="viewcode-block" id="attach_enctype_error_multidict"><a class="viewcode-back" href="../../flask/flask.html#flask.debughelpers.attach_enctype_error_multidict">[docs]</a><span class="k">def</span> <span class="nf">attach_enctype_error_multidict</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
- <span class="sd">"""Since Flask 0.8 we're monkeypatching the files object in case a</span>
- <span class="sd"> request is detected that does not use multipart form data but the files</span>
- <span class="sd"> object is accessed.</span>
- <span class="sd"> """</span>
- <span class="n">oldcls</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">files</span><span class="o">.</span><span class="n">__class__</span>
- <span class="k">class</span> <span class="nc">newcls</span><span class="p">(</span><span class="n">oldcls</span><span class="p">):</span>
- <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="k">return</span> <span class="n">oldcls</span><span class="o">.</span><span class="n">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
- <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
- <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">form</span><span class="p">:</span>
- <span class="k">raise</span>
- <span class="k">raise</span> <span class="n">DebugFilesKeyError</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
- <span class="n">newcls</span><span class="o">.</span><span class="n">__name__</span> <span class="o">=</span> <span class="n">oldcls</span><span class="o">.</span><span class="n">__name__</span>
- <span class="n">newcls</span><span class="o">.</span><span class="n">__module__</span> <span class="o">=</span> <span class="n">oldcls</span><span class="o">.</span><span class="n">__module__</span>
- <span class="n">request</span><span class="o">.</span><span class="n">files</span><span class="o">.</span><span class="n">__class__</span> <span class="o">=</span> <span class="n">newcls</span></div>
- <span class="k">def</span> <span class="nf">_dump_loader_info</span><span class="p">(</span><span class="n">loader</span><span class="p">):</span>
- <span class="k">yield</span> <span class="s1">'class: </span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">loader</span><span class="p">)</span><span class="o">.</span><span class="n">__module__</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">loader</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
- <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">loader</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
- <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">):</span>
- <span class="k">continue</span>
- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="nb">list</span><span class="p">)):</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">text_type</span><span class="p">))</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">value</span><span class="p">):</span>
- <span class="k">continue</span>
- <span class="k">yield</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">:'</span> <span class="o">%</span> <span class="n">key</span>
- <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
- <span class="k">yield</span> <span class="s1">' - </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">item</span>
- <span class="k">continue</span>
- <span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">text_type</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">bool</span><span class="p">)):</span>
- <span class="k">continue</span>
- <span class="k">yield</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
- <div class="viewcode-block" id="explain_template_loading_attempts"><a class="viewcode-back" href="../../flask/flask.html#flask.debughelpers.explain_template_loading_attempts">[docs]</a><span class="k">def</span> <span class="nf">explain_template_loading_attempts</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">template</span><span class="p">,</span> <span class="n">attempts</span><span class="p">):</span>
- <span class="sd">"""This should help developers understand what failed"""</span>
- <span class="n">info</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'Locating template "</span><span class="si">%s</span><span class="s1">":'</span> <span class="o">%</span> <span class="n">template</span><span class="p">]</span>
- <span class="n">total_found</span> <span class="o">=</span> <span class="mi">0</span>
- <span class="n">blueprint</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="n">reqctx</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">reqctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">blueprint</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">blueprint</span> <span class="o">=</span> <span class="n">reqctx</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">blueprint</span>
- <span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="p">(</span><span class="n">loader</span><span class="p">,</span> <span class="n">srcobj</span><span class="p">,</span> <span class="n">triple</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">attempts</span><span class="p">):</span>
- <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">srcobj</span><span class="p">,</span> <span class="n">Flask</span><span class="p">):</span>
- <span class="n">src_info</span> <span class="o">=</span> <span class="s1">'application "</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="n">srcobj</span><span class="o">.</span><span class="n">import_name</span>
- <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">srcobj</span><span class="p">,</span> <span class="n">Blueprint</span><span class="p">):</span>
- <span class="n">src_info</span> <span class="o">=</span> <span class="s1">'blueprint "</span><span class="si">%s</span><span class="s1">" (</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">srcobj</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
- <span class="n">srcobj</span><span class="o">.</span><span class="n">import_name</span><span class="p">)</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">src_info</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">srcobj</span><span class="p">)</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'</span><span class="si">% 5d</span><span class="s1">: trying loader of </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span>
- <span class="n">idx</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">src_info</span><span class="p">))</span>
- <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">_dump_loader_info</span><span class="p">(</span><span class="n">loader</span><span class="p">):</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">triple</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">detail</span> <span class="o">=</span> <span class="s1">'no match'</span>
- <span class="k">else</span><span class="p">:</span>
- <span class="n">detail</span> <span class="o">=</span> <span class="s1">'found (</span><span class="si">%r</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">triple</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">'<string>'</span><span class="p">)</span>
- <span class="n">total_found</span> <span class="o">+=</span> <span class="mi">1</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' -> </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">detail</span><span class="p">)</span>
- <span class="n">seems_fishy</span> <span class="o">=</span> <span class="kc">False</span>
- <span class="k">if</span> <span class="n">total_found</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'Error: the template could not be found.'</span><span class="p">)</span>
- <span class="n">seems_fishy</span> <span class="o">=</span> <span class="kc">True</span>
- <span class="k">elif</span> <span class="n">total_found</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'Warning: multiple loaders returned a match for the template.'</span><span class="p">)</span>
- <span class="n">seems_fishy</span> <span class="o">=</span> <span class="kc">True</span>
- <span class="k">if</span> <span class="n">blueprint</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">seems_fishy</span><span class="p">:</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' The template was looked up from an endpoint that '</span>
- <span class="s1">'belongs to the blueprint "</span><span class="si">%s</span><span class="s1">".'</span> <span class="o">%</span> <span class="n">blueprint</span><span class="p">)</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' Maybe you did not place a template in the right folder?'</span><span class="p">)</span>
- <span class="n">info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">' See http://flask.pocoo.org/docs/blueprints/#templates'</span><span class="p">)</span>
- <span class="n">app</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">info</span><span class="p">))</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>
|