carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590
							

<!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 &mdash; grpcio 1.6.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.6.0 documentation" href="../index.html"/>
        <link rel="up" title="Module code" href="index.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.6.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>grpc</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</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2015-2016 gRPC authors.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="sd">&quot;&quot;&quot;gRPC&#39;s Python API.&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">abc</span>
<span class="kn">import</span> <span class="nn">enum</span>
<span class="kn">import</span> <span class="nn">sys</span>

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

<span class="kn">from</span> <span class="nn">grpc._cython</span> <span class="k">import</span> <span class="n">cygrpc</span> <span class="k">as</span> <span class="n">_cygrpc</span>

<span class="c1">############################## Future Interface  ###############################</span>


<div class="viewcode-block" id="FutureTimeoutError"><a class="viewcode-back" href="../grpc.html#grpc.FutureTimeoutError">[docs]</a><span class="k">class</span> <span class="nc">FutureTimeoutError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Indicates that a method call on a Future timed out.&quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="FutureCancelledError"><a class="viewcode-back" href="../grpc.html#grpc.FutureCancelledError">[docs]</a><span class="k">class</span> <span class="nc">FutureCancelledError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Indicates that the computation underlying a Future was cancelled.&quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="Future"><a class="viewcode-back" href="../grpc.html#grpc.Future">[docs]</a><span class="k">class</span> <span class="nc">Future</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 representation of a computation in another control flow.</span>

<span class="sd">  Computations represented by a Future may be yet to be begun, may be ongoing,</span>
<span class="sd">  or may have already completed.</span>
<span class="sd">  &quot;&quot;&quot;</span>

<div class="viewcode-block" id="Future.cancel"><a class="viewcode-back" href="../grpc.html#grpc.Future.cancel">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Attempts to cancel the computation.</span>

<span class="sd">    This method does not block.</span>

<span class="sd">    Returns:</span>
<span class="sd">        bool:</span>
<span class="sd">        Returns True if the computation was canceled.</span>
<span class="sd">        Returns False under all other circumstances, for example:</span>
<span class="sd">        1. computation has begun and could not be canceled.</span>
<span class="sd">        2. computation has finished</span>
<span class="sd">        3. computation is scheduled for execution and it is impossible to</span>
<span class="sd">           determine its state without blocking.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.cancelled"><a class="viewcode-back" href="../grpc.html#grpc.Future.cancelled">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes whether the computation was cancelled.</span>

<span class="sd">    This method does not block.</span>

<span class="sd">    Returns:</span>
<span class="sd">        bool:</span>
<span class="sd">        Returns True if the computation was cancelled before its result became</span>
<span class="sd">        available.</span>
<span class="sd">        False under all other circumstances, for example:</span>
<span class="sd">        1. computation was not cancelled.</span>
<span class="sd">        2. computation&#39;s result is available.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.running"><a class="viewcode-back" href="../grpc.html#grpc.Future.running">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">running</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes whether the computation is taking place.</span>

<span class="sd">    This method does not block.</span>

<span class="sd">    Returns:</span>
<span class="sd">        bool:</span>
<span class="sd">        Returns True if the computation is scheduled for execution or currently</span>
<span class="sd">        executing.</span>
<span class="sd">        Returns False if the computation already executed or was cancelled.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.done"><a class="viewcode-back" href="../grpc.html#grpc.Future.done">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes whether the computation has taken place.</span>

<span class="sd">    This method does not block.</span>

<span class="sd">    Returns:</span>
<span class="sd">        bool:</span>
<span class="sd">        Returns True if the computation already executed or was cancelled.</span>
<span class="sd">        Returns False if the computation is scheduled for execution or currently</span>
<span class="sd">        executing.</span>
<span class="sd">        This is exactly opposite of the running() method&#39;s result.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.result"><a class="viewcode-back" href="../grpc.html#grpc.Future.result">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns the result of the computation or raises its exception.</span>

<span class="sd">    This method may return immediately or may block.</span>

<span class="sd">    Args:</span>
<span class="sd">      timeout: The length of time in seconds to wait for the computation to</span>
<span class="sd">        finish or be cancelled. If None, the call will block until the</span>
<span class="sd">        computations&#39;s termination.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The return value of the computation.</span>

<span class="sd">    Raises:</span>
<span class="sd">      FutureTimeoutError: If a timeout value is passed and the computation does</span>
<span class="sd">        not terminate within the allotted time.</span>
<span class="sd">      FutureCancelledError: If the computation was cancelled.</span>
<span class="sd">      Exception: If the computation raised an exception, this call will raise</span>
<span class="sd">        the same exception.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.exception"><a class="viewcode-back" href="../grpc.html#grpc.Future.exception">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Return the exception raised by the computation.</span>

<span class="sd">    This method may return immediately or may block.</span>

<span class="sd">    Args:</span>
<span class="sd">      timeout: The length of time in seconds to wait for the computation to</span>
<span class="sd">        terminate or be cancelled. If None, the call will block until the</span>
<span class="sd">        computations&#39;s termination.</span>

<span class="sd">    Returns:</span>
<span class="sd">        The exception raised by the computation, or None if the computation did</span>
<span class="sd">        not raise an exception.</span>

<span class="sd">    Raises:</span>
<span class="sd">      FutureTimeoutError: If a timeout value is passed and the computation does</span>
<span class="sd">        not terminate within the allotted time.</span>
<span class="sd">      FutureCancelledError: If the computation was cancelled.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.traceback"><a class="viewcode-back" href="../grpc.html#grpc.Future.traceback">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">traceback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Access the traceback of the exception raised by the computation.</span>

<span class="sd">    This method may return immediately or may block.</span>

<span class="sd">    Args:</span>
<span class="sd">      timeout: The length of time in seconds to wait for the computation to</span>
<span class="sd">        terminate or be cancelled. If None, the call will block until the</span>
<span class="sd">        computations&#39;s termination.</span>

<span class="sd">    Returns:</span>
<span class="sd">        The traceback of the exception raised by the computation, or None if the</span>
<span class="sd">        computation did not raise an exception.</span>

<span class="sd">    Raises:</span>
<span class="sd">      FutureTimeoutError: If a timeout value is passed and the computation does</span>
<span class="sd">        not terminate within the allotted time.</span>
<span class="sd">      FutureCancelledError: If the computation was cancelled.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Future.add_done_callback"><a class="viewcode-back" href="../grpc.html#grpc.Future.add_done_callback">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">add_done_callback</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="sd">&quot;&quot;&quot;Adds a function to be called at completion of the computation.</span>

<span class="sd">    The callback will be passed this Future object describing the outcome of</span>
<span class="sd">    the computation.</span>

<span class="sd">    If the computation has already completed, the callback will be called</span>
<span class="sd">    immediately.</span>

<span class="sd">    Args:</span>
<span class="sd">      fn: A callable taking this Future object as its single parameter.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">################################  gRPC Enums  ##################################</span>


<div class="viewcode-block" id="ChannelConnectivity"><a class="viewcode-back" href="../grpc.html#grpc.ChannelConnectivity">[docs]</a><span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
<span class="k">class</span> <span class="nc">ChannelConnectivity</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;Mirrors grpc_connectivity_state in the gRPC Core.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    IDLE: The channel is idle.</span>
<span class="sd">    CONNECTING: The channel is connecting.</span>
<span class="sd">    READY: The channel is ready to conduct RPCs.</span>
<span class="sd">    TRANSIENT_FAILURE: The channel has seen a failure from which it expects to</span>
<span class="sd">      recover.</span>
<span class="sd">    SHUTDOWN: The channel has seen a failure from which it cannot recover.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">IDLE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">idle</span><span class="p">,</span> <span class="s1">&#39;idle&#39;</span><span class="p">)</span>
    <span class="n">CONNECTING</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">connecting</span><span class="p">,</span> <span class="s1">&#39;connecting&#39;</span><span class="p">)</span>
    <span class="n">READY</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">ready</span><span class="p">,</span> <span class="s1">&#39;ready&#39;</span><span class="p">)</span>
    <span class="n">TRANSIENT_FAILURE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">transient_failure</span><span class="p">,</span>
                         <span class="s1">&#39;transient failure&#39;</span><span class="p">)</span>
    <span class="n">SHUTDOWN</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">shutdown</span><span class="p">,</span> <span class="s1">&#39;shutdown&#39;</span><span class="p">)</span></div>


<div class="viewcode-block" id="StatusCode"><a class="viewcode-back" href="../grpc.html#grpc.StatusCode">[docs]</a><span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
<span class="k">class</span> <span class="nc">StatusCode</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;Mirrors grpc_status_code in the gRPC Core.&quot;&quot;&quot;</span>
    <span class="n">OK</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">ok</span><span class="p">,</span> <span class="s1">&#39;ok&#39;</span><span class="p">)</span>
    <span class="n">CANCELLED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">cancelled</span><span class="p">,</span> <span class="s1">&#39;cancelled&#39;</span><span class="p">)</span>
    <span class="n">UNKNOWN</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">unknown</span><span class="p">,</span> <span class="s1">&#39;unknown&#39;</span><span class="p">)</span>
    <span class="n">INVALID_ARGUMENT</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">invalid_argument</span><span class="p">,</span> <span class="s1">&#39;invalid argument&#39;</span><span class="p">)</span>
    <span class="n">DEADLINE_EXCEEDED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">deadline_exceeded</span><span class="p">,</span>
                         <span class="s1">&#39;deadline exceeded&#39;</span><span class="p">)</span>
    <span class="n">NOT_FOUND</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">not_found</span><span class="p">,</span> <span class="s1">&#39;not found&#39;</span><span class="p">)</span>
    <span class="n">ALREADY_EXISTS</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">already_exists</span><span class="p">,</span> <span class="s1">&#39;already exists&#39;</span><span class="p">)</span>
    <span class="n">PERMISSION_DENIED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">permission_denied</span><span class="p">,</span>
                         <span class="s1">&#39;permission denied&#39;</span><span class="p">)</span>
    <span class="n">RESOURCE_EXHAUSTED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">resource_exhausted</span><span class="p">,</span>
                          <span class="s1">&#39;resource exhausted&#39;</span><span class="p">)</span>
    <span class="n">FAILED_PRECONDITION</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">failed_precondition</span><span class="p">,</span>
                           <span class="s1">&#39;failed precondition&#39;</span><span class="p">)</span>
    <span class="n">ABORTED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">aborted</span><span class="p">,</span> <span class="s1">&#39;aborted&#39;</span><span class="p">)</span>
    <span class="n">OUT_OF_RANGE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">out_of_range</span><span class="p">,</span> <span class="s1">&#39;out of range&#39;</span><span class="p">)</span>
    <span class="n">UNIMPLEMENTED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">unimplemented</span><span class="p">,</span> <span class="s1">&#39;unimplemented&#39;</span><span class="p">)</span>
    <span class="n">INTERNAL</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">internal</span><span class="p">,</span> <span class="s1">&#39;internal&#39;</span><span class="p">)</span>
    <span class="n">UNAVAILABLE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">unavailable</span><span class="p">,</span> <span class="s1">&#39;unavailable&#39;</span><span class="p">)</span>
    <span class="n">DATA_LOSS</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">data_loss</span><span class="p">,</span> <span class="s1">&#39;data loss&#39;</span><span class="p">)</span>
    <span class="n">UNAUTHENTICATED</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">unauthenticated</span><span class="p">,</span> <span class="s1">&#39;unauthenticated&#39;</span><span class="p">)</span></div>


<span class="c1">#############################  gRPC Exceptions  ################################</span>


<div class="viewcode-block" id="RpcError"><a class="viewcode-back" href="../grpc.html#grpc.RpcError">[docs]</a><span class="k">class</span> <span class="nc">RpcError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Raised by the gRPC library to indicate non-OK-status RPC termination.&quot;&quot;&quot;</span></div>


<span class="c1">##############################  Shared Context  ################################</span>


<div class="viewcode-block" id="RpcContext"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext">[docs]</a><span class="k">class</span> <span class="nc">RpcContext</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;Provides RPC-related information and action.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="RpcContext.is_active"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.is_active">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">is_active</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes whether the RPC is active or has terminated.</span>

<span class="sd">    Returns:</span>
<span class="sd">      bool:</span>
<span class="sd">      True if RPC is active, False otherwise.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="RpcContext.time_remaining"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.time_remaining">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">time_remaining</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes the length of allowed time remaining for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A nonnegative float indicating the length of allowed time in seconds</span>
<span class="sd">      remaining for the RPC to complete before it is considered to have timed</span>
<span class="sd">      out, or None if no deadline was specified for the RPC.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="RpcContext.cancel"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.cancel">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Cancels the RPC.</span>

<span class="sd">    Idempotent and has no effect if the RPC has already terminated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="RpcContext.add_callback"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.add_callback">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Registers a callback to be called on RPC termination.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A no-parameter callable to be called on RPC termination.</span>

<span class="sd">    Returns:</span>
<span class="sd">      bool:</span>
<span class="sd">        True if the callback was added and will be called later; False if the</span>
<span class="sd">        callback was not added and will not be called (because the RPC</span>
<span class="sd">        already terminated or some other reason).</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">#########################  Invocation-Side Context  ############################</span>


<div class="viewcode-block" id="Call"><a class="viewcode-back" href="../grpc.html#grpc.Call">[docs]</a><span class="k">class</span> <span class="nc">Call</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="n">RpcContext</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;Invocation-side utility object for an RPC.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="Call.initial_metadata"><a class="viewcode-back" href="../grpc.html#grpc.Call.initial_metadata">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accesses the initial metadata sent by the server.</span>

<span class="sd">    This method blocks until the value is available.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The initial :term:`metadata`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Call.trailing_metadata"><a class="viewcode-back" href="../grpc.html#grpc.Call.trailing_metadata">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accesses the trailing metadata sent by the server.</span>

<span class="sd">    This method blocks until the value is available.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The trailing :term:`metadata`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Call.code"><a class="viewcode-back" href="../grpc.html#grpc.Call.code">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">code</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accesses the status code sent by the server.</span>

<span class="sd">    This method blocks until the value is available.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The StatusCode value for the RPC.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Call.details"><a class="viewcode-back" href="../grpc.html#grpc.Call.details">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accesses the details sent by the server.</span>

<span class="sd">    This method blocks until the value is available.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The details string of the RPC.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">############  Authentication &amp; Authorization Interfaces &amp; Classes  #############</span>


<div class="viewcode-block" id="ChannelCredentials"><a class="viewcode-back" href="../grpc.html#grpc.ChannelCredentials">[docs]</a><span class="k">class</span> <span class="nc">ChannelCredentials</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to create a secure Channel.</span>

<span class="sd">  This class has no supported interface - it exists to define the type of its</span>
<span class="sd">  instances and its instances exist to be passed to other functions. For</span>
<span class="sd">  example, ssl_channel_credentials returns an instance, and secure_channel</span>
<span class="sd">  consumes an instance of this class.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <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">credentials</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>


<div class="viewcode-block" id="CallCredentials"><a class="viewcode-back" href="../grpc.html#grpc.CallCredentials">[docs]</a><span class="k">class</span> <span class="nc">CallCredentials</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to assert an identity over a</span>
<span class="sd">       channel.</span>

<span class="sd">  A CallCredentials may be composed with ChannelCredentials to always assert</span>
<span class="sd">  identity for every call over that Channel.</span>

<span class="sd">  This class has no supported interface - it exists to define the type of its</span>
<span class="sd">  instances and its instances exist to be passed to other functions.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <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">credentials</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>


<div class="viewcode-block" id="AuthMetadataContext"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataContext">[docs]</a><span class="k">class</span> <span class="nc">AuthMetadataContext</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;Provides information to call credentials metadata plugins.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    service_url: A string URL of the service being called into.</span>
<span class="sd">    method_name: A string of the fully qualified method name being called.</span>
<span class="sd">  &quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="AuthMetadataPluginCallback"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPluginCallback">[docs]</a><span class="k">class</span> <span class="nc">AuthMetadataPluginCallback</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;Callback object received by a metadata plugin.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="AuthMetadataPluginCallback.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPluginCallback.__call__">[docs]</a>    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Inform the gRPC runtime of the metadata to construct a</span>
<span class="sd">           CallCredentials.</span>

<span class="sd">    Args:</span>
<span class="sd">      metadata: The :term:`metadata` used to construct the CallCredentials.</span>
<span class="sd">      error: An Exception to indicate error or None to indicate success.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="AuthMetadataPlugin"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPlugin">[docs]</a><span class="k">class</span> <span class="nc">AuthMetadataPlugin</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 specification for custom authentication.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="AuthMetadataPlugin.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPlugin.__call__">[docs]</a>    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Implements authentication by passing metadata to a callback.</span>

<span class="sd">    Implementations of this method must not block.</span>

<span class="sd">    Args:</span>
<span class="sd">      context: An AuthMetadataContext providing information on the RPC that the</span>
<span class="sd">        plugin is being called to authenticate.</span>
<span class="sd">      callback: An AuthMetadataPluginCallback to be invoked either synchronously</span>
<span class="sd">        or asynchronously.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="ServerCredentials"><a class="viewcode-back" href="../grpc.html#grpc.ServerCredentials">[docs]</a><span class="k">class</span> <span class="nc">ServerCredentials</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to open a secure port on a Server.</span>

<span class="sd">  This class has no supported interface - it exists to define the type of its</span>
<span class="sd">  instances and its instances exist to be passed to other functions.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <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">credentials</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>


<span class="c1">########################  Multi-Callable Interfaces  ###########################</span>


<div class="viewcode-block" id="UnaryUnaryMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryMultiCallable</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;Affords invoking a unary-unary RPC from client-side.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="UnaryUnaryMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.__call__">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      request: The request value for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The response value for the RPC.</span>

<span class="sd">    Raises:</span>
<span class="sd">      RpcError: Indicating that the RPC terminated with non-OK status. The</span>
<span class="sd">        raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
<span class="sd">        metadata, status code, and details.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="UnaryUnaryMultiCallable.with_call"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.with_call">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      request: The request value for the RPC.</span>
<span class="sd">      timeout: An optional durating of time in seconds to allow for the RPC.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The response value for the RPC and a Call value for the RPC.</span>

<span class="sd">    Raises:</span>
<span class="sd">      RpcError: Indicating that the RPC terminated with non-OK status. The</span>
<span class="sd">        raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
<span class="sd">        metadata, status code, and details.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="UnaryUnaryMultiCallable.future"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.future">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Asynchronously invokes the underlying RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      request: The request value for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">        An object that is both a Call for the RPC and a Future. In the event of</span>
<span class="sd">        RPC completion, the return Call-Future&#39;s result value will be the</span>
<span class="sd">        response message of the RPC. Should the event terminate with non-OK</span>
<span class="sd">        status, the returned Call-Future&#39;s exception value will be an RpcError.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="UnaryStreamMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamMultiCallable</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;Affords invoking a unary-stream RPC from client-side.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="UnaryStreamMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamMultiCallable.__call__">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Invokes the underlying RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      request: The request value for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">               If None, the timeout is considered infinite.</span>
<span class="sd">      metadata: An optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">        An object that is both a Call for the RPC and an iterator of response</span>
<span class="sd">        values. Drawing response values from the returned Call-iterator may</span>
<span class="sd">        raise RpcError indicating termination of the RPC with non-OK status.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="StreamUnaryMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryMultiCallable</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;Affords invoking a stream-unary RPC from client-side.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="StreamUnaryMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.__call__">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                 <span class="n">request_iterator</span><span class="p">,</span>
                 <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      request_iterator: An iterator that yields request values for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">               If None, the timeout is considered infinite.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The response value for the RPC.</span>

<span class="sd">    Raises:</span>
<span class="sd">      RpcError: Indicating that the RPC terminated with non-OK status. The</span>
<span class="sd">        raised RpcError will also implement grpc.Call, affording methods</span>
<span class="sd">        such as metadata, code, and details.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="StreamUnaryMultiCallable.with_call"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.with_call">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                  <span class="n">request_iterator</span><span class="p">,</span>
                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC on the client.</span>

<span class="sd">    Args:</span>
<span class="sd">      request_iterator: An iterator that yields request values for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">               If None, the timeout is considered infinite.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The response value for the RPC and a Call object for the RPC.</span>

<span class="sd">    Raises:</span>
<span class="sd">      RpcError: Indicating that the RPC terminated with non-OK status. The</span>
<span class="sd">        raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
<span class="sd">        metadata, status code, and details.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="StreamUnaryMultiCallable.future"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.future">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
               <span class="n">request_iterator</span><span class="p">,</span>
               <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
               <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
               <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Asynchronously invokes the underlying RPC on the client.</span>

<span class="sd">    Args:</span>
<span class="sd">      request_iterator: An iterator that yields request values for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">               If None, the timeout is considered infinite.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">        An object that is both a Call for the RPC and a Future. In the event of</span>
<span class="sd">        RPC completion, the return Call-Future&#39;s result value will be the</span>
<span class="sd">        response message of the RPC. Should the event terminate with non-OK</span>
<span class="sd">        status, the returned Call-Future&#39;s exception value will be an RpcError.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="StreamStreamMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamMultiCallable</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;Affords invoking a stream-stream RPC on client-side.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="StreamStreamMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamMultiCallable.__call__">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                 <span class="n">request_iterator</span><span class="p">,</span>
                 <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Invokes the underlying RPC on the client.</span>

<span class="sd">    Args:</span>
<span class="sd">      request_iterator: An iterator that yields request values for the RPC.</span>
<span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
<span class="sd">               if not specified the timeout is considered infinite.</span>
<span class="sd">      metadata: Optional :term:`metadata` to be transmitted to the</span>
<span class="sd">        service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">        An object that is both a Call for the RPC and an iterator of response</span>
<span class="sd">        values. Drawing response values from the returned Call-iterator may</span>
<span class="sd">        raise RpcError indicating termination of the RPC with non-OK status.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">#############################  Channel Interface  ##############################</span>


<div class="viewcode-block" id="Channel"><a class="viewcode-back" href="../grpc.html#grpc.Channel">[docs]</a><span class="k">class</span> <span class="nc">Channel</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;Affords RPC invocation via generic methods on client-side.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="Channel.subscribe"><a class="viewcode-back" href="../grpc.html#grpc.Channel.subscribe">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">subscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">try_to_connect</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Subscribe to this Channel&#39;s connectivity state machine.</span>

<span class="sd">    A Channel may be in any of the states described by ChannelConnectivity.</span>
<span class="sd">    This method allows application to monitor the state transitions.</span>
<span class="sd">    The typical use case is to debug or gain better visibility into gRPC</span>
<span class="sd">    runtime&#39;s state.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A callable to be invoked with ChannelConnectivity argument.</span>
<span class="sd">        ChannelConnectivity describes current state of the channel.</span>
<span class="sd">        The callable will be invoked immediately upon subscription and again for</span>
<span class="sd">        every change to ChannelConnectivity until it is unsubscribed or this</span>
<span class="sd">        Channel object goes out of scope.</span>
<span class="sd">      try_to_connect: A boolean indicating whether or not this Channel should</span>
<span class="sd">        attempt to connect immediately. If set to False, gRPC runtime decides</span>
<span class="sd">        when to connect.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Channel.unsubscribe"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unsubscribe">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">unsubscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Unsubscribes a subscribed callback from this Channel&#39;s connectivity.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A callable previously registered with this Channel from having</span>
<span class="sd">        been passed to its &quot;subscribe&quot; method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Channel.unary_unary"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unary_unary">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                    <span class="n">method</span><span class="p">,</span>
                    <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                    <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Creates a UnaryUnaryMultiCallable for a unary-unary method.</span>

<span class="sd">    Args:</span>
<span class="sd">      method: The name of the RPC method.</span>
<span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
<span class="sd">        message. Request goes unserialized in case None is passed.</span>
<span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
<span class="sd">        message. Response goes undeserialized in case None is passed.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A UnaryUnaryMultiCallable value for the named unary-unary method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Channel.unary_stream"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unary_stream">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                     <span class="n">method</span><span class="p">,</span>
                     <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                     <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Creates a UnaryStreamMultiCallable for a unary-stream method.</span>

<span class="sd">    Args:</span>
<span class="sd">      method: The name of the RPC method.</span>
<span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
<span class="sd">        message. Request goes unserialized in case None is passed.</span>
<span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
<span class="sd">        message. Response goes undeserialized in case None is passed.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A UnaryStreamMultiCallable value for the name unary-stream method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Channel.stream_unary"><a class="viewcode-back" href="../grpc.html#grpc.Channel.stream_unary">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                     <span class="n">method</span><span class="p">,</span>
                     <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                     <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Creates a StreamUnaryMultiCallable for a stream-unary method.</span>

<span class="sd">    Args:</span>
<span class="sd">      method: The name of the RPC method.</span>
<span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
<span class="sd">        message. Request goes unserialized in case None is passed.</span>
<span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
<span class="sd">        message. Response goes undeserialized in case None is passed.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A StreamUnaryMultiCallable value for the named stream-unary method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Channel.stream_stream"><a class="viewcode-back" href="../grpc.html#grpc.Channel.stream_stream">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                      <span class="n">method</span><span class="p">,</span>
                      <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                      <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Creates a StreamStreamMultiCallable for a stream-stream method.</span>

<span class="sd">    Args:</span>
<span class="sd">      method: The name of the RPC method.</span>
<span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
<span class="sd">        message. Request goes unserialized in case None is passed.</span>
<span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
<span class="sd">        message. Response goes undeserialized in case None is passed.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A StreamStreamMultiCallable value for the named stream-stream method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">##########################  Service-Side Context  ##############################</span>


<div class="viewcode-block" id="ServicerContext"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext">[docs]</a><span class="k">class</span> <span class="nc">ServicerContext</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="n">RpcContext</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;A context object passed to method implementations.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="ServicerContext.invocation_metadata"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.invocation_metadata">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">invocation_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accesses the metadata from the sent by the client.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The invocation :term:`metadata`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.peer"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.peer">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Identifies the peer that invoked the RPC being serviced.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A string identifying the peer that invoked the RPC being serviced.</span>
<span class="sd">      The string format is determined by gRPC runtime.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.peer_identities"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.peer_identities">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">peer_identities</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Gets one or more peer identity(s).</span>

<span class="sd">      Equivalent to</span>
<span class="sd">      servicer_context.auth_context().get(</span>
<span class="sd">          servicer_context.peer_identity_key())</span>

<span class="sd">    Returns:</span>
<span class="sd">      An iterable of the identities, or None if the call is not authenticated.</span>
<span class="sd">      Each identity is returned as a raw bytes type.</span>
<span class="sd">     &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.peer_identity_key"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.peer_identity_key">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">peer_identity_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;The auth property used to identify the peer.</span>

<span class="sd">    For example, &quot;x509_common_name&quot; or &quot;x509_subject_alternative_name&quot; are</span>
<span class="sd">    used to identify an SSL peer.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The auth property (string) that indicates the</span>
<span class="sd">      peer identity, or None if the call is not authenticated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.auth_context"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.auth_context">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">auth_context</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Gets the auth context for the call.</span>

<span class="sd">      Returns:</span>
<span class="sd">        A map of strings to an iterable of bytes for each auth property.</span>
<span class="sd">      &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.send_initial_metadata"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.send_initial_metadata">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Sends the initial metadata value to the client.</span>

<span class="sd">    This method need not be called by implementations if they have no</span>
<span class="sd">    metadata to add to what the gRPC runtime will transmit.</span>

<span class="sd">    Args:</span>
<span class="sd">      initial_metadata: The initial :term:`metadata`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.set_trailing_metadata"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_trailing_metadata">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">set_trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Sends the trailing metadata for the RPC.</span>

<span class="sd">    This method need not be called by implementations if they have no</span>
<span class="sd">    metadata to add to what the gRPC runtime will transmit.</span>

<span class="sd">    Args:</span>
<span class="sd">      trailing_metadata: The trailing :term:`metadata`.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.set_code"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_code">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">set_code</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Sets the value to be used as status code upon RPC completion.</span>

<span class="sd">    This method need not be called by method implementations if they wish the</span>
<span class="sd">    gRPC runtime to determine the status code of the RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      code: A StatusCode object to be sent to the client.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="ServicerContext.set_details"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_details">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">set_details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Sets the value to be used as detail string upon RPC completion.</span>

<span class="sd">    This method need not be called by method implementations if they have no</span>
<span class="sd">    details to transmit.</span>

<span class="sd">    Args:</span>
<span class="sd">      details: An arbitrary string to be sent to the client upon completion.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">#####################  Service-Side Handler Interfaces  ########################</span>


<div class="viewcode-block" id="RpcMethodHandler"><a class="viewcode-back" href="../grpc.html#grpc.RpcMethodHandler">[docs]</a><span class="k">class</span> <span class="nc">RpcMethodHandler</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;An implementation of a single RPC method.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    request_streaming: Whether the RPC supports exactly one request message or</span>
<span class="sd">      any arbitrary number of request messages.</span>
<span class="sd">    response_streaming: Whether the RPC supports exactly one response message or</span>
<span class="sd">      any arbitrary number of response messages.</span>
<span class="sd">    request_deserializer: A callable behavior that accepts a byte string and</span>
<span class="sd">      returns an object suitable to be passed to this object&#39;s business logic,</span>
<span class="sd">      or None to indicate that this object&#39;s business logic should be passed the</span>
<span class="sd">      raw request bytes.</span>
<span class="sd">    response_serializer: A callable behavior that accepts an object produced by</span>
<span class="sd">      this object&#39;s business logic and returns a byte string, or None to</span>
<span class="sd">      indicate that the byte strings produced by this object&#39;s business logic</span>
<span class="sd">      should be transmitted on the wire as they are.</span>
<span class="sd">    unary_unary: This object&#39;s application-specific business logic as a callable</span>
<span class="sd">      value that takes a request value and a ServicerContext object and returns</span>
<span class="sd">      a response value. Only non-None if both request_streaming and</span>
<span class="sd">      response_streaming are False.</span>
<span class="sd">    unary_stream: This object&#39;s application-specific business logic as a</span>
<span class="sd">      callable value that takes a request value and a ServicerContext object and</span>
<span class="sd">      returns an iterator of response values. Only non-None if request_streaming</span>
<span class="sd">      is False and response_streaming is True.</span>
<span class="sd">    stream_unary: This object&#39;s application-specific business logic as a</span>
<span class="sd">      callable value that takes an iterator of request values and a</span>
<span class="sd">      ServicerContext object and returns a response value. Only non-None if</span>
<span class="sd">      request_streaming is True and response_streaming is False.</span>
<span class="sd">    stream_stream: This object&#39;s application-specific business logic as a</span>
<span class="sd">      callable value that takes an iterator of request values and a</span>
<span class="sd">      ServicerContext object and returns an iterator of response values. Only</span>
<span class="sd">      non-None if request_streaming and response_streaming are both True.</span>
<span class="sd">  &quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="HandlerCallDetails"><a class="viewcode-back" href="../grpc.html#grpc.HandlerCallDetails">[docs]</a><span class="k">class</span> <span class="nc">HandlerCallDetails</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;Describes an RPC that has just arrived for service.</span>
<span class="sd">  Attributes:</span>
<span class="sd">    method: The method name of the RPC.</span>
<span class="sd">    invocation_metadata: The :term:`metadata` sent by the client.</span>
<span class="sd">  &quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="GenericRpcHandler"><a class="viewcode-back" href="../grpc.html#grpc.GenericRpcHandler">[docs]</a><span class="k">class</span> <span class="nc">GenericRpcHandler</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;An implementation of arbitrarily many RPC methods.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="GenericRpcHandler.service"><a class="viewcode-back" href="../grpc.html#grpc.GenericRpcHandler.service">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler_call_details</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns the handler for servicing the RPC.</span>

<span class="sd">    Args:</span>
<span class="sd">      handler_call_details: A HandlerCallDetails describing the RPC.</span>

<span class="sd">    Returns:</span>
<span class="sd">      An RpcMethodHandler with which the RPC may be serviced if the</span>
<span class="sd">      implementation chooses to service this RPC, or None otherwise.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="ServiceRpcHandler"><a class="viewcode-back" href="../grpc.html#grpc.ServiceRpcHandler">[docs]</a><span class="k">class</span> <span class="nc">ServiceRpcHandler</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="n">GenericRpcHandler</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;An implementation of RPC methods belonging to a service.</span>

<span class="sd">  A service handles RPC methods with structured names of the form</span>
<span class="sd">  &#39;/Service.Name/Service.Method&#39;, where &#39;Service.Name&#39; is the value</span>
<span class="sd">  returned by service_name(), and &#39;Service.Method&#39; is the method</span>
<span class="sd">  name.  A service can have multiple method names, but only a single</span>
<span class="sd">  service name.</span>
<span class="sd">  &quot;&quot;&quot;</span>

<div class="viewcode-block" id="ServiceRpcHandler.service_name"><a class="viewcode-back" href="../grpc.html#grpc.ServiceRpcHandler.service_name">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">service_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Returns this service&#39;s name.</span>

<span class="sd">    Returns:</span>
<span class="sd">      The service name.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">#############################  Server Interface  ###############################</span>


<div class="viewcode-block" id="Server"><a class="viewcode-back" href="../grpc.html#grpc.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</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;Services RPCs.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="Server.add_generic_rpc_handlers"><a class="viewcode-back" href="../grpc.html#grpc.Server.add_generic_rpc_handlers">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">add_generic_rpc_handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">generic_rpc_handlers</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Registers GenericRpcHandlers with this Server.</span>

<span class="sd">    This method is only safe to call before the server is started.</span>

<span class="sd">    Args:</span>
<span class="sd">      generic_rpc_handlers: An iterable of GenericRpcHandlers that will be used</span>
<span class="sd">      to service RPCs.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Server.add_insecure_port"><a class="viewcode-back" href="../grpc.html#grpc.Server.add_insecure_port">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">add_insecure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Opens an insecure port for accepting RPCs.</span>

<span class="sd">    This method may only be called before starting the server.</span>

<span class="sd">    Args:</span>
<span class="sd">      address: The address for which to open a port.</span>
<span class="sd">      if the port is 0, or not specified in the address, then gRPC runtime</span>
<span class="sd">      will choose a port.</span>

<span class="sd">    Returns:</span>
<span class="sd">      integer:</span>
<span class="sd">      An integer port on which server will accept RPC requests.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Server.add_secure_port"><a class="viewcode-back" href="../grpc.html#grpc.Server.add_secure_port">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">add_secure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">server_credentials</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Opens a secure port for accepting RPCs.</span>

<span class="sd">    This method may only be called before starting the server.</span>

<span class="sd">    Args:</span>
<span class="sd">      address: The address for which to open a port.</span>
<span class="sd">        if the port is 0, or not specified in the address, then gRPC runtime</span>
<span class="sd">        will choose a port.</span>
<span class="sd">      server_credentials: A ServerCredentials object.</span>

<span class="sd">    Returns:</span>
<span class="sd">      integer:</span>
<span class="sd">      An integer port on which server will accept RPC requests.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Server.start"><a class="viewcode-back" href="../grpc.html#grpc.Server.start">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Starts this Server.</span>

<span class="sd">    This method may only be called once. (i.e. it is not idempotent).</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

<div class="viewcode-block" id="Server.stop"><a class="viewcode-back" href="../grpc.html#grpc.Server.stop">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grace</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Stops this Server.</span>

<span class="sd">    This method immediately stop service of new RPCs in all cases.</span>
<span class="sd">    If a grace period is specified, this method returns immediately</span>
<span class="sd">    and all RPCs active at the end of the grace period are aborted.</span>

<span class="sd">    If a grace period is not specified, then all existing RPCs are</span>
<span class="sd">    teriminated immediately and the this method blocks until the last</span>
<span class="sd">    RPC handler terminates.</span>

<span class="sd">    This method is idempotent and may be called at any time. Passing a smaller</span>
<span class="sd">    grace value in subsequentcall will have the effect of stopping the Server</span>
<span class="sd">    sooner. Passing a larger grace value in subsequent call *will not* have the</span>
<span class="sd">    effect of stopping the server later (i.e. the most restrictive grace</span>
<span class="sd">    value is used).</span>

<span class="sd">    Args:</span>
<span class="sd">      grace: A duration of time in seconds or None.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A threading.Event that will be set when this Server has completely</span>
<span class="sd">      stopped, i.e. when running RPCs either complete or are aborted and</span>
<span class="sd">      all handlers have terminated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<span class="c1">#################################  Functions    ################################</span>


<div class="viewcode-block" id="unary_unary_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.unary_unary_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">unary_unary_rpc_method_handler</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span>
                                   <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                   <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-unary RPC method.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: The implementation of an RPC that accepts one request and returns</span>
<span class="sd">    one response.</span>
<span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
<span class="sd">    response_serializer: An optional behavior for response serialization.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span>
                                       <span class="n">response_serializer</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
                                       <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>


<div class="viewcode-block" id="unary_stream_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.unary_stream_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">unary_stream_rpc_method_handler</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span>
                                    <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-stream RPC method.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: The implementation of an RPC that accepts one request and returns</span>
<span class="sd">      an iterator of response values.</span>
<span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
<span class="sd">    response_serializer: An optional behavior for response serialization.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span>
                                       <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span>
                                       <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>


<div class="viewcode-block" id="stream_unary_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.stream_unary_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">stream_unary_rpc_method_handler</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span>
                                    <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                    <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-unary RPC method.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: The implementation of an RPC that accepts an iterator of request</span>
<span class="sd">    values and returns a single response value.</span>
<span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
<span class="sd">    response_serializer: An optional behavior for response serialization.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span>
                                       <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
                                       <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>


<div class="viewcode-block" id="stream_stream_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.stream_stream_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">stream_stream_rpc_method_handler</span><span class="p">(</span><span class="n">behavior</span><span class="p">,</span>
                                     <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                                     <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-stream RPC method.</span>

<span class="sd">  Args:</span>
<span class="sd">    behavior: The implementation of an RPC that accepts an iterator of request</span>
<span class="sd">    values and returns an iterator of response values.</span>
<span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
<span class="sd">    response_serializer: An optional behavior for response serialization.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span>
                                       <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
                                       <span class="n">behavior</span><span class="p">)</span></div>


<div class="viewcode-block" id="method_handlers_generic_handler"><a class="viewcode-back" href="../grpc.html#grpc.method_handlers_generic_handler">[docs]</a><span class="k">def</span> <span class="nf">method_handlers_generic_handler</span><span class="p">(</span><span class="n">service</span><span class="p">,</span> <span class="n">method_handlers</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a GenericRpcHandler from RpcMethodHandlers.</span>

<span class="sd">  Args:</span>
<span class="sd">    service: The name of the service that is implemented by the method_handlers.</span>
<span class="sd">    method_handlers: A dictionary that maps method names to corresponding</span>
<span class="sd">    RpcMethodHandler.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A GenericRpcHandler. This is typically added to the grpc.Server object</span>
<span class="sd">    with add_generic_rpc_handlers() before starting the server.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">DictionaryGenericHandler</span><span class="p">(</span><span class="n">service</span><span class="p">,</span> <span class="n">method_handlers</span><span class="p">)</span></div>


<div class="viewcode-block" id="ssl_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.ssl_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">ssl_channel_credentials</span><span class="p">(</span><span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                            <span class="n">private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                            <span class="n">certificate_chain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a ChannelCredentials for use with an SSL-enabled Channel.</span>

<span class="sd">  Args:</span>
<span class="sd">    root_certificates: The PEM-encoded root certificates as a byte string,</span>
<span class="sd">    or None to retrieve them from a default location chosen by gRPC runtime.</span>
<span class="sd">    private_key: The PEM-encoded private key as a byte string, or None if no</span>
<span class="sd">    private key should be used.</span>
<span class="sd">    certificate_chain: The PEM-encoded certificate chain as a byte string</span>
<span class="sd">    to use or or None if no certificate chain should be used.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A ChannelCredentials for use with an SSL-enabled Channel.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">private_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">certificate_chain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
        <span class="n">pair</span> <span class="o">=</span> <span class="n">_cygrpc</span><span class="o">.</span><span class="n">SslPemKeyCertPair</span><span class="p">(</span><span class="n">private_key</span><span class="p">,</span> <span class="n">certificate_chain</span><span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">pair</span> <span class="o">=</span> <span class="kc">None</span>
    <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
        <span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_ssl</span><span class="p">(</span><span class="n">root_certificates</span><span class="p">,</span> <span class="n">pair</span><span class="p">))</span></div>


<div class="viewcode-block" id="metadata_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.metadata_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">metadata_call_credentials</span><span class="p">(</span><span class="n">metadata_plugin</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an AuthMetadataPlugin.</span>

<span class="sd">  Args:</span>
<span class="sd">    metadata_plugin: An AuthMetadataPlugin to use for authentication.</span>
<span class="sd">    name: An optional name for the plugin.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A CallCredentials.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_plugin_wrapping</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">effective_name</span> <span class="o">=</span> <span class="n">metadata_plugin</span><span class="o">.</span><span class="vm">__name__</span>
        <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
            <span class="n">effective_name</span> <span class="o">=</span> <span class="n">metadata_plugin</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">effective_name</span> <span class="o">=</span> <span class="n">name</span>
    <span class="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
        <span class="n">_plugin_wrapping</span><span class="o">.</span><span class="n">call_credentials_metadata_plugin</span><span class="p">(</span><span class="n">metadata_plugin</span><span class="p">,</span>
                                                          <span class="n">effective_name</span><span class="p">))</span></div>


<div class="viewcode-block" id="access_token_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.access_token_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">access_token_call_credentials</span><span class="p">(</span><span class="n">access_token</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an access token.</span>

<span class="sd">  Args:</span>
<span class="sd">    access_token: A string to place directly in the http request</span>
<span class="sd">      authorization header, for example</span>
<span class="sd">      &quot;authorization: Bearer &lt;access_token&gt;&quot;.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A CallCredentials.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_auth</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">metadata_call_credentials</span><span class="p">(</span>
        <span class="n">_auth</span><span class="o">.</span><span class="n">AccessTokenCallCredentials</span><span class="p">(</span><span class="n">access_token</span><span class="p">))</span></div>


<div class="viewcode-block" id="composite_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_call_credentials</span><span class="p">(</span><span class="o">*</span><span class="n">call_credentials</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Compose multiple CallCredentials to make a new CallCredentials.</span>

<span class="sd">  Args:</span>
<span class="sd">    *call_credentials: At least two CallCredentials objects.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A CallCredentials object composed of the given CallCredentials objects.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_credential_composition</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="n">cygrpc_call_credentials</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
        <span class="n">single_call_credentials</span><span class="o">.</span><span class="n">_credentials</span>
        <span class="k">for</span> <span class="n">single_call_credentials</span> <span class="ow">in</span> <span class="n">call_credentials</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
        <span class="n">_credential_composition</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cygrpc_call_credentials</span><span class="p">))</span></div>


<div class="viewcode-block" id="composite_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_channel_credentials</span><span class="p">(</span><span class="n">channel_credentials</span><span class="p">,</span> <span class="o">*</span><span class="n">call_credentials</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Compose a ChannelCredentials and one or more CallCredentials objects.</span>

<span class="sd">  Args:</span>
<span class="sd">    channel_credentials: A ChannelCredentials object.</span>
<span class="sd">    *call_credentials: One or more CallCredentials objects.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A ChannelCredentials composed of the given ChannelCredentials and</span>
<span class="sd">    CallCredentials objects.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_credential_composition</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="n">cygrpc_call_credentials</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
        <span class="n">single_call_credentials</span><span class="o">.</span><span class="n">_credentials</span>
        <span class="k">for</span> <span class="n">single_call_credentials</span> <span class="ow">in</span> <span class="n">call_credentials</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
        <span class="n">_credential_composition</span><span class="o">.</span><span class="n">channel</span><span class="p">(</span><span class="n">channel_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">,</span>
                                        <span class="n">cygrpc_call_credentials</span><span class="p">))</span></div>


<div class="viewcode-block" id="ssl_server_credentials"><a class="viewcode-back" href="../grpc.html#grpc.ssl_server_credentials">[docs]</a><span class="k">def</span> <span class="nf">ssl_server_credentials</span><span class="p">(</span><span class="n">private_key_certificate_chain_pairs</span><span class="p">,</span>
                           <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                           <span class="n">require_client_auth</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an SSL-enabled Server.</span>

<span class="sd">  Args:</span>
<span class="sd">    private_key_certificate_chain_pairs: A list of pairs of the form</span>
<span class="sd">      [PEM-encoded private key, PEM-encoded certificate chain].</span>
<span class="sd">    root_certificates: An optional byte string of PEM-encoded client root</span>
<span class="sd">      certificates that the server will use to verify client authentication.</span>
<span class="sd">      If omitted, require_client_auth must also be False.</span>
<span class="sd">    require_client_auth: A boolean indicating whether or not to require</span>
<span class="sd">      clients to be authenticated. May only be True if root_certificates</span>
<span class="sd">      is not None.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A ServerCredentials for use with an SSL-enabled Server. Typically, this</span>
<span class="sd">    object is an argument to add_secure_port() method during server setup.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">private_key_certificate_chain_pairs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
            <span class="s1">&#39;At least one private key-certificate chain pair is required!&#39;</span><span class="p">)</span>
    <span class="k">elif</span> <span class="n">require_client_auth</span> <span class="ow">and</span> <span class="n">root_certificates</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
            <span class="s1">&#39;Illegal to require client auth without providing root certificates!&#39;</span>
        <span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
            <span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_credentials_ssl</span><span class="p">(</span><span class="n">root_certificates</span><span class="p">,</span> <span class="p">[</span>
                <span class="n">_cygrpc</span><span class="o">.</span><span class="n">SslPemKeyCertPair</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">pem</span><span class="p">)</span>
                <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">pem</span> <span class="ow">in</span> <span class="n">private_key_certificate_chain_pairs</span>
            <span class="p">],</span> <span class="n">require_client_auth</span><span class="p">))</span></div>


<div class="viewcode-block" id="channel_ready_future"><a class="viewcode-back" href="../grpc.html#grpc.channel_ready_future">[docs]</a><span class="k">def</span> <span class="nf">channel_ready_future</span><span class="p">(</span><span class="n">channel</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a Future that tracks when a Channel is ready.</span>

<span class="sd">  Cancelling the Future does not affect the channel&#39;s state machine.</span>
<span class="sd">  It merely decouples the Future from channel state machine.</span>

<span class="sd">  Args:</span>
<span class="sd">    channel: A Channel object.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A Future object that matures when the channel connectivity is</span>
<span class="sd">    ChannelConnectivity.READY.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">channel_ready_future</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span></div>


<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../grpc.html#grpc.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an insecure Channel to a server.</span>

<span class="sd">  Args:</span>
<span class="sd">    target: The server address</span>
<span class="sd">    options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
<span class="sd">    to configure the channel.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A Channel object.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>


<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../grpc.html#grpc.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">credentials</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a secure Channel to a server.</span>

<span class="sd">  Args:</span>
<span class="sd">    target: The server address.</span>
<span class="sd">    credentials: A ChannelCredentials instance.</span>
<span class="sd">    options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
<span class="sd">    to configure the channel.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A Channel object.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span><span class="p">,</span>
                            <span class="n">credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">)</span></div>


<div class="viewcode-block" id="server"><a class="viewcode-back" href="../grpc.html#grpc.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">thread_pool</span><span class="p">,</span>
           <span class="n">handlers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
           <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
           <span class="n">maximum_concurrent_rpcs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a Server with which RPCs can be serviced.</span>

<span class="sd">  Args:</span>
<span class="sd">    thread_pool: A futures.ThreadPoolExecutor to be used by the Server</span>
<span class="sd">      to execute RPC handlers.</span>
<span class="sd">    handlers: An optional list of GenericRpcHandlers used for executing RPCs.</span>
<span class="sd">      More handlers may be added by calling add_generic_rpc_handlers any time</span>
<span class="sd">      before the server is started.</span>
<span class="sd">    options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
<span class="sd">    to configure the channel.</span>
<span class="sd">    maximum_concurrent_rpcs: The maximum number of concurrent RPCs this server</span>
<span class="sd">      will service before returning RESOURCE_EXHAUSTED status, or None to</span>
<span class="sd">      indicate no limit.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A Server object.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_server</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_server</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="n">thread_pool</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">handlers</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">handlers</span><span class="p">,</span> <span class="p">()</span>
                          <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span><span class="p">,</span>
                          <span class="n">maximum_concurrent_rpcs</span><span class="p">)</span></div>


<span class="c1">###################################  __all__  #################################</span>

<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;FutureTimeoutError&#39;</span><span class="p">,</span> <span class="s1">&#39;FutureCancelledError&#39;</span><span class="p">,</span> <span class="s1">&#39;Future&#39;</span><span class="p">,</span>
           <span class="s1">&#39;ChannelConnectivity&#39;</span><span class="p">,</span> <span class="s1">&#39;StatusCode&#39;</span><span class="p">,</span> <span class="s1">&#39;RpcError&#39;</span><span class="p">,</span> <span class="s1">&#39;RpcContext&#39;</span><span class="p">,</span>
           <span class="s1">&#39;Call&#39;</span><span class="p">,</span> <span class="s1">&#39;ChannelCredentials&#39;</span><span class="p">,</span> <span class="s1">&#39;CallCredentials&#39;</span><span class="p">,</span>
           <span class="s1">&#39;AuthMetadataContext&#39;</span><span class="p">,</span> <span class="s1">&#39;AuthMetadataPluginCallback&#39;</span><span class="p">,</span>
           <span class="s1">&#39;AuthMetadataPlugin&#39;</span><span class="p">,</span> <span class="s1">&#39;ServerCredentials&#39;</span><span class="p">,</span> <span class="s1">&#39;UnaryUnaryMultiCallable&#39;</span><span class="p">,</span>
           <span class="s1">&#39;UnaryStreamMultiCallable&#39;</span><span class="p">,</span> <span class="s1">&#39;StreamUnaryMultiCallable&#39;</span><span class="p">,</span>
           <span class="s1">&#39;StreamStreamMultiCallable&#39;</span><span class="p">,</span> <span class="s1">&#39;Channel&#39;</span><span class="p">,</span> <span class="s1">&#39;ServicerContext&#39;</span><span class="p">,</span>
           <span class="s1">&#39;RpcMethodHandler&#39;</span><span class="p">,</span> <span class="s1">&#39;HandlerCallDetails&#39;</span><span class="p">,</span> <span class="s1">&#39;GenericRpcHandler&#39;</span><span class="p">,</span>
           <span class="s1">&#39;ServiceRpcHandler&#39;</span><span class="p">,</span> <span class="s1">&#39;Server&#39;</span><span class="p">,</span> <span class="s1">&#39;unary_unary_rpc_method_handler&#39;</span><span class="p">,</span>
           <span class="s1">&#39;unary_stream_rpc_method_handler&#39;</span><span class="p">,</span> <span class="s1">&#39;stream_unary_rpc_method_handler&#39;</span><span class="p">,</span>
           <span class="s1">&#39;stream_stream_rpc_method_handler&#39;</span><span class="p">,</span>
           <span class="s1">&#39;method_handlers_generic_handler&#39;</span><span class="p">,</span> <span class="s1">&#39;ssl_channel_credentials&#39;</span><span class="p">,</span>
           <span class="s1">&#39;metadata_call_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;access_token_call_credentials&#39;</span><span class="p">,</span>
           <span class="s1">&#39;composite_call_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;composite_channel_credentials&#39;</span><span class="p">,</span>
           <span class="s1">&#39;ssl_server_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;channel_ready_future&#39;</span><span class="p">,</span> <span class="s1">&#39;insecure_channel&#39;</span><span class="p">,</span>
           <span class="s1">&#39;secure_channel&#39;</span><span class="p">,</span> <span class="s1">&#39;server&#39;</span><span class="p">,)</span>

<span class="c1">############################### Extension Shims ################################</span>

<span class="c1"># Here to maintain backwards compatibility; avoid using these in new code!</span>
<span class="k">try</span><span class="p">:</span>
    <span class="kn">import</span> <span class="nn">grpc_tools</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">&#39;grpc.tools&#39;</span><span class="p">:</span> <span class="n">grpc_tools</span><span class="p">})</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    <span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
    <span class="kn">import</span> <span class="nn">grpc_health</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">&#39;grpc.health&#39;</span><span class="p">:</span> <span class="n">grpc_health</span><span class="p">})</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    <span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
    <span class="kn">import</span> <span class="nn">grpc_reflection</span>
    <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">&#39;grpc.reflection&#39;</span><span class="p">:</span> <span class="n">grpc_reflection</span><span class="p">})</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    <span class="k">pass</span>
</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.6.0',
            LANGUAGE:'en',
            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>