carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>grpc.framework.foundation.callable_util &mdash; grpcio 1.2.0 documentation</title>
  

    <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../../../../genindex.html"/>
        <link rel="search" title="Search" href="../../../../search.html"/>
    <link rel="top" title="grpcio 1.2.0 documentation" href="../../../../index.html"/>
        <link rel="up" title="grpc" href="../../../grpc.html"/> 

  
  <script src="../../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

            <a href="../../../../index.html" class="icon icon-home"> grpcio
          

          </a>

          
              <div class="version">
                1.2.0
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">grpc package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html#glossary">Glossary</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../../index.html">grpcio</a>
        
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../../index.html">Module code</a> &raquo;</li>
        
          <li><a href="../../../grpc.html">grpc</a> &raquo;</li>
        
      <li>grpc.framework.foundation.callable_util</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for grpc.framework.foundation.callable_util</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2015, Google Inc.</span>
<span class="c1"># All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># Redistribution and use in source and binary forms, with or without</span>
<span class="c1"># modification, are permitted provided that the following conditions are</span>
<span class="c1"># met:</span>
<span class="c1">#</span>
<span class="c1">#     * Redistributions of source code must retain the above copyright</span>
<span class="c1"># notice, this list of conditions and the following disclaimer.</span>
<span class="c1">#     * Redistributions in binary form must reproduce the above</span>
<span class="c1"># copyright notice, this list of conditions and the following disclaimer</span>
<span class="c1"># in the documentation and/or other materials provided with the</span>
<span class="c1"># distribution.</span>
<span class="c1">#     * Neither the name of Google Inc. nor the names of its</span>
<span class="c1"># contributors may be used to endorse or promote products derived from</span>
<span class="c1"># this software without specific prior written permission.</span>
<span class="c1">#</span>
<span class="c1"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<span class="c1"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<span class="c1"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
<span class="c1"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
<span class="c1"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
<span class="c1"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
<span class="c1"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
<span class="c1"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
<span class="c1"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<span class="c1"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<span class="c1"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<span class="sd">&quot;&quot;&quot;Utilities for working with callables.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">abc</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">enum</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">logging</span>

<span class="kn">import</span> <span class="nn">six</span>


<div class="viewcode-block" id="Outcome"><a class="viewcode-back" href="../../../../grpc.framework.foundation.html#grpc.framework.foundation.callable_util.Outcome">[docs]</a><span class="k">class</span> <span class="nc">Outcome</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;A sum type describing the outcome of some call.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    kind: One of Kind.RETURNED or Kind.RAISED respectively indicating that the</span>
<span class="sd">      call returned a value or raised an exception.</span>
<span class="sd">    return_value: The value returned by the call. Must be present if kind is</span>
<span class="sd">      Kind.RETURNED.</span>
<span class="sd">    exception: The exception raised by the call. Must be present if kind is</span>
<span class="sd">      Kind.RAISED.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
<div class="viewcode-block" id="Outcome.Kind"><a class="viewcode-back" href="../../../../grpc.framework.foundation.html#grpc.framework.foundation.callable_util.Outcome.Kind">[docs]</a>    <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Identifies the general kind of the outcome of some call.&quot;&quot;&quot;</span>

        <span class="n">RETURNED</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
        <span class="n">RAISED</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span></div></div>


<span class="k">class</span> <span class="nc">_EasyOutcome</span><span class="p">(</span>
        <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s1">&#39;_EasyOutcome&#39;</span><span class="p">,</span>
                               <span class="p">[</span><span class="s1">&#39;kind&#39;</span><span class="p">,</span> <span class="s1">&#39;return_value&#39;</span><span class="p">,</span> <span class="s1">&#39;exception&#39;</span><span class="p">]),</span> <span class="n">Outcome</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A trivial implementation of Outcome.&quot;&quot;&quot;</span>


<span class="k">def</span> <span class="nf">_call_logging_exceptions</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span> <span class="n">message</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">try</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">_EasyOutcome</span><span class="p">(</span><span class="n">Outcome</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">RETURNED</span><span class="p">,</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> <span class="kc">None</span><span class="p">)</span>
    <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>  <span class="c1"># pylint: disable=broad-except</span>
        <span class="n">logging</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">_EasyOutcome</span><span class="p">(</span><span class="n">Outcome</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">RAISED</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>


<div class="viewcode-block" id="with_exceptions_logged"><a class="viewcode-back" href="../../../../grpc.framework.foundation.html#grpc.framework.foundation.callable_util.with_exceptions_logged">[docs]</a><span class="k">def</span> <span class="nf">with_exceptions_logged</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Wraps a callable in a try-except that logs any exceptions it raises.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: Any callable.</span>
<span class="sd">    message: A string to log if the behavior raises an exception.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A callable that when executed invokes the given behavior. The returned</span>
<span class="sd">      callable takes the same arguments as the given behavior but returns a</span>
<span class="sd">      future.Outcome describing whether the given behavior returned a value or</span>
<span class="sd">      raised an exception.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">behavior</span><span class="p">)</span>
    <span class="k">def</span> <span class="nf">wrapped_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>
        <span class="k">return</span> <span class="n">_call_logging_exceptions</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

    <span class="k">return</span> <span class="n">wrapped_behavior</span></div>


<div class="viewcode-block" id="call_logging_exceptions"><a class="viewcode-back" href="../../../../grpc.framework.foundation.html#grpc.framework.foundation.callable_util.call_logging_exceptions">[docs]</a><span class="k">def</span> <span class="nf">call_logging_exceptions</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Calls a behavior in a try-except that logs any exceptions it raises.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: Any callable.</span>
<span class="sd">    message: A string to log if the behavior raises an exception.</span>
<span class="sd">    *args: Positional arguments to pass to the given behavior.</span>
<span class="sd">    **kwargs: Keyword arguments to pass to the given behavior.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An Outcome describing whether the given behavior returned a value or raised</span>
<span class="sd">      an exception.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">_call_logging_exceptions</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span> <span class="n">message</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>
</pre></div>

           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, The gRPC Authors.

    </p>
  </div>
  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>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../../../',
            VERSION:'1.2.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../../../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../../../_static/doctools.js"></script>

  
    <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>