testing.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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.testing &#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.testing</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.testing</span>
  37. <span class="sd"> ~~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements test support helpers. This module is lazily imported</span>
  39. <span class="sd"> and usually not used in production environments.</span>
  40. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  41. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  42. <span class="sd">&quot;&quot;&quot;</span>
  43. <span class="kn">from</span> <span class="nn">contextlib</span> <span class="k">import</span> <span class="n">contextmanager</span>
  44. <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>
  45. <span class="kn">from</span> <span class="nn">flask</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span>
  46. <span class="k">try</span><span class="p">:</span>
  47. <span class="kn">from</span> <span class="nn">werkzeug.urls</span> <span class="k">import</span> <span class="n">url_parse</span>
  48. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
  49. <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>
  50. <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">&#39;/&#39;</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>
  51. <span class="sd">&quot;&quot;&quot;Creates a new test builder with some application defaults thrown in.&quot;&quot;&quot;</span>
  52. <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">&#39;SERVER_NAME&#39;</span><span class="p">)</span>
  53. <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">&#39;APPLICATION_ROOT&#39;</span><span class="p">)</span>
  54. <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>
  55. <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>
  56. <span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;http://</span><span class="si">%s</span><span class="s1">/&#39;</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">&#39;localhost&#39;</span><span class="p">)</span>
  57. <span class="k">if</span> <span class="n">app_root</span><span class="p">:</span>
  58. <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">&#39;/&#39;</span><span class="p">)</span>
  59. <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">netloc</span><span class="p">:</span>
  60. <span class="n">path</span> <span class="o">=</span> <span class="n">url</span><span class="o">.</span><span class="n">path</span>
  61. <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">query</span><span class="p">:</span>
  62. <span class="n">path</span> <span class="o">+=</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="n">url</span><span class="o">.</span><span class="n">query</span>
  63. <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>
  64. <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>
  65. <span class="sd">&quot;&quot;&quot;Works like a regular Werkzeug test client but has some knowledge about</span>
  66. <span class="sd"> how Flask works to defer the cleanup of the request context stack to the</span>
  67. <span class="sd"> end of a ``with`` body when used in a ``with`` statement. For general</span>
  68. <span class="sd"> information about how to use this class refer to</span>
  69. <span class="sd"> :class:`werkzeug.test.Client`.</span>
  70. <span class="sd"> Basic usage is outlined in the :ref:`testing` chapter.</span>
  71. <span class="sd"> &quot;&quot;&quot;</span>
  72. <span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">False</span>
  73. <span class="nd">@contextmanager</span>
  74. <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>
  75. <span class="sd">&quot;&quot;&quot;When used in combination with a ``with`` statement this opens a</span>
  76. <span class="sd"> session transaction. This can be used to modify the session that</span>
  77. <span class="sd"> the test client uses. Once the ``with`` block is left the session is</span>
  78. <span class="sd"> stored back.</span>
  79. <span class="sd"> ::</span>
  80. <span class="sd"> with client.session_transaction() as session:</span>
  81. <span class="sd"> session[&#39;value&#39;] = 42</span>
  82. <span class="sd"> Internally this is implemented by going through a temporary test</span>
  83. <span class="sd"> request context and since session handling could depend on</span>
  84. <span class="sd"> request variables this function accepts the same arguments as</span>
  85. <span class="sd"> :meth:`~flask.Flask.test_request_context` which are directly</span>
  86. <span class="sd"> passed through.</span>
  87. <span class="sd"> &quot;&quot;&quot;</span>
  88. <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>
  89. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Session transactions only make sense &#39;</span>
  90. <span class="s1">&#39;with cookies enabled.&#39;</span><span class="p">)</span>
  91. <span class="n">app</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">application</span>
  92. <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">&#39;environ_overrides&#39;</span><span class="p">,</span> <span class="p">{})</span>
  93. <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>
  94. <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>
  95. <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>
  96. <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>
  97. <span class="k">if</span> <span class="n">sess</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  98. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Session backend did not open a session. &#39;</span>
  99. <span class="s1">&#39;Check the configuration&#39;</span><span class="p">)</span>
  100. <span class="c1"># Since we have to open a new request context for the session</span>
  101. <span class="c1"># handling we want to make sure that we hide out own context</span>
  102. <span class="c1"># from the caller. By pushing the original request context</span>
  103. <span class="c1"># (or None) on top of this and popping it we get exactly that</span>
  104. <span class="c1"># behavior. It&#39;s important to not use the push and pop</span>
  105. <span class="c1"># methods of the actual request context object since that would</span>
  106. <span class="c1"># mean that cleanup handlers are called</span>
  107. <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>
  108. <span class="k">try</span><span class="p">:</span>
  109. <span class="k">yield</span> <span class="n">sess</span>
  110. <span class="k">finally</span><span class="p">:</span>
  111. <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
  112. <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>
  113. <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>
  114. <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>
  115. <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>
  116. <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>
  117. <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>
  118. <span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;environ_overrides&#39;</span><span class="p">,</span> <span class="p">{})</span> \
  119. <span class="p">[</span><span class="s1">&#39;flask._preserve_context&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span>
  120. <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">&#39;as_tuple&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
  121. <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">&#39;buffered&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
  122. <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">&#39;follow_redirects&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
  123. <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>
  124. <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>
  125. <span class="n">as_tuple</span><span class="o">=</span><span class="n">as_tuple</span><span class="p">,</span>
  126. <span class="n">buffered</span><span class="o">=</span><span class="n">buffered</span><span class="p">,</span>
  127. <span class="n">follow_redirects</span><span class="o">=</span><span class="n">follow_redirects</span><span class="p">)</span></div>
  128. <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  129. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span><span class="p">:</span>
  130. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Cannot nest client invocations&#39;</span><span class="p">)</span>
  131. <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">True</span>
  132. <span class="k">return</span> <span class="bp">self</span>
  133. <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>
  134. <span class="bp">self</span><span class="o">.</span><span class="n">preserve_context</span> <span class="o">=</span> <span class="kc">False</span>
  135. <span class="c1"># on exit we want to clean up earlier. Normally the request context</span>
  136. <span class="c1"># stays preserved until the next request in the same thread comes</span>
  137. <span class="c1"># in. See RequestGlobals.push() for the general behavior.</span>
  138. <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>
  139. <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>
  140. <span class="n">top</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span></div>
  141. </pre></div>
  142. </div>
  143. </div>
  144. </div>
  145. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  146. <div class="sphinxsidebarwrapper"><div class="relations">
  147. <h3>Related Topics</h3>
  148. <ul>
  149. <li><a href="../../index.html">Documentation overview</a><ul>
  150. <li><a href="../index.html">Module code</a><ul>
  151. </ul></li>
  152. </ul></li>
  153. </ul>
  154. </div>
  155. <div id="searchbox" style="display: none" role="search">
  156. <h3>Quick search</h3>
  157. <form class="search" action="../../search.html" method="get">
  158. <div><input type="text" name="q" /></div>
  159. <div><input type="submit" value="Go" /></div>
  160. <input type="hidden" name="check_keywords" value="yes" />
  161. <input type="hidden" name="area" value="default" />
  162. </form>
  163. </div>
  164. <script type="text/javascript">$('#searchbox').show(0);</script>
  165. </div>
  166. </div>
  167. <div class="clearer"></div>
  168. </div>
  169. <div class="footer">
  170. &copy;2016, Author.
  171. |
  172. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  173. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  174. </div>
  175. </body>
  176. </html>