| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217 |
- <!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.testing — 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.testing</h1><div class="highlight"><pre>
- <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
- <span class="sd">"""</span>
- <span class="sd"> flask.testing</span>
- <span class="sd"> ~~~~~~~~~~~~~</span>
- <span class="sd"> Implements test support helpers. This module is lazily imported</span>
- <span class="sd"> and usually not used in production environments.</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">contextlib</span> <span class="k">import</span> <span class="n">contextmanager</span>
- <span class="kn">from</span> <span class="nn">werkzeug.test</span> <span class="k">import</span> <span class="n">Client</span><span class="p">,</span> <span class="n">EnvironBuilder</span>
- <span class="kn">from</span> <span class="nn">flask</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="kn">from</span> <span class="nn">werkzeug.urls</span> <span class="k">import</span> <span class="n">url_parse</span>
- <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
- <span class="kn">from</span> <span class="nn">urlparse</span> <span class="k">import</span> <span class="n">urlsplit</span> <span class="k">as</span> <span class="n">url_parse</span>
- <div class="viewcode-block" id="make_test_environ_builder"><a class="viewcode-back" href="../../flask/flask.html#flask.testing.make_test_environ_builder">[docs]</a><span class="k">def</span> <span class="nf">make_test_environ_builder</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">base_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
- <span class="sd">"""Creates a new test builder with some application defaults thrown in."""</span>
- <span class="n">http_host</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">'SERVER_NAME'</span><span class="p">)</span>
- <span class="n">app_root</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">'APPLICATION_ROOT'</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">base_url</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">url</span> <span class="o">=</span> <span class="n">url_parse</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
- <span class="n">base_url</span> <span class="o">=</span> <span class="s1">'http://</span><span class="si">%s</span><span class="s1">/'</span> <span class="o">%</span> <span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">or</span> <span class="n">http_host</span> <span class="ow">or</span> <span class="s1">'localhost'</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">app_root</span><span class="p">:</span>
- <span class="n">base_url</span> <span class="o">+=</span> <span class="n">app_root</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">netloc</span><span class="p">:</span>
- <span class="n">path</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">path</span>
- <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">query</span><span class="p">:</span>
- <span class="n">path</span> <span class="o">+=</span> <span class="s1">'?'</span> <span class="o">+</span> <span class="n">url</span><span class="o">.</span><span class="n">query</span>
- <span class="k">return</span> <span class="n">EnvironBuilder</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">base_url</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 class="viewcode-block" id="FlaskClient"><a class="viewcode-back" href="../../flask/flask.html#flask.testing.FlaskClient">[docs]</a><span class="k">class</span> <span class="nc">FlaskClient</span><span class="p">(</span><span class="n">Client</span><span class="p">):</span>
- <span class="sd">"""Works like a regular Werkzeug test client but has some knowledge about</span>
- <span class="sd"> how Flask works to defer the cleanup of the request context stack to the</span>
- <span class="sd"> end of a ``with`` body when used in a ``with`` statement. For general</span>
- <span class="sd"> information about how to use this class refer to</span>
- <span class="sd"> :class:`werkzeug.test.Client`.</span>
- <span class="sd"> Basic usage is outlined in the :ref:`testing` chapter.</span>
- <span class="sd"> """</span>
- <span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">False</span>
- <span class="nd">@contextmanager</span>
- <div class="viewcode-block" id="FlaskClient.session_transaction"><a class="viewcode-back" href="../../flask/flask.html#flask.testing.FlaskClient.session_transaction">[docs]</a> <span class="k">def</span> <span class="nf">session_transaction</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>
- <span class="sd">"""When used in combination with a ``with`` statement this opens a</span>
- <span class="sd"> session transaction. This can be used to modify the session that</span>
- <span class="sd"> the test client uses. Once the ``with`` block is left the session is</span>
- <span class="sd"> stored back.</span>
- <span class="sd"> ::</span>
- <span class="sd"> with client.session_transaction() as session:</span>
- <span class="sd"> session['value'] = 42</span>
- <span class="sd"> Internally this is implemented by going through a temporary test</span>
- <span class="sd"> request context and since session handling could depend on</span>
- <span class="sd"> request variables this function accepts the same arguments as</span>
- <span class="sd"> :meth:`~flask.Flask.test_request_context` which are directly</span>
- <span class="sd"> passed through.</span>
- <span class="sd"> """</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cookie_jar</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Session transactions only make sense '</span>
- <span class="s1">'with cookies enabled.'</span><span class="p">)</span>
- <span class="n">app</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">application</span>
- <span class="n">environ_overrides</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'environ_overrides'</span><span class="p">,</span> <span class="p">{})</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">cookie_jar</span><span class="o">.</span><span class="n">inject_wsgi</span><span class="p">(</span><span class="n">environ_overrides</span><span class="p">)</span>
- <span class="n">outer_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">with</span> <span class="n">app</span><span class="o">.</span><span class="n">test_request_context</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">as</span> <span class="n">c</span><span class="p">:</span>
- <span class="n">sess</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">open_session</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">request</span><span class="p">)</span>
- <span class="k">if</span> <span class="n">sess</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Session backend did not open a session. '</span>
- <span class="s1">'Check the configuration'</span><span class="p">)</span>
- <span class="c1"># Since we have to open a new request context for the session</span>
- <span class="c1"># handling we want to make sure that we hide out own context</span>
- <span class="c1"># from the caller. By pushing the original request context</span>
- <span class="c1"># (or None) on top of this and popping it we get exactly that</span>
- <span class="c1"># behavior. It's important to not use the push and pop</span>
- <span class="c1"># methods of the actual request context object since that would</span>
- <span class="c1"># mean that cleanup handlers are called</span>
- <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">push</span><span class="p">(</span><span class="n">outer_reqctx</span><span class="p">)</span>
- <span class="k">try</span><span class="p">:</span>
- <span class="k">yield</span> <span class="n">sess</span>
- <span class="k">finally</span><span class="p">:</span>
- <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
- <span class="n">resp</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">response_class</span><span class="p">()</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="n">app</span><span class="o">.</span><span class="n">session_interface</span><span class="o">.</span><span class="n">is_null_session</span><span class="p">(</span><span class="n">sess</span><span class="p">):</span>
- <span class="n">app</span><span class="o">.</span><span class="n">save_session</span><span class="p">(</span><span class="n">sess</span><span class="p">,</span> <span class="n">resp</span><span class="p">)</span>
- <span class="n">headers</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">get_wsgi_headers</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">environ</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">cookie_jar</span><span class="o">.</span><span class="n">extract_wsgi</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span></div>
- <div class="viewcode-block" id="FlaskClient.open"><a class="viewcode-back" href="../../flask/flask.html#flask.testing.FlaskClient.open">[docs]</a> <span class="k">def</span> <span class="nf">open</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>
- <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'environ_overrides'</span><span class="p">,</span> <span class="p">{})</span> \
- <span class="p">[</span><span class="s1">'flask._preserve_context'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span>
- <span class="n">as_tuple</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'as_tuple'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="n">buffered</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'buffered'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="n">follow_redirects</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'follow_redirects'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
- <span class="n">builder</span> <span class="o">=</span> <span class="n">make_test_environ_builder</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">application</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">Client</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">builder</span><span class="p">,</span>
- <span class="n">as_tuple</span><span class="o">=</span><span class="n">as_tuple</span><span class="p">,</span>
- <span class="n">buffered</span><span class="o">=</span><span class="n">buffered</span><span class="p">,</span>
- <span class="n">follow_redirects</span><span class="o">=</span><span class="n">follow_redirects</span><span class="p">)</span></div>
- <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span><span class="p">:</span>
- <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'Cannot nest client invocations'</span><span class="p">)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">True</span>
- <span class="k">return</span> <span class="bp">self</span>
- <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">tb</span><span class="p">):</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">False</span>
- <span class="c1"># on exit we want to clean up earlier. Normally the request context</span>
- <span class="c1"># stays preserved until the next request in the same thread comes</span>
- <span class="c1"># in. See RequestGlobals.push() for the general behavior.</span>
- <span class="n">top</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">top</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">top</span><span class="o">.</span><span class="n">preserved</span><span class="p">:</span>
- <span class="n">top</span><span class="o">.</span><span class="n">pop</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>
|