signals.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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.signals &#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.signals</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.signals</span>
  37. <span class="sd"> ~~~~~~~~~~~~~</span>
  38. <span class="sd"> Implements signals based on blinker if available, otherwise</span>
  39. <span class="sd"> falls silently back to a noop.</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="n">signals_available</span> <span class="o">=</span> <span class="kc">False</span>
  44. <span class="k">try</span><span class="p">:</span>
  45. <span class="kn">from</span> <span class="nn">blinker</span> <span class="k">import</span> <span class="n">Namespace</span>
  46. <span class="n">signals_available</span> <span class="o">=</span> <span class="kc">True</span>
  47. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
  48. <div class="viewcode-block" id="Namespace"><a class="viewcode-back" href="../../flask/flask.html#flask.signals.Namespace">[docs]</a> <span class="k">class</span> <span class="nc">Namespace</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  49. <div class="viewcode-block" id="Namespace.signal"><a class="viewcode-back" href="../../flask/flask.html#flask.signals.Namespace.signal">[docs]</a> <span class="k">def</span> <span class="nf">signal</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">doc</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  50. <span class="k">return</span> <span class="n">_FakeSignal</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">doc</span><span class="p">)</span></div></div>
  51. <span class="k">class</span> <span class="nc">_FakeSignal</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  52. <span class="sd">&quot;&quot;&quot;If blinker is unavailable, create a fake class with the same</span>
  53. <span class="sd"> interface that allows sending of signals but will fail with an</span>
  54. <span class="sd"> error on anything else. Instead of doing anything on send, it</span>
  55. <span class="sd"> will just ignore the arguments and do nothing instead.</span>
  56. <span class="sd"> &quot;&quot;&quot;</span>
  57. <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">name</span><span class="p">,</span> <span class="n">doc</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  58. <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
  59. <span class="bp">self</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">doc</span>
  60. <span class="k">def</span> <span class="nf">_fail</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>
  61. <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;signalling support is unavailable &#39;</span>
  62. <span class="s1">&#39;because the blinker library is &#39;</span>
  63. <span class="s1">&#39;not installed.&#39;</span><span class="p">)</span>
  64. <span class="n">send</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">a</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">:</span> <span class="kc">None</span>
  65. <span class="n">connect</span> <span class="o">=</span> <span class="n">disconnect</span> <span class="o">=</span> <span class="n">has_receivers_for</span> <span class="o">=</span> <span class="n">receivers_for</span> <span class="o">=</span> \
  66. <span class="n">temporarily_connected_to</span> <span class="o">=</span> <span class="n">connected_to</span> <span class="o">=</span> <span class="n">_fail</span>
  67. <span class="k">del</span> <span class="n">_fail</span>
  68. <span class="c1"># The namespace for code signals. If you are not flask code, do</span>
  69. <span class="c1"># not put signals in here. Create your own namespace instead.</span>
  70. <span class="n">_signals</span> <span class="o">=</span> <span class="n">Namespace</span><span class="p">()</span>
  71. <span class="c1"># Core signals. For usage examples grep the source code or consult</span>
  72. <span class="c1"># the API documentation in docs/api.rst as well as docs/signals.rst</span>
  73. <span class="n">template_rendered</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;template-rendered&#39;</span><span class="p">)</span>
  74. <span class="n">before_render_template</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;before-render-template&#39;</span><span class="p">)</span>
  75. <span class="n">request_started</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;request-started&#39;</span><span class="p">)</span>
  76. <span class="n">request_finished</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;request-finished&#39;</span><span class="p">)</span>
  77. <span class="n">request_tearing_down</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;request-tearing-down&#39;</span><span class="p">)</span>
  78. <span class="n">got_request_exception</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;got-request-exception&#39;</span><span class="p">)</span>
  79. <span class="n">appcontext_tearing_down</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;appcontext-tearing-down&#39;</span><span class="p">)</span>
  80. <span class="n">appcontext_pushed</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;appcontext-pushed&#39;</span><span class="p">)</span>
  81. <span class="n">appcontext_popped</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;appcontext-popped&#39;</span><span class="p">)</span>
  82. <span class="n">message_flashed</span> <span class="o">=</span> <span class="n">_signals</span><span class="o">.</span><span class="n">signal</span><span class="p">(</span><span class="s1">&#39;message-flashed&#39;</span><span class="p">)</span>
  83. </pre></div>
  84. </div>
  85. </div>
  86. </div>
  87. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  88. <div class="sphinxsidebarwrapper"><div class="relations">
  89. <h3>Related Topics</h3>
  90. <ul>
  91. <li><a href="../../index.html">Documentation overview</a><ul>
  92. <li><a href="../index.html">Module code</a><ul>
  93. </ul></li>
  94. </ul></li>
  95. </ul>
  96. </div>
  97. <div id="searchbox" style="display: none" role="search">
  98. <h3>Quick search</h3>
  99. <form class="search" action="../../search.html" method="get">
  100. <div><input type="text" name="q" /></div>
  101. <div><input type="submit" value="Go" /></div>
  102. <input type="hidden" name="check_keywords" value="yes" />
  103. <input type="hidden" name="area" value="default" />
  104. </form>
  105. </div>
  106. <script type="text/javascript">$('#searchbox').show(0);</script>
  107. </div>
  108. </div>
  109. <div class="clearer"></div>
  110. </div>
  111. <div class="footer">
  112. &copy;2016, Author.
  113. |
  114. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  115. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  116. </div>
  117. </body>
  118. </html>