logging_pool.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>grpc.framework.foundation.logging_pool &mdash; grpcio 1.2.0 documentation</title>
  8. <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
  9. <link rel="index" title="Index"
  10. href="../../../../genindex.html"/>
  11. <link rel="search" title="Search" href="../../../../search.html"/>
  12. <link rel="top" title="grpcio 1.2.0 documentation" href="../../../../index.html"/>
  13. <link rel="up" title="grpc" href="../../../grpc.html"/>
  14. <script src="../../../../_static/js/modernizr.min.js"></script>
  15. </head>
  16. <body class="wy-body-for-nav" role="document">
  17. <div class="wy-grid-for-nav">
  18. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  19. <div class="wy-side-scroll">
  20. <div class="wy-side-nav-search">
  21. <a href="../../../../index.html" class="icon icon-home"> grpcio
  22. </a>
  23. <div class="version">
  24. 1.2.0
  25. </div>
  26. <div role="search">
  27. <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
  28. <input type="text" name="q" placeholder="Search docs" />
  29. <input type="hidden" name="check_keywords" value="yes" />
  30. <input type="hidden" name="area" value="default" />
  31. </form>
  32. </div>
  33. </div>
  34. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  35. <p class="caption"><span class="caption-text">Contents:</span></p>
  36. <ul>
  37. <li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">grpc package</a></li>
  38. <li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html#glossary">Glossary</a></li>
  39. </ul>
  40. </div>
  41. </div>
  42. </nav>
  43. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  44. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  45. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  46. <a href="../../../../index.html">grpcio</a>
  47. </nav>
  48. <div class="wy-nav-content">
  49. <div class="rst-content">
  50. <div role="navigation" aria-label="breadcrumbs navigation">
  51. <ul class="wy-breadcrumbs">
  52. <li><a href="../../../../index.html">Docs</a> &raquo;</li>
  53. <li><a href="../../../index.html">Module code</a> &raquo;</li>
  54. <li><a href="../../../grpc.html">grpc</a> &raquo;</li>
  55. <li>grpc.framework.foundation.logging_pool</li>
  56. <li class="wy-breadcrumbs-aside">
  57. </li>
  58. </ul>
  59. <hr/>
  60. </div>
  61. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  62. <div itemprop="articleBody">
  63. <h1>Source code for grpc.framework.foundation.logging_pool</h1><div class="highlight"><pre>
  64. <span></span><span class="c1"># Copyright 2015, Google Inc.</span>
  65. <span class="c1"># All rights reserved.</span>
  66. <span class="c1">#</span>
  67. <span class="c1"># Redistribution and use in source and binary forms, with or without</span>
  68. <span class="c1"># modification, are permitted provided that the following conditions are</span>
  69. <span class="c1"># met:</span>
  70. <span class="c1">#</span>
  71. <span class="c1"># * Redistributions of source code must retain the above copyright</span>
  72. <span class="c1"># notice, this list of conditions and the following disclaimer.</span>
  73. <span class="c1"># * Redistributions in binary form must reproduce the above</span>
  74. <span class="c1"># copyright notice, this list of conditions and the following disclaimer</span>
  75. <span class="c1"># in the documentation and/or other materials provided with the</span>
  76. <span class="c1"># distribution.</span>
  77. <span class="c1"># * Neither the name of Google Inc. nor the names of its</span>
  78. <span class="c1"># contributors may be used to endorse or promote products derived from</span>
  79. <span class="c1"># this software without specific prior written permission.</span>
  80. <span class="c1">#</span>
  81. <span class="c1"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
  82. <span class="c1"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
  83. <span class="c1"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
  84. <span class="c1"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
  85. <span class="c1"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
  86. <span class="c1"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
  87. <span class="c1"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
  88. <span class="c1"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
  89. <span class="c1"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
  90. <span class="c1"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
  91. <span class="c1"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  92. <span class="sd">&quot;&quot;&quot;A thread pool that logs exceptions raised by tasks executed within it.&quot;&quot;&quot;</span>
  93. <span class="kn">import</span> <span class="nn">logging</span>
  94. <span class="kn">from</span> <span class="nn">concurrent</span> <span class="k">import</span> <span class="n">futures</span>
  95. <span class="k">def</span> <span class="nf">_wrap</span><span class="p">(</span><span class="n">behavior</span><span class="p">):</span>
  96. <span class="sd">&quot;&quot;&quot;Wraps an arbitrary callable behavior in exception-logging.&quot;&quot;&quot;</span>
  97. <span class="k">def</span> <span class="nf">_wrapping</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>
  98. <span class="k">try</span><span class="p">:</span>
  99. <span class="k">return</span> <span class="n">behavior</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>
  100. <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
  101. <span class="n">logging</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span>
  102. <span class="s1">&#39;Unexpected exception from </span><span class="si">%s</span><span class="s1"> executed in logging pool!&#39;</span><span class="p">,</span>
  103. <span class="n">behavior</span><span class="p">)</span>
  104. <span class="k">raise</span>
  105. <span class="k">return</span> <span class="n">_wrapping</span>
  106. <span class="k">class</span> <span class="nc">_LoggingPool</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  107. <span class="sd">&quot;&quot;&quot;An exception-logging futures.ThreadPoolExecutor-compatible thread pool.&quot;&quot;&quot;</span>
  108. <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">backing_pool</span><span class="p">):</span>
  109. <span class="bp">self</span><span class="o">.</span><span class="n">_backing_pool</span> <span class="o">=</span> <span class="n">backing_pool</span>
  110. <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  111. <span class="k">return</span> <span class="bp">self</span>
  112. <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_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
  113. <span class="bp">self</span><span class="o">.</span><span class="n">_backing_pool</span><span class="o">.</span><span class="n">shutdown</span><span class="p">(</span><span class="n">wait</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
  114. <span class="k">def</span> <span class="nf">submit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fn</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">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_backing_pool</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span><span class="n">_wrap</span><span class="p">(</span><span class="n">fn</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>
  116. <span class="k">def</span> <span class="nf">map</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">iterables</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="bp">self</span><span class="o">.</span><span class="n">_backing_pool</span><span class="o">.</span><span class="n">map</span><span class="p">(</span>
  118. <span class="n">_wrap</span><span class="p">(</span><span class="n">func</span><span class="p">),</span> <span class="o">*</span><span class="n">iterables</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;timeout&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
  119. <span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wait</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  120. <span class="bp">self</span><span class="o">.</span><span class="n">_backing_pool</span><span class="o">.</span><span class="n">shutdown</span><span class="p">(</span><span class="n">wait</span><span class="o">=</span><span class="n">wait</span><span class="p">)</span>
  121. <div class="viewcode-block" id="pool"><a class="viewcode-back" href="../../../../grpc.framework.foundation.html#grpc.framework.foundation.logging_pool.pool">[docs]</a><span class="k">def</span> <span class="nf">pool</span><span class="p">(</span><span class="n">max_workers</span><span class="p">):</span>
  122. <span class="sd">&quot;&quot;&quot;Creates a thread pool that logs exceptions raised by the tasks within it.</span>
  123. <span class="sd"> Args:</span>
  124. <span class="sd"> max_workers: The maximum number of worker threads to allow the pool.</span>
  125. <span class="sd"> Returns:</span>
  126. <span class="sd"> A futures.ThreadPoolExecutor-compatible thread pool that logs exceptions</span>
  127. <span class="sd"> raised by the tasks executed within it.</span>
  128. <span class="sd"> &quot;&quot;&quot;</span>
  129. <span class="k">return</span> <span class="n">_LoggingPool</span><span class="p">(</span><span class="n">futures</span><span class="o">.</span><span class="n">ThreadPoolExecutor</span><span class="p">(</span><span class="n">max_workers</span><span class="p">))</span></div>
  130. </pre></div>
  131. </div>
  132. <div class="articleComments">
  133. </div>
  134. </div>
  135. <footer>
  136. <hr/>
  137. <div role="contentinfo">
  138. <p>
  139. &copy; Copyright 2016, The gRPC Authors.
  140. </p>
  141. </div>
  142. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  143. </footer>
  144. </div>
  145. </div>
  146. </section>
  147. </div>
  148. <script type="text/javascript">
  149. var DOCUMENTATION_OPTIONS = {
  150. URL_ROOT:'../../../../',
  151. VERSION:'1.2.0',
  152. COLLAPSE_INDEX:false,
  153. FILE_SUFFIX:'.html',
  154. HAS_SOURCE: true,
  155. SOURCELINK_SUFFIX: '.txt'
  156. };
  157. </script>
  158. <script type="text/javascript" src="../../../../_static/jquery.js"></script>
  159. <script type="text/javascript" src="../../../../_static/underscore.js"></script>
  160. <script type="text/javascript" src="../../../../_static/doctools.js"></script>
  161. <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
  162. <script type="text/javascript">
  163. jQuery(function () {
  164. SphinxRtdTheme.StickyNav.enable();
  165. });
  166. </script>
  167. </body>
  168. </html>