ctx.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  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.ctx &#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.ctx</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.ctx</span>
  37. <span class="sd"> ~~~~~~~~~</span>
  38. <span class="sd"> Implements the objects required to keep the context.</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">import</span> <span class="nn">sys</span>
  43. <span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">update_wrapper</span>
  44. <span class="kn">from</span> <span class="nn">werkzeug.exceptions</span> <span class="k">import</span> <span class="n">HTTPException</span>
  45. <span class="kn">from</span> <span class="nn">.globals</span> <span class="k">import</span> <span class="n">_request_ctx_stack</span><span class="p">,</span> <span class="n">_app_ctx_stack</span>
  46. <span class="kn">from</span> <span class="nn">.signals</span> <span class="k">import</span> <span class="n">appcontext_pushed</span><span class="p">,</span> <span class="n">appcontext_popped</span>
  47. <span class="kn">from</span> <span class="nn">._compat</span> <span class="k">import</span> <span class="n">BROKEN_PYPY_CTXMGR_EXIT</span><span class="p">,</span> <span class="n">reraise</span>
  48. <span class="c1"># a singleton sentinel value for parameter defaults</span>
  49. <span class="n">_sentinel</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
  50. <span class="k">class</span> <span class="nc">_AppCtxGlobals</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  51. <span class="sd">&quot;&quot;&quot;A plain object.&quot;&quot;&quot;</span>
  52. <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  53. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
  54. <span class="k">def</span> <span class="nf">pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">_sentinel</span><span class="p">):</span>
  55. <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">_sentinel</span><span class="p">:</span>
  56. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
  57. <span class="k">else</span><span class="p">:</span>
  58. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
  59. <span class="k">def</span> <span class="nf">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  60. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
  61. <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
  62. <span class="k">return</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span>
  63. <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  64. <span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">)</span>
  65. <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  66. <span class="n">top</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  67. <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="p">:</span>
  68. <span class="k">return</span> <span class="s1">&#39;&lt;flask.g of </span><span class="si">%r</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="n">top</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">name</span>
  69. <span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  70. <div class="viewcode-block" id="after_this_request"><a class="viewcode-back" href="../../flask/flask.html#flask.app.after_this_request">[docs]</a><span class="k">def</span> <span class="nf">after_this_request</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  71. <span class="sd">&quot;&quot;&quot;Executes a function after this request. This is useful to modify</span>
  72. <span class="sd"> response objects. The function is passed the response object and has</span>
  73. <span class="sd"> to return the same or a new one.</span>
  74. <span class="sd"> Example::</span>
  75. <span class="sd"> @app.route(&#39;/&#39;)</span>
  76. <span class="sd"> def index():</span>
  77. <span class="sd"> @after_this_request</span>
  78. <span class="sd"> def add_header(response):</span>
  79. <span class="sd"> response.headers[&#39;X-Foo&#39;] = &#39;Parachute&#39;</span>
  80. <span class="sd"> return response</span>
  81. <span class="sd"> return &#39;Hello World!&#39;</span>
  82. <span class="sd"> This is more useful if a function other than the view function wants to</span>
  83. <span class="sd"> modify a response. For instance think of a decorator that wants to add</span>
  84. <span class="sd"> some headers without converting the return value into a response object.</span>
  85. <span class="sd"> .. versionadded:: 0.9</span>
  86. <span class="sd"> &quot;&quot;&quot;</span>
  87. <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span><span class="o">.</span><span class="n">_after_request_functions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
  88. <span class="k">return</span> <span class="n">f</span></div>
  89. <div class="viewcode-block" id="copy_current_request_context"><a class="viewcode-back" href="../../flask/flask.html#flask.app.copy_current_request_context">[docs]</a><span class="k">def</span> <span class="nf">copy_current_request_context</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  90. <span class="sd">&quot;&quot;&quot;A helper function that decorates a function to retain the current</span>
  91. <span class="sd"> request context. This is useful when working with greenlets. The moment</span>
  92. <span class="sd"> the function is decorated a copy of the request context is created and</span>
  93. <span class="sd"> then pushed when the function is called.</span>
  94. <span class="sd"> Example::</span>
  95. <span class="sd"> import gevent</span>
  96. <span class="sd"> from flask import copy_current_request_context</span>
  97. <span class="sd"> @app.route(&#39;/&#39;)</span>
  98. <span class="sd"> def index():</span>
  99. <span class="sd"> @copy_current_request_context</span>
  100. <span class="sd"> def do_some_work():</span>
  101. <span class="sd"> # do some work here, it can access flask.request like you</span>
  102. <span class="sd"> # would otherwise in the view function.</span>
  103. <span class="sd"> ...</span>
  104. <span class="sd"> gevent.spawn(do_some_work)</span>
  105. <span class="sd"> return &#39;Regular response&#39;</span>
  106. <span class="sd"> .. versionadded:: 0.10</span>
  107. <span class="sd"> &quot;&quot;&quot;</span>
  108. <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>
  109. <span class="k">if</span> <span class="n">top</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  110. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;This decorator can only be used at local scopes &#39;</span>
  111. <span class="s1">&#39;when a request context is on the stack. For instance within &#39;</span>
  112. <span class="s1">&#39;view functions.&#39;</span><span class="p">)</span>
  113. <span class="n">reqctx</span> <span class="o">=</span> <span class="n">top</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
  114. <span class="k">def</span> <span class="nf">wrapper</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>
  115. <span class="k">with</span> <span class="n">reqctx</span><span class="p">:</span>
  116. <span class="k">return</span> <span class="n">f</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>
  117. <span class="k">return</span> <span class="n">update_wrapper</span><span class="p">(</span><span class="n">wrapper</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span></div>
  118. <div class="viewcode-block" id="has_request_context"><a class="viewcode-back" href="../../flask/flask.html#flask.app.has_request_context">[docs]</a><span class="k">def</span> <span class="nf">has_request_context</span><span class="p">():</span>
  119. <span class="sd">&quot;&quot;&quot;If you have code that wants to test if a request context is there or</span>
  120. <span class="sd"> not this function can be used. For instance, you may want to take advantage</span>
  121. <span class="sd"> of request information if the request object is available, but fail</span>
  122. <span class="sd"> silently if it is unavailable.</span>
  123. <span class="sd"> ::</span>
  124. <span class="sd"> class User(db.Model):</span>
  125. <span class="sd"> def __init__(self, username, remote_addr=None):</span>
  126. <span class="sd"> self.username = username</span>
  127. <span class="sd"> if remote_addr is None and has_request_context():</span>
  128. <span class="sd"> remote_addr = request.remote_addr</span>
  129. <span class="sd"> self.remote_addr = remote_addr</span>
  130. <span class="sd"> Alternatively you can also just test any of the context bound objects</span>
  131. <span class="sd"> (such as :class:`request` or :class:`g` for truthness)::</span>
  132. <span class="sd"> class User(db.Model):</span>
  133. <span class="sd"> def __init__(self, username, remote_addr=None):</span>
  134. <span class="sd"> self.username = username</span>
  135. <span class="sd"> if remote_addr is None and request:</span>
  136. <span class="sd"> remote_addr = request.remote_addr</span>
  137. <span class="sd"> self.remote_addr = remote_addr</span>
  138. <span class="sd"> .. versionadded:: 0.7</span>
  139. <span class="sd"> &quot;&quot;&quot;</span>
  140. <span class="k">return</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">top</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div>
  141. <div class="viewcode-block" id="has_app_context"><a class="viewcode-back" href="../../flask/flask.html#flask.app.has_app_context">[docs]</a><span class="k">def</span> <span class="nf">has_app_context</span><span class="p">():</span>
  142. <span class="sd">&quot;&quot;&quot;Works like :func:`has_request_context` but for the application</span>
  143. <span class="sd"> context. You can also just do a boolean check on the</span>
  144. <span class="sd"> :data:`current_app` object instead.</span>
  145. <span class="sd"> .. versionadded:: 0.9</span>
  146. <span class="sd"> &quot;&quot;&quot;</span>
  147. <span class="k">return</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div>
  148. <div class="viewcode-block" id="AppContext"><a class="viewcode-back" href="../../flask/flask.html#flask.app.AppContext">[docs]</a><span class="k">class</span> <span class="nc">AppContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  149. <span class="sd">&quot;&quot;&quot;The application context binds an application object implicitly</span>
  150. <span class="sd"> to the current thread or greenlet, similar to how the</span>
  151. <span class="sd"> :class:`RequestContext` binds request information. The application</span>
  152. <span class="sd"> context is also implicitly created if a request context is created</span>
  153. <span class="sd"> but the application is not on top of the individual application</span>
  154. <span class="sd"> context.</span>
  155. <span class="sd"> &quot;&quot;&quot;</span>
  156. <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">app</span><span class="p">):</span>
  157. <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
  158. <span class="bp">self</span><span class="o">.</span><span class="n">url_adapter</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">create_url_adapter</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
  159. <span class="bp">self</span><span class="o">.</span><span class="n">g</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">app_ctx_globals_class</span><span class="p">()</span>
  160. <span class="c1"># Like request context, app contexts can be pushed multiple times</span>
  161. <span class="c1"># but there a basic &quot;refcount&quot; is enough to track them.</span>
  162. <span class="bp">self</span><span class="o">.</span><span class="n">_refcnt</span> <span class="o">=</span> <span class="mi">0</span>
  163. <div class="viewcode-block" id="AppContext.push"><a class="viewcode-back" href="../../flask/flask.html#flask.app.AppContext.push">[docs]</a> <span class="k">def</span> <span class="nf">push</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  164. <span class="sd">&quot;&quot;&quot;Binds the app context to the current context.&quot;&quot;&quot;</span>
  165. <span class="bp">self</span><span class="o">.</span><span class="n">_refcnt</span> <span class="o">+=</span> <span class="mi">1</span>
  166. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">sys</span><span class="p">,</span> <span class="s1">&#39;exc_clear&#39;</span><span class="p">):</span>
  167. <span class="n">sys</span><span class="o">.</span><span class="n">exc_clear</span><span class="p">()</span>
  168. <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">push</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  169. <span class="n">appcontext_pushed</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span></div>
  170. <div class="viewcode-block" id="AppContext.pop"><a class="viewcode-back" href="../../flask/flask.html#flask.app.AppContext.pop">[docs]</a> <span class="k">def</span> <span class="nf">pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc</span><span class="o">=</span><span class="n">_sentinel</span><span class="p">):</span>
  171. <span class="sd">&quot;&quot;&quot;Pops the app context.&quot;&quot;&quot;</span>
  172. <span class="k">try</span><span class="p">:</span>
  173. <span class="bp">self</span><span class="o">.</span><span class="n">_refcnt</span> <span class="o">-=</span> <span class="mi">1</span>
  174. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_refcnt</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
  175. <span class="k">if</span> <span class="n">exc</span> <span class="ow">is</span> <span class="n">_sentinel</span><span class="p">:</span>
  176. <span class="n">exc</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
  177. <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">do_teardown_appcontext</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
  178. <span class="k">finally</span><span class="p">:</span>
  179. <span class="n">rv</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
  180. <span class="k">assert</span> <span class="n">rv</span> <span class="ow">is</span> <span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;Popped wrong app context. (</span><span class="si">%r</span><span class="s1"> instead of </span><span class="si">%r</span><span class="s1">)&#39;</span> \
  181. <span class="o">%</span> <span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
  182. <span class="n">appcontext_popped</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span></div>
  183. <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  184. <span class="bp">self</span><span class="o">.</span><span class="n">push</span><span class="p">()</span>
  185. <span class="k">return</span> <span class="bp">self</span>
  186. <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>
  187. <span class="bp">self</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">exc_value</span><span class="p">)</span>
  188. <span class="k">if</span> <span class="n">BROKEN_PYPY_CTXMGR_EXIT</span> <span class="ow">and</span> <span class="n">exc_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  189. <span class="n">reraise</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></div>
  190. <div class="viewcode-block" id="RequestContext"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext">[docs]</a><span class="k">class</span> <span class="nc">RequestContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  191. <span class="sd">&quot;&quot;&quot;The request context contains all request relevant information. It is</span>
  192. <span class="sd"> created at the beginning of the request and pushed to the</span>
  193. <span class="sd"> `_request_ctx_stack` and removed at the end of it. It will create the</span>
  194. <span class="sd"> URL adapter and request object for the WSGI environment provided.</span>
  195. <span class="sd"> Do not attempt to use this class directly, instead use</span>
  196. <span class="sd"> :meth:`~flask.Flask.test_request_context` and</span>
  197. <span class="sd"> :meth:`~flask.Flask.request_context` to create this object.</span>
  198. <span class="sd"> When the request context is popped, it will evaluate all the</span>
  199. <span class="sd"> functions registered on the application for teardown execution</span>
  200. <span class="sd"> (:meth:`~flask.Flask.teardown_request`).</span>
  201. <span class="sd"> The request context is automatically popped at the end of the request</span>
  202. <span class="sd"> for you. In debug mode the request context is kept around if</span>
  203. <span class="sd"> exceptions happen so that interactive debuggers have a chance to</span>
  204. <span class="sd"> introspect the data. With 0.4 this can also be forced for requests</span>
  205. <span class="sd"> that did not fail and outside of ``DEBUG`` mode. By setting</span>
  206. <span class="sd"> ``&#39;flask._preserve_context&#39;`` to ``True`` on the WSGI environment the</span>
  207. <span class="sd"> context will not pop itself at the end of the request. This is used by</span>
  208. <span class="sd"> the :meth:`~flask.Flask.test_client` for example to implement the</span>
  209. <span class="sd"> deferred cleanup functionality.</span>
  210. <span class="sd"> You might find this helpful for unittests where you need the</span>
  211. <span class="sd"> information from the context local around for a little longer. Make</span>
  212. <span class="sd"> sure to properly :meth:`~werkzeug.LocalStack.pop` the stack yourself in</span>
  213. <span class="sd"> that situation, otherwise your unittests will leak memory.</span>
  214. <span class="sd"> &quot;&quot;&quot;</span>
  215. <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">app</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">request</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  216. <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
  217. <span class="k">if</span> <span class="n">request</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  218. <span class="n">request</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">request_class</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
  219. <span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span>
  220. <span class="bp">self</span><span class="o">.</span><span class="n">url_adapter</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">create_url_adapter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">)</span>
  221. <span class="bp">self</span><span class="o">.</span><span class="n">flashes</span> <span class="o">=</span> <span class="kc">None</span>
  222. <span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="kc">None</span>
  223. <span class="c1"># Request contexts can be pushed multiple times and interleaved with</span>
  224. <span class="c1"># other request contexts. Now only if the last level is popped we</span>
  225. <span class="c1"># get rid of them. Additionally if an application context is missing</span>
  226. <span class="c1"># one is created implicitly so for each level we add this information</span>
  227. <span class="bp">self</span><span class="o">.</span><span class="n">_implicit_app_ctx_stack</span> <span class="o">=</span> <span class="p">[]</span>
  228. <span class="c1"># indicator if the context was preserved. Next time another context</span>
  229. <span class="c1"># is pushed the preserved context is popped.</span>
  230. <span class="bp">self</span><span class="o">.</span><span class="n">preserved</span> <span class="o">=</span> <span class="kc">False</span>
  231. <span class="c1"># remembers the exception for pop if there is one in case the context</span>
  232. <span class="c1"># preservation kicks in.</span>
  233. <span class="bp">self</span><span class="o">.</span><span class="n">_preserved_exc</span> <span class="o">=</span> <span class="kc">None</span>
  234. <span class="c1"># Functions that should be executed after the request on the response</span>
  235. <span class="c1"># object. These will be called before the regular &quot;after_request&quot;</span>
  236. <span class="c1"># functions.</span>
  237. <span class="bp">self</span><span class="o">.</span><span class="n">_after_request_functions</span> <span class="o">=</span> <span class="p">[]</span>
  238. <span class="bp">self</span><span class="o">.</span><span class="n">match_request</span><span class="p">()</span>
  239. <span class="k">def</span> <span class="nf">_get_g</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  240. <span class="k">return</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span><span class="o">.</span><span class="n">g</span>
  241. <span class="k">def</span> <span class="nf">_set_g</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
  242. <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span><span class="o">.</span><span class="n">g</span> <span class="o">=</span> <span class="n">value</span>
  243. <span class="n">g</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_g</span><span class="p">,</span> <span class="n">_set_g</span><span class="p">)</span>
  244. <span class="k">del</span> <span class="n">_get_g</span><span class="p">,</span> <span class="n">_set_g</span>
  245. <div class="viewcode-block" id="RequestContext.copy"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  246. <span class="sd">&quot;&quot;&quot;Creates a copy of this request context with the same request object.</span>
  247. <span class="sd"> This can be used to move a request context to a different greenlet.</span>
  248. <span class="sd"> Because the actual request object is the same this cannot be used to</span>
  249. <span class="sd"> move a request context to a different thread unless access to the</span>
  250. <span class="sd"> request object is locked.</span>
  251. <span class="sd"> .. versionadded:: 0.10</span>
  252. <span class="sd"> &quot;&quot;&quot;</span>
  253. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span>
  254. <span class="n">environ</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
  255. <span class="n">request</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span>
  256. <span class="p">)</span></div>
  257. <div class="viewcode-block" id="RequestContext.match_request"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext.match_request">[docs]</a> <span class="k">def</span> <span class="nf">match_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  258. <span class="sd">&quot;&quot;&quot;Can be overridden by a subclass to hook into the matching</span>
  259. <span class="sd"> of the request.</span>
  260. <span class="sd"> &quot;&quot;&quot;</span>
  261. <span class="k">try</span><span class="p">:</span>
  262. <span class="n">url_rule</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">view_args</span> <span class="o">=</span> \
  263. <span class="bp">self</span><span class="o">.</span><span class="n">url_adapter</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">return_rule</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
  264. <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url_rule</span> <span class="o">=</span> <span class="n">url_rule</span>
  265. <span class="k">except</span> <span class="n">HTTPException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
  266. <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">routing_exception</span> <span class="o">=</span> <span class="n">e</span></div>
  267. <div class="viewcode-block" id="RequestContext.push"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext.push">[docs]</a> <span class="k">def</span> <span class="nf">push</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  268. <span class="sd">&quot;&quot;&quot;Binds the request context to the current context.&quot;&quot;&quot;</span>
  269. <span class="c1"># If an exception occurs in debug mode or if context preservation is</span>
  270. <span class="c1"># activated under exception situations exactly one context stays</span>
  271. <span class="c1"># on the stack. The rationale is that you want to access that</span>
  272. <span class="c1"># information under debug situations. However if someone forgets to</span>
  273. <span class="c1"># pop that context again we want to make sure that on the next push</span>
  274. <span class="c1"># it&#39;s invalidated, otherwise we run at risk that something leaks</span>
  275. <span class="c1"># memory. This is usually only a problem in test suite since this</span>
  276. <span class="c1"># functionality is not active in production environments.</span>
  277. <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>
  278. <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>
  279. <span class="n">top</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">top</span><span class="o">.</span><span class="n">_preserved_exc</span><span class="p">)</span>
  280. <span class="c1"># Before we push the request context we have to ensure that there</span>
  281. <span class="c1"># is an application context.</span>
  282. <span class="n">app_ctx</span> <span class="o">=</span> <span class="n">_app_ctx_stack</span><span class="o">.</span><span class="n">top</span>
  283. <span class="k">if</span> <span class="n">app_ctx</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">app_ctx</span><span class="o">.</span><span class="n">app</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">:</span>
  284. <span class="n">app_ctx</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">app_context</span><span class="p">()</span>
  285. <span class="n">app_ctx</span><span class="o">.</span><span class="n">push</span><span class="p">()</span>
  286. <span class="bp">self</span><span class="o">.</span><span class="n">_implicit_app_ctx_stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">app_ctx</span><span class="p">)</span>
  287. <span class="k">else</span><span class="p">:</span>
  288. <span class="bp">self</span><span class="o">.</span><span class="n">_implicit_app_ctx_stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
  289. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">sys</span><span class="p">,</span> <span class="s1">&#39;exc_clear&#39;</span><span class="p">):</span>
  290. <span class="n">sys</span><span class="o">.</span><span class="n">exc_clear</span><span class="p">()</span>
  291. <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">push</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
  292. <span class="c1"># Open the session at the moment that the request context is</span>
  293. <span class="c1"># available. This allows a custom open_session method to use the</span>
  294. <span class="c1"># request context (e.g. code that access database information</span>
  295. <span class="c1"># stored on `g` instead of the appcontext).</span>
  296. <span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</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="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">)</span>
  297. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  298. <span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">make_null_session</span><span class="p">()</span></div>
  299. <div class="viewcode-block" id="RequestContext.pop"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext.pop">[docs]</a> <span class="k">def</span> <span class="nf">pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc</span><span class="o">=</span><span class="n">_sentinel</span><span class="p">):</span>
  300. <span class="sd">&quot;&quot;&quot;Pops the request context and unbinds it by doing that. This will</span>
  301. <span class="sd"> also trigger the execution of functions registered by the</span>
  302. <span class="sd"> :meth:`~flask.Flask.teardown_request` decorator.</span>
  303. <span class="sd"> .. versionchanged:: 0.9</span>
  304. <span class="sd"> Added the `exc` argument.</span>
  305. <span class="sd"> &quot;&quot;&quot;</span>
  306. <span class="n">app_ctx</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_implicit_app_ctx_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
  307. <span class="k">try</span><span class="p">:</span>
  308. <span class="n">clear_request</span> <span class="o">=</span> <span class="kc">False</span>
  309. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_implicit_app_ctx_stack</span><span class="p">:</span>
  310. <span class="bp">self</span><span class="o">.</span><span class="n">preserved</span> <span class="o">=</span> <span class="kc">False</span>
  311. <span class="bp">self</span><span class="o">.</span><span class="n">_preserved_exc</span> <span class="o">=</span> <span class="kc">None</span>
  312. <span class="k">if</span> <span class="n">exc</span> <span class="ow">is</span> <span class="n">_sentinel</span><span class="p">:</span>
  313. <span class="n">exc</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
  314. <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">do_teardown_request</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
  315. <span class="c1"># If this interpreter supports clearing the exception information</span>
  316. <span class="c1"># we do that now. This will only go into effect on Python 2.x,</span>
  317. <span class="c1"># on 3.x it disappears automatically at the end of the exception</span>
  318. <span class="c1"># stack.</span>
  319. <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">sys</span><span class="p">,</span> <span class="s1">&#39;exc_clear&#39;</span><span class="p">):</span>
  320. <span class="n">sys</span><span class="o">.</span><span class="n">exc_clear</span><span class="p">()</span>
  321. <span class="n">request_close</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="s1">&#39;close&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
  322. <span class="k">if</span> <span class="n">request_close</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  323. <span class="n">request_close</span><span class="p">()</span>
  324. <span class="n">clear_request</span> <span class="o">=</span> <span class="kc">True</span>
  325. <span class="k">finally</span><span class="p">:</span>
  326. <span class="n">rv</span> <span class="o">=</span> <span class="n">_request_ctx_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
  327. <span class="c1"># get rid of circular dependencies at the end of the request</span>
  328. <span class="c1"># so that we don&#39;t require the GC to be active.</span>
  329. <span class="k">if</span> <span class="n">clear_request</span><span class="p">:</span>
  330. <span class="n">rv</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="s1">&#39;werkzeug.request&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
  331. <span class="c1"># Get rid of the app as well if necessary.</span>
  332. <span class="k">if</span> <span class="n">app_ctx</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  333. <span class="n">app_ctx</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
  334. <span class="k">assert</span> <span class="n">rv</span> <span class="ow">is</span> <span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;Popped wrong request context. &#39;</span> \
  335. <span class="s1">&#39;(</span><span class="si">%r</span><span class="s1"> instead of </span><span class="si">%r</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">rv</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
  336. <div class="viewcode-block" id="RequestContext.auto_pop"><a class="viewcode-back" href="../../flask/flask.html#flask.app.RequestContext.auto_pop">[docs]</a> <span class="k">def</span> <span class="nf">auto_pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc</span><span class="p">):</span>
  337. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;flask._preserve_context&#39;</span><span class="p">)</span> <span class="ow">or</span> \
  338. <span class="p">(</span><span class="n">exc</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">preserve_context_on_exception</span><span class="p">):</span>
  339. <span class="bp">self</span><span class="o">.</span><span class="n">preserved</span> <span class="o">=</span> <span class="kc">True</span>
  340. <span class="bp">self</span><span class="o">.</span><span class="n">_preserved_exc</span> <span class="o">=</span> <span class="n">exc</span>
  341. <span class="k">else</span><span class="p">:</span>
  342. <span class="bp">self</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span></div>
  343. <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  344. <span class="bp">self</span><span class="o">.</span><span class="n">push</span><span class="p">()</span>
  345. <span class="k">return</span> <span class="bp">self</span>
  346. <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>
  347. <span class="c1"># do not pop the request stack if we are in debug mode and an</span>
  348. <span class="c1"># exception happened. This will allow the debugger to still</span>
  349. <span class="c1"># access the request object in the interactive shell. Furthermore</span>
  350. <span class="c1"># the context can be force kept alive for the test client.</span>
  351. <span class="c1"># See flask.testing for how this works.</span>
  352. <span class="bp">self</span><span class="o">.</span><span class="n">auto_pop</span><span class="p">(</span><span class="n">exc_value</span><span class="p">)</span>
  353. <span class="k">if</span> <span class="n">BROKEN_PYPY_CTXMGR_EXIT</span> <span class="ow">and</span> <span class="n">exc_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  354. <span class="n">reraise</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>
  355. <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  356. <span class="k">return</span> <span class="s1">&#39;&lt;</span><span class="si">%s</span><span class="s1"> </span><span class="se">\&#39;</span><span class="si">%s</span><span class="se">\&#39;</span><span class="s1"> [</span><span class="si">%s</span><span class="s1">] of </span><span class="si">%s</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="p">(</span>
  357. <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
  358. <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">url</span><span class="p">,</span>
  359. <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">method</span><span class="p">,</span>
  360. <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
  361. <span class="p">)</span></div>
  362. </pre></div>
  363. </div>
  364. </div>
  365. </div>
  366. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  367. <div class="sphinxsidebarwrapper"><div class="relations">
  368. <h3>Related Topics</h3>
  369. <ul>
  370. <li><a href="../../index.html">Documentation overview</a><ul>
  371. <li><a href="../index.html">Module code</a><ul>
  372. </ul></li>
  373. </ul></li>
  374. </ul>
  375. </div>
  376. <div id="searchbox" style="display: none" role="search">
  377. <h3>Quick search</h3>
  378. <form class="search" action="../../search.html" method="get">
  379. <div><input type="text" name="q" /></div>
  380. <div><input type="submit" value="Go" /></div>
  381. <input type="hidden" name="check_keywords" value="yes" />
  382. <input type="hidden" name="area" value="default" />
  383. </form>
  384. </div>
  385. <script type="text/javascript">$('#searchbox').show(0);</script>
  386. </div>
  387. </div>
  388. <div class="clearer"></div>
  389. </div>
  390. <div class="footer">
  391. &copy;2016, Author.
  392. |
  393. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  394. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  395. </div>
  396. </body>
  397. </html>