carto
/
grpc


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978
							
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>grpc &#8212; gRPC Python 1.18.0 documentation</title>
    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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/language_data.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
   
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  <div class="document">
    
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">gRPC Python</a></h1>


<p class="blurb">1.18.0</p>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../grpc.html">gRPC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../grpc_channelz.html">gRPC Channelz</a></li>
<li class="toctree-l1"><a class="reference internal" href="../grpc_health_checking.html">gRPC Health Checking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../grpc_reflection.html">gRPC Reflection</a></li>
<li class="toctree-l1"><a class="reference internal" href="../grpc_testing.html">gRPC Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../index.html">Documentation overview</a><ul>
  <li><a href="index.html">Module code</a><ul>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>


        </div>
      </div>
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <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">logging</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="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">NullHandler</span><span class="p">())</span>

<span class="k">try</span><span class="p">:</span>
    <span class="kn">from</span> <span class="nn">._grpcio_metadata</span> <span class="k">import</span> <span class="n">__version__</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    <span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;dev0&quot;</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,</span>
<span class="sd">    may be ongoing, 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</span>
<span class="sd">                to 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">            Returns 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">            Returns True if the computation is scheduled for execution or</span>
<span class="sd">            currently 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</span>
<span class="sd">            currently 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</span>
<span class="sd">            does 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</span>
<span class="sd">            raise 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</span>
<span class="sd">            did not raise an exception.</span>

<span class="sd">        Raises:</span>
<span class="sd">          FutureTimeoutError: If a timeout value is passed and the computation</span>
<span class="sd">            does 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</span>
<span class="sd">            to terminate or be cancelled. If None, the call will block until</span>
<span class="sd">            the computation&#39;s termination.</span>

<span class="sd">        Returns:</span>
<span class="sd">            The traceback of the exception raised by the computation, or None</span>
<span class="sd">            if the 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</span>
<span class="sd">            does 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</span>
<span class="sd">        of the computation.  Callbacks will be invoked after the future is</span>
<span class="sd">        terimated, whether successfully or not.</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</span>
<span class="sd">        to 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.</span>

<span class="sd">    Attributes:</span>
<span class="sd">      OK: Not an error; returned on success</span>
<span class="sd">      CANCELLED: The operation was cancelled (typically by the caller).</span>
<span class="sd">      UNKNOWN: Unknown error.</span>
<span class="sd">      INVALID_ARGUMENT: Client specified an invalid argument.</span>
<span class="sd">      DEADLINE_EXCEEDED: Deadline expired before operation could complete.</span>
<span class="sd">      NOT_FOUND: Some requested entity (e.g., file or directory) was not found.</span>
<span class="sd">      ALREADY_EXISTS: Some entity that we attempted to create (e.g., file or directory)</span>
<span class="sd">        already exists.</span>
<span class="sd">      PERMISSION_DENIED: The caller does not have permission to execute the specified</span>
<span class="sd">        operation.</span>
<span class="sd">      UNAUTHENTICATED: The request does not have valid authentication credentials for the</span>
<span class="sd">        operation.</span>
<span class="sd">      RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user quota, or</span>
<span class="sd">        perhaps the entire file system is out of space.</span>
<span class="sd">      FAILED_PRECONDITION: Operation was rejected because the system is not in a state</span>
<span class="sd">        required for the operation&#39;s execution.</span>
<span class="sd">      ABORTED: The operation was aborted, typically due to a concurrency issue</span>
<span class="sd">        like sequencer check failures, transaction aborts, etc.</span>
<span class="sd">      UNIMPLEMENTED: Operation is not implemented or not supported/enabled in this service.</span>
<span class="sd">      INTERNAL: Internal errors.  Means some invariants expected by underlying</span>
<span class="sd">        system has been broken.</span>
<span class="sd">      UNAVAILABLE: The service is currently unavailable.</span>
<span class="sd">      DATA_LOSS: Unrecoverable data loss or corruption.</span>
<span class="sd">    &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 Status  ################################</span>


<span class="k">class</span> <span class="nc">Status</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 the status of an RPC.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>

<span class="sd">    Attributes:</span>
<span class="sd">      code: A StatusCode object to be sent to the client.</span>
<span class="sd">      details: An ASCII-encodable string to be sent to the client upon</span>
<span class="sd">        termination of the RPC.</span>
<span class="sd">      trailing_metadata: The trailing :term:`metadata` in the RPC.</span>
<span class="sd">    &quot;&quot;&quot;</span>


<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</span>
<span class="sd">          timed 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</span>
<span class="sd">            the 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">##############  Invocation-Side Interceptor Interfaces &amp; Classes  ##############</span>


<div class="viewcode-block" id="ClientCallDetails"><a class="viewcode-back" href="../grpc.html#grpc.ClientCallDetails">[docs]</a><span class="k">class</span> <span class="nc">ClientCallDetails</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 to be invoked.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>

<span class="sd">    Attributes:</span>
<span class="sd">      method: The method name of 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</span>
<span class="sd">        the service-side of the RPC.</span>
<span class="sd">      credentials: An optional CallCredentials for the RPC.</span>
<span class="sd">      wait_for_ready: This is an EXPERIMENTAL argument. An optional flag t</span>
<span class="sd">        enable wait for ready mechanism.</span>
<span class="sd">    &quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="UnaryUnaryClientInterceptor"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryClientInterceptor</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 intercepting unary-unary invocations.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="UnaryUnaryClientInterceptor.intercept_unary_unary"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryClientInterceptor.intercept_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">intercept_unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">,</span> <span class="n">client_call_details</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Intercepts a unary-unary invocation asynchronously.</span>

<span class="sd">        Args:</span>
<span class="sd">          continuation: A function that proceeds with the invocation by</span>
<span class="sd">            executing the next interceptor in chain or invoking the</span>
<span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
<span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
<span class="sd">            The interceptor can use</span>
<span class="sd">            `response_future = continuation(client_call_details, request)`</span>
<span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
<span class="sd">            both a Call for the RPC and a Future. In the event of RPC</span>
<span class="sd">            completion, the return Call-Future&#39;s result value will be</span>
<span class="sd">            the response message of the RPC. Should the event terminate</span>
<span class="sd">            with non-OK status, the returned Call-Future&#39;s exception value</span>
<span class="sd">            will be an RpcError.</span>
<span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
<span class="sd">            outgoing RPC.</span>
<span class="sd">          request: The request value 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.</span>
<span class="sd">            In the event of RPC completion, the return Call-Future&#39;s</span>
<span class="sd">            result value will be the response message of the RPC.</span>
<span class="sd">            Should the event terminate with non-OK status, the returned</span>
<span class="sd">            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="UnaryStreamClientInterceptor"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamClientInterceptor</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 intercepting unary-stream invocations.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="UnaryStreamClientInterceptor.intercept_unary_stream"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamClientInterceptor.intercept_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">intercept_unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">,</span> <span class="n">client_call_details</span><span class="p">,</span>
                               <span class="n">request</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Intercepts a unary-stream invocation.</span>

<span class="sd">        Args:</span>
<span class="sd">          continuation: A function that proceeds with the invocation by</span>
<span class="sd">            executing the next interceptor in chain or invoking the</span>
<span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
<span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
<span class="sd">            The interceptor can use</span>
<span class="sd">            `response_iterator = continuation(client_call_details, request)`</span>
<span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
<span class="sd">            both a Call for the RPC and an iterator for response values.</span>
<span class="sd">            Drawing response values from the returned Call-iterator may</span>
<span class="sd">            raise RpcError indicating termination of the RPC with non-OK</span>
<span class="sd">            status.</span>
<span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
<span class="sd">            outgoing RPC.</span>
<span class="sd">          request: The request value 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</span>
<span class="sd">            response values. Drawing response values from the returned</span>
<span class="sd">            Call-iterator may raise RpcError indicating termination of</span>
<span class="sd">            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="StreamUnaryClientInterceptor"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryClientInterceptor</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 intercepting stream-unary invocations.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="StreamUnaryClientInterceptor.intercept_stream_unary"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryClientInterceptor.intercept_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">intercept_stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">,</span> <span class="n">client_call_details</span><span class="p">,</span>
                               <span class="n">request_iterator</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Intercepts a stream-unary invocation asynchronously.</span>

<span class="sd">        Args:</span>
<span class="sd">          continuation: A function that proceeds with the invocation by</span>
<span class="sd">            executing the next interceptor in chain or invoking the</span>
<span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
<span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
<span class="sd">            The interceptor can use</span>
<span class="sd">            `response_future = continuation(client_call_details, request_iterator)`</span>
<span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
<span class="sd">            both a Call for the RPC and a Future. In the event of RPC completion,</span>
<span class="sd">            the return Call-Future&#39;s result value will be the response message</span>
<span class="sd">            of the RPC. Should the event terminate with non-OK status, the</span>
<span class="sd">            returned Call-Future&#39;s exception value will be an RpcError.</span>
<span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
<span class="sd">            outgoing RPC.</span>
<span class="sd">          request_iterator: An iterator that yields request values 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.</span>
<span class="sd">          In the event of RPC completion, the return Call-Future&#39;s</span>
<span class="sd">          result value will be the response message of the RPC.</span>
<span class="sd">          Should the event terminate with non-OK status, the returned</span>
<span class="sd">          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="StreamStreamClientInterceptor"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamClientInterceptor</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 intercepting stream-stream invocations.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="StreamStreamClientInterceptor.intercept_stream_stream"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamClientInterceptor.intercept_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">intercept_stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">,</span> <span class="n">client_call_details</span><span class="p">,</span>
                                <span class="n">request_iterator</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Intercepts a stream-stream invocation.</span>

<span class="sd">        Args:</span>
<span class="sd">          continuation: A function that proceeds with the invocation by</span>
<span class="sd">            executing the next interceptor in chain or invoking the</span>
<span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
<span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
<span class="sd">            The interceptor can use</span>
<span class="sd">            `response_iterator = continuation(client_call_details, request_iterator)`</span>
<span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
<span class="sd">            both a Call for the RPC and an iterator for response values.</span>
<span class="sd">            Drawing response values from the returned Call-iterator may</span>
<span class="sd">            raise RpcError indicating termination of the RPC with non-OK</span>
<span class="sd">            status.</span>
<span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
<span class="sd">            outgoing RPC.</span>
<span class="sd">          request_iterator: An iterator that yields request values 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</span>
<span class="sd">          response values. Drawing response values from the returned</span>
<span class="sd">          Call-iterator may raise RpcError indicating termination of</span>
<span class="sd">          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">############  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 of this class and</span>
<span class="sd">    secure_channel requires 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 call.</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;Passes to the gRPC runtime authentication metadata for an RPC.</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</span>
<span class="sd">            the plugin is being called to authenticate.</span>
<span class="sd">          callback: An AuthMetadataPluginCallback to be invoked either</span>
<span class="sd">            synchronously 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>


<div class="viewcode-block" id="ServerCertificateConfiguration"><a class="viewcode-back" href="../grpc.html#grpc.ServerCertificateConfiguration">[docs]</a><span class="k">class</span> <span class="nc">ServerCertificateConfiguration</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A certificate configuration for use with an SSL-enabled Server.</span>

<span class="sd">    Instances of this class can be returned in the certificate configuration</span>
<span class="sd">    fetching callback.</span>

<span class="sd">    This class has no supported interface -- it exists to define the</span>
<span class="sd">    type of its instances and its instances exist to be passed to</span>
<span class="sd">    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">certificate_configuration</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_certificate_configuration</span> <span class="o">=</span> <span class="n">certificate_configuration</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="n">wait_for_ready</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</span>
<span class="sd">            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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</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="n">wait_for_ready</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</span>
<span class="sd">            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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</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="n">wait_for_ready</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</span>
<span class="sd">            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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</span>

<span class="sd">        Returns:</span>
<span class="sd">            An object that is both a Call for the RPC and a Future.</span>
<span class="sd">            In the event of RPC completion, the return Call-Future&#39;s result</span>
<span class="sd">            value will be the response message of the RPC.</span>
<span class="sd">            Should the event terminate with non-OK status,</span>
<span class="sd">            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="n">wait_for_ready</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</span>
<span class="sd">            the RPC. 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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</span>

<span class="sd">        Returns:</span>
<span class="sd">            An object that is both a Call for the RPC and an iterator of</span>
<span class="sd">            response values. Drawing response values from the returned</span>
<span class="sd">            Call-iterator may raise RpcError indicating termination of the</span>
<span class="sd">            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="n">wait_for_ready</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</span>
<span class="sd">            the RPC.</span>
<span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
<span class="sd">            the RPC. 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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</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="n">wait_for_ready</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</span>
<span class="sd">            the RPC.</span>
<span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
<span class="sd">            the RPC. 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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</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="n">wait_for_ready</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</span>
<span class="sd">            the RPC. 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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</span>

<span class="sd">        Returns:</span>
<span class="sd">            An object that is both a Call for the RPC and a Future.</span>
<span class="sd">            In the event of RPC completion, the return Call-Future&#39;s result value</span>
<span class="sd">            will be the response message of the RPC. Should the event terminate</span>
<span class="sd">            with non-OK status, the returned Call-Future&#39;s exception value will</span>
<span class="sd">            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="n">wait_for_ready</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</span>
<span class="sd">            the RPC. 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">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
<span class="sd">            flag to enable wait for ready mechanism</span>

<span class="sd">        Returns:</span>
<span class="sd">            An object that is both a Call for the RPC and an iterator of</span>
<span class="sd">            response values. Drawing response values from the returned</span>
<span class="sd">            Call-iterator may raise RpcError indicating termination of the</span>
<span class="sd">            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.</span>

<span class="sd">    Channel objects implement the Context Manager type, although they need not</span>
<span class="sd">    support being entered and exited multiple times.</span>
<span class="sd">    &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</span>
<span class="sd">            and again for every change to ChannelConnectivity until it</span>
<span class="sd">            is unsubscribed or this Channel object goes out of scope.</span>
<span class="sd">          try_to_connect: A boolean indicating whether or not this Channel</span>
<span class="sd">            should attempt to connect immediately. If set to False, gRPC</span>
<span class="sd">            runtime decides 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</span>
<span class="sd">          having 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</span>
<span class="sd">            response message. Response goes undeserialized in case None</span>
<span class="sd">            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</span>
<span class="sd">            response message. Response goes undeserialized in case None is</span>
<span class="sd">            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</span>
<span class="sd">            response message. Response goes undeserialized in case None is</span>
<span class="sd">            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</span>
<span class="sd">            response message. Response goes undeserialized in case None</span>
<span class="sd">            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 class="viewcode-block" id="Channel.close"><a class="viewcode-back" href="../grpc.html#grpc.Channel.close">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Closes this Channel and releases all resources held by it.</span>

<span class="sd">        Closing the Channel will immediately terminate all RPCs active with the</span>
<span class="sd">        Channel and it is not valid to invoke new RPCs with the Channel.</span>

<span class="sd">        This method is 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>


<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(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</span>
<span class="sd">          authenticated. 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.abort"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.abort">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">abort</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="n">details</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Raises an exception to terminate the RPC with a non-OK status.</span>

<span class="sd">        The code and details passed as arguments will supercede any existing</span>
<span class="sd">        ones.</span>

<span class="sd">        Args:</span>
<span class="sd">          code: A StatusCode object to be sent to the client.</span>
<span class="sd">            It must not be StatusCode.OK.</span>
<span class="sd">          details: An ASCII-encodable string to be sent to the client upon</span>
<span class="sd">            termination of the RPC.</span>

<span class="sd">        Raises:</span>
<span class="sd">          Exception: An exception is always raised to signal the abortion the</span>
<span class="sd">            RPC to the 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.abort_with_status"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.abort_with_status">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    <span class="k">def</span> <span class="nf">abort_with_status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Raises an exception to terminate the RPC with a non-OK status.</span>

<span class="sd">        The status passed as argument will supercede any existing status code,</span>
<span class="sd">        status message and trailing metadata.</span>

<span class="sd">        This is an EXPERIMENTAL API.</span>

<span class="sd">        Args:</span>
<span class="sd">          status: A grpc.Status object. The status code in it must not be</span>
<span class="sd">            StatusCode.OK.</span>

<span class="sd">        Raises:</span>
<span class="sd">          Exception: An exception is always raised to signal the abortion the</span>
<span class="sd">            RPC to the 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.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</span>
<span class="sd">        the 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</span>
<span class="sd">        no details to transmit.</span>

<span class="sd">        Args:</span>
<span class="sd">          details: An ASCII-encodable string to be sent to the client upon</span>
<span class="sd">            termination 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">#####################  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</span>
<span class="sd">        or any arbitrary number of request messages.</span>
<span class="sd">      response_streaming: Whether the RPC supports exactly one response message</span>
<span class="sd">        or 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</span>
<span class="sd">        logic, or None to indicate that this object&#39;s business logic should be</span>
<span class="sd">        passed the raw request bytes.</span>
<span class="sd">      response_serializer: A callable behavior that accepts an object produced</span>
<span class="sd">        by 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</span>
<span class="sd">        callable value that takes a request value and a ServicerContext object</span>
<span class="sd">        and returns a response value. Only non-None if both request_streaming</span>
<span class="sd">        and 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</span>
<span class="sd">        and returns an iterator of response values. Only non-None if</span>
<span class="sd">        request_streaming 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.</span>
<span class="sd">        Only non-None if request_streaming and response_streaming are both</span>
<span class="sd">        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">####################  Service-Side Interceptor Interfaces  #####################</span>


<div class="viewcode-block" id="ServerInterceptor"><a class="viewcode-back" href="../grpc.html#grpc.ServerInterceptor">[docs]</a><span class="k">class</span> <span class="nc">ServerInterceptor</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 intercepting incoming RPCs on the service-side.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="ServerInterceptor.intercept_service"><a class="viewcode-back" href="../grpc.html#grpc.ServerInterceptor.intercept_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">intercept_service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">,</span> <span class="n">handler_call_details</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Intercepts incoming RPCs before handing them over to a handler.</span>

<span class="sd">        Args:</span>
<span class="sd">          continuation: A function that takes a HandlerCallDetails and</span>
<span class="sd">            proceeds to invoke the next interceptor in the chain, if any,</span>
<span class="sd">            or the RPC handler lookup logic, with the call details passed</span>
<span class="sd">            as an argument, and returns an RpcMethodHandler instance if</span>
<span class="sd">            the RPC is considered serviced, or None otherwise.</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">          interceptor 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>


<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</span>
<span class="sd">          used 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</span>
<span class="sd">            runtime 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 (by passing None for `grace`),</span>
<span class="sd">        all existing RPCs are aborted immediately and this method</span>
<span class="sd">        blocks until the last RPC handler terminates.</span>

<span class="sd">        This method is idempotent and may be called at any time.</span>
<span class="sd">        Passing a smaller grace value in a subsequent call will have</span>
<span class="sd">        the effect of stopping the Server sooner (passing None will</span>
<span class="sd">        have the effect of stopping the server immediately). Passing</span>
<span class="sd">        a larger grace value in a subsequent call *will not* have the</span>
<span class="sd">        effect of stopping the server later (i.e. the most restrictive</span>
<span class="sd">        grace 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</span>
<span class="sd">        and returns 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</span>
<span class="sd">        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">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</span>
<span class="sd">        request 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</span>
<span class="sd">        request 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</span>
<span class="sd">        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</span>
<span class="sd">        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">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
        <span class="n">_cygrpc</span><span class="o">.</span><span class="n">SSLChannelCredentials</span><span class="p">(</span><span class="n">root_certificates</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></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">return</span> <span class="n">_plugin_wrapping</span><span class="o">.</span><span class="n">metadata_plugin_call_credentials</span><span class="p">(</span>
        <span class="n">metadata_plugin</span><span class="p">,</span> <span class="n">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="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">return</span> <span class="n">_plugin_wrapping</span><span class="o">.</span><span class="n">metadata_plugin_call_credentials</span><span class="p">(</span>
        <span class="n">_auth</span><span class="o">.</span><span class="n">AccessTokenAuthMetadataPlugin</span><span class="p">(</span><span class="n">access_token</span><span class="p">),</span> <span class="kc">None</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="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
        <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeCallCredentials</span><span class="p">(</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></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="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
        <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeChannelCredentials</span><span class="p">(</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="n">channel_credentials</span><span class="o">.</span><span class="n">_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="ow">not</span> <span class="n">private_key_certificate_chain_pairs</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="ssl_server_certificate_configuration"><a class="viewcode-back" href="../grpc.html#grpc.ssl_server_certificate_configuration">[docs]</a><span class="k">def</span> <span class="nf">ssl_server_certificate_configuration</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="sd">&quot;&quot;&quot;Creates a ServerCertificateConfiguration for use with a Server.</span>

<span class="sd">    Args:</span>
<span class="sd">      private_key_certificate_chain_pairs: A collection of pairs of</span>
<span class="sd">        the form [PEM-encoded private key, PEM-encoded certificate</span>
<span class="sd">        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">    Returns:</span>
<span class="sd">      A ServerCertificateConfiguration that can be returned in the certificate</span>
<span class="sd">        configuration fetching callback.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="n">private_key_certificate_chain_pairs</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">ServerCertificateConfiguration</span><span class="p">(</span>
            <span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_certificate_config_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="k">else</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></div>


<div class="viewcode-block" id="dynamic_ssl_server_credentials"><a class="viewcode-back" href="../grpc.html#grpc.dynamic_ssl_server_credentials">[docs]</a><span class="k">def</span> <span class="nf">dynamic_ssl_server_credentials</span><span class="p">(</span><span class="n">initial_certificate_configuration</span><span class="p">,</span>
                                   <span class="n">certificate_configuration_fetcher</span><span class="p">,</span>
                                   <span class="n">require_client_authentication</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">      initial_certificate_configuration (ServerCertificateConfiguration): The</span>
<span class="sd">        certificate configuration with which the server will be initialized.</span>
<span class="sd">      certificate_configuration_fetcher (callable): A callable that takes no</span>
<span class="sd">        arguments and should return a ServerCertificateConfiguration to</span>
<span class="sd">        replace the server&#39;s current certificate, or None for no change</span>
<span class="sd">        (i.e., the server will continue its current certificate</span>
<span class="sd">        config). The library will call this callback on *every* new</span>
<span class="sd">        client connection before starting the TLS handshake with the</span>
<span class="sd">        client, thus allowing the user application to optionally</span>
<span class="sd">        return a new ServerCertificateConfiguration that the server will then</span>
<span class="sd">        use for the handshake.</span>
<span class="sd">      require_client_authentication: A boolean indicating whether or not to</span>
<span class="sd">        require clients to be authenticated.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A ServerCredentials.</span>
<span class="sd">    &quot;&quot;&quot;</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_dynamic_cert_config</span><span class="p">(</span>
            <span class="n">initial_certificate_configuration</span><span class="p">,</span>
            <span class="n">certificate_configuration_fetcher</span><span class="p">,</span> <span class="n">require_client_authentication</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">    The returned Channel is thread-safe.</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</span>
<span class="sd">        in gRPC Core runtime) to configure the channel.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A Channel.</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">    The returned Channel is thread-safe.</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</span>
<span class="sd">        in gRPC Core runtime) to configure the channel.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A Channel.</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="intercept_channel"><a class="viewcode-back" href="../grpc.html#grpc.intercept_channel">[docs]</a><span class="k">def</span> <span class="nf">intercept_channel</span><span class="p">(</span><span class="n">channel</span><span class="p">,</span> <span class="o">*</span><span class="n">interceptors</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Intercepts a channel through a set of interceptors.</span>

<span class="sd">    This is an EXPERIMENTAL API.</span>

<span class="sd">    Args:</span>
<span class="sd">      channel: A Channel.</span>
<span class="sd">      interceptors: Zero or more objects of type</span>
<span class="sd">        UnaryUnaryClientInterceptor,</span>
<span class="sd">        UnaryStreamClientInterceptor,</span>
<span class="sd">        StreamUnaryClientInterceptor, or</span>
<span class="sd">        StreamStreamClientInterceptor.</span>
<span class="sd">        Interceptors are given control in the order they are listed.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A Channel that intercepts each invocation via the provided interceptors.</span>

<span class="sd">    Raises:</span>
<span class="sd">      TypeError: If interceptor does not derive from any of</span>
<span class="sd">        UnaryUnaryClientInterceptor,</span>
<span class="sd">        UnaryStreamClientInterceptor,</span>
<span class="sd">        StreamUnaryClientInterceptor, or</span>
<span class="sd">        StreamStreamClientInterceptor.</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">_interceptor</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    <span class="k">return</span> <span class="n">_interceptor</span><span class="o">.</span><span class="n">intercept_channel</span><span class="p">(</span><span class="n">channel</span><span class="p">,</span> <span class="o">*</span><span class="n">interceptors</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">interceptors</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">      interceptors: An optional list of ServerInterceptor objects that observe</span>
<span class="sd">        and optionally manipulate the incoming RPCs before handing them over to</span>
<span class="sd">        handlers. The interceptors are given control in the order they are</span>
<span class="sd">        specified. This is an EXPERIMENTAL API.</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">create_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">interceptors</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">interceptors</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;Status&#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;ClientCallDetails&#39;</span><span class="p">,</span>
    <span class="s1">&#39;ServerCertificateConfiguration&#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;UnaryUnaryClientInterceptor&#39;</span><span class="p">,</span>
    <span class="s1">&#39;UnaryStreamClientInterceptor&#39;</span><span class="p">,</span>
    <span class="s1">&#39;StreamUnaryClientInterceptor&#39;</span><span class="p">,</span>
    <span class="s1">&#39;StreamStreamClientInterceptor&#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;ServerInterceptor&#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;ssl_server_certificate_configuration&#39;</span><span class="p">,</span>
    <span class="s1">&#39;dynamic_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;intercept_channel&#39;</span><span class="p">,</span>
    <span class="s1">&#39;server&#39;</span><span class="p">,</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>
      </div>
    <div class="clearer"></div>
  </div>
    <div class="footer">
      &copy;2018, The gRPC Authors.
      
    </div>

    
    <script type="text/javascript">

      var _gaq = _gaq || [];
      _gaq.push(['_setAccount', 'UA-60127042-1']);
      _gaq.push(['_setDomainName', 'none']);
      _gaq.push(['_setAllowLinker', true]);
      _gaq.push(['_trackPageview']);

      (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
      })();

    </script>
    
  </body>
</html>