Etusivu Tutki Apua
Kirjaudu sisään
carto
/
grpc
2
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Haara: gh-pages
Haarat Tagit
grpc
/
python
/
_modules
/
grpc.html

grpc.html 194 KB
Pysyvä linkki Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292 
  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html lang="en">
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8" />
    7. 

  7.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    8. 

  8.     <title>grpc &#8212; gRPC Python 1.36.1 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    11. 

  11.     <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    12. 

  12.     <script src="../_static/jquery.js"></script>
    13. 

  13.     <script src="../_static/underscore.js"></script>
    14. 

  14.     <script src="../_static/doctools.js"></script>
    15. 

  15.     <link rel="index" title="Index" href="../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../search.html" />
    17. 

  17.    
    18. 

  18.   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    19. 

  19.   
    20. 

  20.   
    21. 

  21.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    22. 

  22. 

  23.   </head><body>
    24. 

  24.   <div class="document">
    25. 

  25.     
    26. 

  26.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    27. 

  27.         <div class="sphinxsidebarwrapper">
    28. 

  28. <h1 class="logo"><a href="../index.html">gRPC Python</a></h1>
    29. 

  29. 

  30. 

  31. 

  32. <p class="blurb">1.36.1</p>
    33. 

  33. 

  34. 

  35. 

  36. 

  37. 

  38. 

  39. <h3>Navigation</h3>
    40. 

  40. <p class="caption"><span class="caption-text">Contents:</span></p>
    41. 

  41. <ul>
    42. 

  42. <li class="toctree-l1"><a class="reference internal" href="../grpc.html">gRPC</a></li>
    43. 

  43. <li class="toctree-l1"><a class="reference internal" href="../grpc_asyncio.html">gRPC AsyncIO API</a></li>
    44. 

  44. <li class="toctree-l1"><a class="reference internal" href="../grpc_channelz.html">gRPC Channelz</a></li>
    45. 

  45. <li class="toctree-l1"><a class="reference internal" href="../grpc_health_checking.html">gRPC Health Checking</a></li>
    46. 

  46. <li class="toctree-l1"><a class="reference internal" href="../grpc_reflection.html">gRPC Reflection</a></li>
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="../grpc_status.html">gRPC Status</a></li>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="../grpc_testing.html">gRPC Testing</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
    50. 

  50. </ul>
    51. 

  51. 

  52. <div class="relations">
    53. 

  53. <h3>Related Topics</h3>
    54. 

  54. <ul>
    55. 

  55.   <li><a href="../index.html">Documentation overview</a><ul>
    56. 

  56.   <li><a href="index.html">Module code</a><ul>
    57. 

  57.   </ul></li>
    58. 

  58.   </ul></li>
    59. 

  59. </ul>
    60. 

  60. </div>
    61. 

  61. <div id="searchbox" style="display: none" role="search">
    62. 

  62.   <h3 id="searchlabel">Quick search</h3>
    63. 

  63.     <div class="searchformwrapper">
    64. 

  64.     <form class="search" action="../search.html" method="get">
    65. 

  65.       <input type="text" name="q" aria-labelledby="searchlabel" />
    66. 

  66.       <input type="submit" value="Go" />
    67. 

  67.     </form>
    68. 

  68.     </div>
    69. 

  69. </div>
    70. 

  70. <script>$('#searchbox').show(0);</script>
    71. 

  71. 

  72. 

  73. 

  74. 

  75. 

  76. 

  77. 

  78. 

  79.         </div>
    80. 

  80.       </div>
    81. 

  81.       <div class="documentwrapper">
    82. 

  82.         <div class="bodywrapper">
    83. 

  83.           
    84. 

  84. 

  85.           <div class="body" role="main">
    86. 

  86.             
    87. 

  87.   <h1>Source code for grpc</h1><div class="highlight"><pre>
    88. 

  88. <span></span><span class="c1"># Copyright 2015-2016 gRPC authors.</span>
    89. 

  89. <span class="c1">#</span>
    90. 

  90. <span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
    91. 

  91. <span class="c1"># you may not use this file except in compliance with the License.</span>
    92. 

  92. <span class="c1"># You may obtain a copy of the License at</span>
    93. 

  93. <span class="c1">#</span>
    94. 

  94. <span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
    95. 

  95. <span class="c1">#</span>
    96. 

  96. <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
    97. 

  97. <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
    98. 

  98. <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
    99. 

  99. <span class="c1"># See the License for the specific language governing permissions and</span>
    100. 

  100. <span class="c1"># limitations under the License.</span>
    101. 

  101. <span class="sd">&quot;&quot;&quot;gRPC&#39;s Python API.&quot;&quot;&quot;</span>
    102. 

  102. 

  103. <span class="kn">import</span> <span class="nn">abc</span>
    104. 

  104. <span class="kn">import</span> <span class="nn">contextlib</span>
    105. 

  105. <span class="kn">import</span> <span class="nn">enum</span>
    106. 

  106. <span class="kn">import</span> <span class="nn">logging</span>
    107. 

  107. <span class="kn">import</span> <span class="nn">sys</span>
    108. 

  108. <span class="kn">import</span> <span class="nn">six</span>
    109. 

  109. 

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

  111. <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_compression</span>
    112. 

  112. 

  113. <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>
    114. 

  114. 

  115. <span class="k">try</span><span class="p">:</span>
    116. 

  116.     <span class="kn">from</span> <span class="nn">grpc._grpcio_metadata</span> <span class="kn">import</span> <span class="n">__version__</span>
    117. 

  117. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    118. 

  118.     <span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;dev0&quot;</span>
    119. 

  119. 

  120. <span class="c1">############################## Future Interface  ###############################</span>
    121. 

  121. 

  122. 

  123. <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>
    124. 

  124.     <span class="sd">&quot;&quot;&quot;Indicates that a method call on a Future timed out.&quot;&quot;&quot;</span></div>
    125. 

  125. 

  126. 

  127. <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>
    128. 

  128.     <span class="sd">&quot;&quot;&quot;Indicates that the computation underlying a Future was cancelled.&quot;&quot;&quot;</span></div>
    129. 

  129. 

  130. 

  131. <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>
    132. 

  132.     <span class="sd">&quot;&quot;&quot;A representation of a computation in another control flow.</span>
    133. 

  133. 

  134. <span class="sd">    Computations represented by a Future may be yet to be begun,</span>
    135. 

  135. <span class="sd">    may be ongoing, or may have already completed.</span>
    136. 

  136. <span class="sd">    &quot;&quot;&quot;</span>
    137. 

  137. 

  138. <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>
    139. 

  139.     <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    140. 

  140.         <span class="sd">&quot;&quot;&quot;Attempts to cancel the computation.</span>
    141. 

  141. 

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

  143. 

  144. <span class="sd">        Returns:</span>
    145. 

  145. <span class="sd">            bool:</span>
    146. 

  146. <span class="sd">            Returns True if the computation was canceled.</span>
    147. 

  147. 

  148. <span class="sd">            Returns False under all other circumstances, for example:</span>
    149. 

  149. 

  150. <span class="sd">            1. computation has begun and could not be canceled.</span>
    151. 

  151. <span class="sd">            2. computation has finished</span>
    152. 

  152. <span class="sd">            3. computation is scheduled for execution and it is impossible</span>
    153. 

  153. <span class="sd">                to determine its state without blocking.</span>
    154. 

  154. <span class="sd">        &quot;&quot;&quot;</span>
    155. 

  155.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    156. 

  156. 

  157. <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>
    158. 

  158.     <span class="k">def</span> <span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    159. 

  159.         <span class="sd">&quot;&quot;&quot;Describes whether the computation was cancelled.</span>
    160. 

  160. 

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

  162. 

  163. <span class="sd">        Returns:</span>
    164. 

  164. <span class="sd">            bool:</span>
    165. 

  165. <span class="sd">            Returns True if the computation was cancelled before its result became</span>
    166. 

  166. <span class="sd">            available.</span>
    167. 

  167. 

  168. <span class="sd">            Returns False under all other circumstances, for example:</span>
    169. 

  169. 

  170. <span class="sd">            1. computation was not cancelled.</span>
    171. 

  171. <span class="sd">            2. computation&#39;s result is available.</span>
    172. 

  172. <span class="sd">        &quot;&quot;&quot;</span>
    173. 

  173.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    174. 

  174. 

  175. <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>
    176. 

  176.     <span class="k">def</span> <span class="nf">running</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    177. 

  177.         <span class="sd">&quot;&quot;&quot;Describes whether the computation is taking place.</span>
    178. 

  178. 

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

  180. 

  181. <span class="sd">        Returns:</span>
    182. 

  182. <span class="sd">            Returns True if the computation is scheduled for execution or</span>
    183. 

  183. <span class="sd">            currently executing.</span>
    184. 

  184. 

  185. <span class="sd">            Returns False if the computation already executed or was cancelled.</span>
    186. 

  186. <span class="sd">        &quot;&quot;&quot;</span>
    187. 

  187.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    188. 

  188. 

  189. <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>
    190. 

  190.     <span class="k">def</span> <span class="nf">done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    191. 

  191.         <span class="sd">&quot;&quot;&quot;Describes whether the computation has taken place.</span>
    192. 

  192. 

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

  194. 

  195. <span class="sd">        Returns:</span>
    196. 

  196. <span class="sd">            bool:</span>
    197. 

  197. <span class="sd">            Returns True if the computation already executed or was cancelled.</span>
    198. 

  198. <span class="sd">            Returns False if the computation is scheduled for execution or</span>
    199. 

  199. <span class="sd">            currently executing.</span>
    200. 

  200. <span class="sd">            This is exactly opposite of the running() method&#39;s result.</span>
    201. 

  201. <span class="sd">        &quot;&quot;&quot;</span>
    202. 

  202.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    203. 

  203. 

  204. <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>
    205. 

  205.     <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>
    206. 

  206.         <span class="sd">&quot;&quot;&quot;Returns the result of the computation or raises its exception.</span>
    207. 

  207. 

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

  209. 

  210. <span class="sd">        Args:</span>
    211. 

  211. <span class="sd">          timeout: The length of time in seconds to wait for the computation to</span>
    212. 

  212. <span class="sd">            finish or be cancelled. If None, the call will block until the</span>
    213. 

  213. <span class="sd">            computations&#39;s termination.</span>
    214. 

  214. 

  215. <span class="sd">        Returns:</span>
    216. 

  216. <span class="sd">          The return value of the computation.</span>
    217. 

  217. 

  218. <span class="sd">        Raises:</span>
    219. 

  219. <span class="sd">          FutureTimeoutError: If a timeout value is passed and the computation</span>
    220. 

  220. <span class="sd">            does not terminate within the allotted time.</span>
    221. 

  221. <span class="sd">          FutureCancelledError: If the computation was cancelled.</span>
    222. 

  222. <span class="sd">          Exception: If the computation raised an exception, this call will</span>
    223. 

  223. <span class="sd">            raise the same exception.</span>
    224. 

  224. <span class="sd">        &quot;&quot;&quot;</span>
    225. 

  225.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    226. 

  226. 

  227. <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>
    228. 

  228.     <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>
    229. 

  229.         <span class="sd">&quot;&quot;&quot;Return the exception raised by the computation.</span>
    230. 

  230. 

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

  232. 

  233. <span class="sd">        Args:</span>
    234. 

  234. <span class="sd">          timeout: The length of time in seconds to wait for the computation to</span>
    235. 

  235. <span class="sd">            terminate or be cancelled. If None, the call will block until the</span>
    236. 

  236. <span class="sd">            computations&#39;s termination.</span>
    237. 

  237. 

  238. <span class="sd">        Returns:</span>
    239. 

  239. <span class="sd">            The exception raised by the computation, or None if the computation</span>
    240. 

  240. <span class="sd">            did not raise an exception.</span>
    241. 

  241. 

  242. <span class="sd">        Raises:</span>
    243. 

  243. <span class="sd">          FutureTimeoutError: If a timeout value is passed and the computation</span>
    244. 

  244. <span class="sd">            does not terminate within the allotted time.</span>
    245. 

  245. <span class="sd">          FutureCancelledError: If the computation was cancelled.</span>
    246. 

  246. <span class="sd">        &quot;&quot;&quot;</span>
    247. 

  247.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    248. 

  248. 

  249. <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>
    250. 

  250.     <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>
    251. 

  251.         <span class="sd">&quot;&quot;&quot;Access the traceback of the exception raised by the computation.</span>
    252. 

  252. 

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

  254. 

  255. <span class="sd">        Args:</span>
    256. 

  256. <span class="sd">          timeout: The length of time in seconds to wait for the computation</span>
    257. 

  257. <span class="sd">            to terminate or be cancelled. If None, the call will block until</span>
    258. 

  258. <span class="sd">            the computation&#39;s termination.</span>
    259. 

  259. 

  260. <span class="sd">        Returns:</span>
    261. 

  261. <span class="sd">            The traceback of the exception raised by the computation, or None</span>
    262. 

  262. <span class="sd">            if the computation did not raise an exception.</span>
    263. 

  263. 

  264. <span class="sd">        Raises:</span>
    265. 

  265. <span class="sd">          FutureTimeoutError: If a timeout value is passed and the computation</span>
    266. 

  266. <span class="sd">            does not terminate within the allotted time.</span>
    267. 

  267. <span class="sd">          FutureCancelledError: If the computation was cancelled.</span>
    268. 

  268. <span class="sd">        &quot;&quot;&quot;</span>
    269. 

  269.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    270. 

  270. 

  271. <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>
    272. 

  272.     <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>
    273. 

  273.         <span class="sd">&quot;&quot;&quot;Adds a function to be called at completion of the computation.</span>
    274. 

  274. 

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

  276. <span class="sd">        of the computation.  Callbacks will be invoked after the future is</span>
    277. 

  277. <span class="sd">        terminated, whether successfully or not.</span>
    278. 

  278. 

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

  280. <span class="sd">        immediately.</span>
    281. 

  281. 

  282. <span class="sd">        Exceptions raised in the callback will be logged at ERROR level, but</span>
    283. 

  283. <span class="sd">        will not terminate any threads of execution.</span>
    284. 

  284. 

  285. <span class="sd">        Args:</span>
    286. 

  286. <span class="sd">          fn: A callable taking this Future object as its single parameter.</span>
    287. 

  287. <span class="sd">        &quot;&quot;&quot;</span>
    288. 

  288.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    289. 

  289. 

  290. 

  291. <span class="c1">################################  gRPC Enums  ##################################</span>
    292. 

  292. 

  293. 

  294. <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>
    295. 

  295. <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>
    296. 

  296.     <span class="sd">&quot;&quot;&quot;Mirrors grpc_connectivity_state in the gRPC Core.</span>
    297. 

  297. 

  298. <span class="sd">    Attributes:</span>
    299. 

  299. <span class="sd">      IDLE: The channel is idle.</span>
    300. 

  300. <span class="sd">      CONNECTING: The channel is connecting.</span>
    301. 

  301. <span class="sd">      READY: The channel is ready to conduct RPCs.</span>
    302. 

  302. <span class="sd">      TRANSIENT_FAILURE: The channel has seen a failure from which it expects</span>
    303. 

  303. <span class="sd">        to recover.</span>
    304. 

  304. <span class="sd">      SHUTDOWN: The channel has seen a failure from which it cannot recover.</span>
    305. 

  305. <span class="sd">    &quot;&quot;&quot;</span>
    306. 

  306.     <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>
    307. 

  307.     <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>
    308. 

  308.     <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>
    309. 

  309.     <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>
    310. 

  310.                          <span class="s1">&#39;transient failure&#39;</span><span class="p">)</span>
    311. 

  311.     <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>
    312. 

  312. 

  313. 

  314. <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>
    315. 

  315. <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>
    316. 

  316.     <span class="sd">&quot;&quot;&quot;Mirrors grpc_status_code in the gRPC Core.</span>
    317. 

  317. 

  318. <span class="sd">    Attributes:</span>
    319. 

  319. <span class="sd">      OK: Not an error; returned on success</span>
    320. 

  320. <span class="sd">      CANCELLED: The operation was cancelled (typically by the caller).</span>
    321. 

  321. <span class="sd">      UNKNOWN: Unknown error.</span>
    322. 

  322. <span class="sd">      INVALID_ARGUMENT: Client specified an invalid argument.</span>
    323. 

  323. <span class="sd">      DEADLINE_EXCEEDED: Deadline expired before operation could complete.</span>
    324. 

  324. <span class="sd">      NOT_FOUND: Some requested entity (e.g., file or directory) was not found.</span>
    325. 

  325. <span class="sd">      ALREADY_EXISTS: Some entity that we attempted to create (e.g., file or directory)</span>
    326. 

  326. <span class="sd">        already exists.</span>
    327. 

  327. <span class="sd">      PERMISSION_DENIED: The caller does not have permission to execute the specified</span>
    328. 

  328. <span class="sd">        operation.</span>
    329. 

  329. <span class="sd">      UNAUTHENTICATED: The request does not have valid authentication credentials for the</span>
    330. 

  330. <span class="sd">        operation.</span>
    331. 

  331. <span class="sd">      RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user quota, or</span>
    332. 

  332. <span class="sd">        perhaps the entire file system is out of space.</span>
    333. 

  333. <span class="sd">      FAILED_PRECONDITION: Operation was rejected because the system is not in a state</span>
    334. 

  334. <span class="sd">        required for the operation&#39;s execution.</span>
    335. 

  335. <span class="sd">      ABORTED: The operation was aborted, typically due to a concurrency issue</span>
    336. 

  336. <span class="sd">        like sequencer check failures, transaction aborts, etc.</span>
    337. 

  337. <span class="sd">      UNIMPLEMENTED: Operation is not implemented or not supported/enabled in this service.</span>
    338. 

  338. <span class="sd">      INTERNAL: Internal errors.  Means some invariants expected by underlying</span>
    339. 

  339. <span class="sd">        system has been broken.</span>
    340. 

  340. <span class="sd">      UNAVAILABLE: The service is currently unavailable.</span>
    341. 

  341. <span class="sd">      DATA_LOSS: Unrecoverable data loss or corruption.</span>
    342. 

  342. <span class="sd">    &quot;&quot;&quot;</span>
    343. 

  343.     <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>
    344. 

  344.     <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>
    345. 

  345.     <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>
    346. 

  346.     <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>
    347. 

  347.     <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>
    348. 

  348.                          <span class="s1">&#39;deadline exceeded&#39;</span><span class="p">)</span>
    349. 

  349.     <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>
    350. 

  350.     <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>
    351. 

  351.     <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>
    352. 

  352.                          <span class="s1">&#39;permission denied&#39;</span><span class="p">)</span>
    353. 

  353.     <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>
    354. 

  354.                           <span class="s1">&#39;resource exhausted&#39;</span><span class="p">)</span>
    355. 

  355.     <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>
    356. 

  356.                            <span class="s1">&#39;failed precondition&#39;</span><span class="p">)</span>
    357. 

  357.     <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>
    358. 

  358.     <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>
    359. 

  359.     <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>
    360. 

  360.     <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>
    361. 

  361.     <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>
    362. 

  362.     <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>
    363. 

  363.     <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>
    364. 

  364. 

  365. 

  366. <span class="c1">#############################  gRPC Status  ################################</span>
    367. 

  367. 

  368. 

  369. <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>
    370. 

  370.     <span class="sd">&quot;&quot;&quot;Describes the status of an RPC.</span>
    371. 

  371. 

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

  373. 

  374. <span class="sd">    Attributes:</span>
    375. 

  375. <span class="sd">      code: A StatusCode object to be sent to the client.</span>
    376. 

  376. <span class="sd">      details: A UTF-8-encodable string to be sent to the client upon</span>
    377. 

  377. <span class="sd">        termination of the RPC.</span>
    378. 

  378. <span class="sd">      trailing_metadata: The trailing :term:`metadata` in the RPC.</span>
    379. 

  379. <span class="sd">    &quot;&quot;&quot;</span>
    380. 

  380. 

  381. 

  382. <span class="c1">#############################  gRPC Exceptions  ################################</span>
    383. 

  383. 

  384. 

  385. <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>
    386. 

  386.     <span class="sd">&quot;&quot;&quot;Raised by the gRPC library to indicate non-OK-status RPC termination.&quot;&quot;&quot;</span></div>
    387. 

  387. 

  388. 

  389. <span class="c1">##############################  Shared Context  ################################</span>
    390. 

  390. 

  391. 

  392. <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>
    393. 

  393.     <span class="sd">&quot;&quot;&quot;Provides RPC-related information and action.&quot;&quot;&quot;</span>
    394. 

  394. 

  395. <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>
    396. 

  396.     <span class="k">def</span> <span class="nf">is_active</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    397. 

  397.         <span class="sd">&quot;&quot;&quot;Describes whether the RPC is active or has terminated.</span>
    398. 

  398. 

  399. <span class="sd">        Returns:</span>
    400. 

  400. <span class="sd">          bool:</span>
    401. 

  401. <span class="sd">          True if RPC is active, False otherwise.</span>
    402. 

  402. <span class="sd">        &quot;&quot;&quot;</span>
    403. 

  403.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    404. 

  404. 

  405. <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>
    406. 

  406.     <span class="k">def</span> <span class="nf">time_remaining</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    407. 

  407.         <span class="sd">&quot;&quot;&quot;Describes the length of allowed time remaining for the RPC.</span>
    408. 

  408. 

  409. <span class="sd">        Returns:</span>
    410. 

  410. <span class="sd">          A nonnegative float indicating the length of allowed time in seconds</span>
    411. 

  411. <span class="sd">          remaining for the RPC to complete before it is considered to have</span>
    412. 

  412. <span class="sd">          timed out, or None if no deadline was specified for the RPC.</span>
    413. 

  413. <span class="sd">        &quot;&quot;&quot;</span>
    414. 

  414.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    415. 

  415. 

  416. <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>
    417. 

  417.     <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    418. 

  418.         <span class="sd">&quot;&quot;&quot;Cancels the RPC.</span>
    419. 

  419. 

  420. <span class="sd">        Idempotent and has no effect if the RPC has already terminated.</span>
    421. 

  421. <span class="sd">        &quot;&quot;&quot;</span>
    422. 

  422.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    423. 

  423. 

  424. <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>
    425. 

  425.     <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>
    426. 

  426.         <span class="sd">&quot;&quot;&quot;Registers a callback to be called on RPC termination.</span>
    427. 

  427. 

  428. <span class="sd">        Args:</span>
    429. 

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

  430. 

  431. <span class="sd">        Returns:</span>
    432. 

  432. <span class="sd">          True if the callback was added and will be called later; False if</span>
    433. 

  433. <span class="sd">            the callback was not added and will not be called (because the RPC</span>
    434. 

  434. <span class="sd">            already terminated or some other reason).</span>
    435. 

  435. <span class="sd">        &quot;&quot;&quot;</span>
    436. 

  436.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    437. 

  437. 

  438. 

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

  440. 

  441. 

  442. <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>
    443. 

  443.     <span class="sd">&quot;&quot;&quot;Invocation-side utility object for an RPC.&quot;&quot;&quot;</span>
    444. 

  444. 

  445. <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>
    446. 

  446.     <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    447. 

  447.         <span class="sd">&quot;&quot;&quot;Accesses the initial metadata sent by the server.</span>
    448. 

  448. 

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

  450. 

  451. <span class="sd">        Returns:</span>
    452. 

  452. <span class="sd">          The initial :term:`metadata`.</span>
    453. 

  453. <span class="sd">        &quot;&quot;&quot;</span>
    454. 

  454.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    455. 

  455. 

  456. <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>
    457. 

  457.     <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    458. 

  458.         <span class="sd">&quot;&quot;&quot;Accesses the trailing metadata sent by the server.</span>
    459. 

  459. 

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

  461. 

  462. <span class="sd">        Returns:</span>
    463. 

  463. <span class="sd">          The trailing :term:`metadata`.</span>
    464. 

  464. <span class="sd">        &quot;&quot;&quot;</span>
    465. 

  465.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    466. 

  466. 

  467. <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>
    468. 

  468.     <span class="k">def</span> <span class="nf">code</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    469. 

  469.         <span class="sd">&quot;&quot;&quot;Accesses the status code sent by the server.</span>
    470. 

  470. 

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

  472. 

  473. <span class="sd">        Returns:</span>
    474. 

  474. <span class="sd">          The StatusCode value for the RPC.</span>
    475. 

  475. <span class="sd">        &quot;&quot;&quot;</span>
    476. 

  476.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    477. 

  477. 

  478. <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>
    479. 

  479.     <span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    480. 

  480.         <span class="sd">&quot;&quot;&quot;Accesses the details sent by the server.</span>
    481. 

  481. 

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

  483. 

  484. <span class="sd">        Returns:</span>
    485. 

  485. <span class="sd">          The details string of the RPC.</span>
    486. 

  486. <span class="sd">        &quot;&quot;&quot;</span>
    487. 

  487.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    488. 

  488. 

  489. 

  490. <span class="c1">##############  Invocation-Side Interceptor Interfaces &amp; Classes  ##############</span>
    491. 

  491. 

  492. 

  493. <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>
    494. 

  494.     <span class="sd">&quot;&quot;&quot;Describes an RPC to be invoked.</span>
    495. 

  495. 

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

  497. 

  498. <span class="sd">    Attributes:</span>
    499. 

  499. <span class="sd">      method: The method name of the RPC.</span>
    500. 

  500. <span class="sd">      timeout: An optional duration of time in seconds to allow for the RPC.</span>
    501. 

  501. <span class="sd">      metadata: Optional :term:`metadata` to be transmitted to</span>
    502. 

  502. <span class="sd">        the service-side of the RPC.</span>
    503. 

  503. <span class="sd">      credentials: An optional CallCredentials for the RPC.</span>
    504. 

  504. <span class="sd">      wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    505. 

  505. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    506. 

  506. <span class="sd">      compression: An element of grpc.compression, e.g.</span>
    507. 

  507. <span class="sd">        grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    508. 

  508. <span class="sd">    &quot;&quot;&quot;</span></div>
    509. 

  509. 

  510. 

  511. <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>
    512. 

  512.     <span class="sd">&quot;&quot;&quot;Affords intercepting unary-unary invocations.</span>
    513. 

  513. 

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

  515. <span class="sd">    &quot;&quot;&quot;</span>
    516. 

  516. 

  517. <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>
    518. 

  518.     <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>
    519. 

  519.         <span class="sd">&quot;&quot;&quot;Intercepts a unary-unary invocation asynchronously.</span>
    520. 

  520. 

  521. <span class="sd">        Args:</span>
    522. 

  522. <span class="sd">          continuation: A function that proceeds with the invocation by</span>
    523. 

  523. <span class="sd">            executing the next interceptor in chain or invoking the</span>
    524. 

  524. <span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
    525. 

  525. <span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
    526. 

  526. <span class="sd">            The interceptor can use</span>
    527. 

  527. <span class="sd">            `response_future = continuation(client_call_details, request)`</span>
    528. 

  528. <span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
    529. 

  529. <span class="sd">            both a Call for the RPC and a Future. In the event of RPC</span>
    530. 

  530. <span class="sd">            completion, the return Call-Future&#39;s result value will be</span>
    531. 

  531. <span class="sd">            the response message of the RPC. Should the event terminate</span>
    532. 

  532. <span class="sd">            with non-OK status, the returned Call-Future&#39;s exception value</span>
    533. 

  533. <span class="sd">            will be an RpcError.</span>
    534. 

  534. <span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
    535. 

  535. <span class="sd">            outgoing RPC.</span>
    536. 

  536. <span class="sd">          request: The request value for the RPC.</span>
    537. 

  537. 

  538. <span class="sd">        Returns:</span>
    539. 

  539. <span class="sd">            An object that is both a Call for the RPC and a Future.</span>
    540. 

  540. <span class="sd">            In the event of RPC completion, the return Call-Future&#39;s</span>
    541. 

  541. <span class="sd">            result value will be the response message of the RPC.</span>
    542. 

  542. <span class="sd">            Should the event terminate with non-OK status, the returned</span>
    543. 

  543. <span class="sd">            Call-Future&#39;s exception value will be an RpcError.</span>
    544. 

  544. <span class="sd">        &quot;&quot;&quot;</span>
    545. 

  545.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    546. 

  546. 

  547. 

  548. <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>
    549. 

  549.     <span class="sd">&quot;&quot;&quot;Affords intercepting unary-stream invocations.</span>
    550. 

  550. 

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

  552. <span class="sd">    &quot;&quot;&quot;</span>
    553. 

  553. 

  554. <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>
    555. 

  555.     <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>
    556. 

  556.                                <span class="n">request</span><span class="p">):</span>
    557. 

  557.         <span class="sd">&quot;&quot;&quot;Intercepts a unary-stream invocation.</span>
    558. 

  558. 

  559. <span class="sd">        Args:</span>
    560. 

  560. <span class="sd">          continuation: A function that proceeds with the invocation by</span>
    561. 

  561. <span class="sd">            executing the next interceptor in chain or invoking the</span>
    562. 

  562. <span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
    563. 

  563. <span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
    564. 

  564. <span class="sd">            The interceptor can use</span>
    565. 

  565. <span class="sd">            `response_iterator = continuation(client_call_details, request)`</span>
    566. 

  566. <span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
    567. 

  567. <span class="sd">            both a Call for the RPC and an iterator for response values.</span>
    568. 

  568. <span class="sd">            Drawing response values from the returned Call-iterator may</span>
    569. 

  569. <span class="sd">            raise RpcError indicating termination of the RPC with non-OK</span>
    570. 

  570. <span class="sd">            status.</span>
    571. 

  571. <span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
    572. 

  572. <span class="sd">            outgoing RPC.</span>
    573. 

  573. <span class="sd">          request: The request value for the RPC.</span>
    574. 

  574. 

  575. <span class="sd">        Returns:</span>
    576. 

  576. <span class="sd">            An object that is both a Call for the RPC and an iterator of</span>
    577. 

  577. <span class="sd">            response values. Drawing response values from the returned</span>
    578. 

  578. <span class="sd">            Call-iterator may raise RpcError indicating termination of</span>
    579. 

  579. <span class="sd">            the RPC with non-OK status.</span>
    580. 

  580. <span class="sd">        &quot;&quot;&quot;</span>
    581. 

  581.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    582. 

  582. 

  583. 

  584. <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>
    585. 

  585.     <span class="sd">&quot;&quot;&quot;Affords intercepting stream-unary invocations.</span>
    586. 

  586. 

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

  588. <span class="sd">    &quot;&quot;&quot;</span>
    589. 

  589. 

  590. <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>
    591. 

  591.     <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>
    592. 

  592.                                <span class="n">request_iterator</span><span class="p">):</span>
    593. 

  593.         <span class="sd">&quot;&quot;&quot;Intercepts a stream-unary invocation asynchronously.</span>
    594. 

  594. 

  595. <span class="sd">        Args:</span>
    596. 

  596. <span class="sd">          continuation: A function that proceeds with the invocation by</span>
    597. 

  597. <span class="sd">            executing the next interceptor in chain or invoking the</span>
    598. 

  598. <span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
    599. 

  599. <span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
    600. 

  600. <span class="sd">            The interceptor can use</span>
    601. 

  601. <span class="sd">            `response_future = continuation(client_call_details, request_iterator)`</span>
    602. 

  602. <span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
    603. 

  603. <span class="sd">            both a Call for the RPC and a Future. In the event of RPC completion,</span>
    604. 

  604. <span class="sd">            the return Call-Future&#39;s result value will be the response message</span>
    605. 

  605. <span class="sd">            of the RPC. Should the event terminate with non-OK status, the</span>
    606. 

  606. <span class="sd">            returned Call-Future&#39;s exception value will be an RpcError.</span>
    607. 

  607. <span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
    608. 

  608. <span class="sd">            outgoing RPC.</span>
    609. 

  609. <span class="sd">          request_iterator: An iterator that yields request values for the RPC.</span>
    610. 

  610. 

  611. <span class="sd">        Returns:</span>
    612. 

  612. <span class="sd">          An object that is both a Call for the RPC and a Future.</span>
    613. 

  613. <span class="sd">          In the event of RPC completion, the return Call-Future&#39;s</span>
    614. 

  614. <span class="sd">          result value will be the response message of the RPC.</span>
    615. 

  615. <span class="sd">          Should the event terminate with non-OK status, the returned</span>
    616. 

  616. <span class="sd">          Call-Future&#39;s exception value will be an RpcError.</span>
    617. 

  617. <span class="sd">        &quot;&quot;&quot;</span>
    618. 

  618.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    619. 

  619. 

  620. 

  621. <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>
    622. 

  622.     <span class="sd">&quot;&quot;&quot;Affords intercepting stream-stream invocations.</span>
    623. 

  623. 

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

  625. <span class="sd">    &quot;&quot;&quot;</span>
    626. 

  626. 

  627. <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>
    628. 

  628.     <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>
    629. 

  629.                                 <span class="n">request_iterator</span><span class="p">):</span>
    630. 

  630.         <span class="sd">&quot;&quot;&quot;Intercepts a stream-stream invocation.</span>
    631. 

  631. 

  632. <span class="sd">        Args:</span>
    633. 

  633. <span class="sd">          continuation: A function that proceeds with the invocation by</span>
    634. 

  634. <span class="sd">            executing the next interceptor in chain or invoking the</span>
    635. 

  635. <span class="sd">            actual RPC on the underlying Channel. It is the interceptor&#39;s</span>
    636. 

  636. <span class="sd">            responsibility to call it if it decides to move the RPC forward.</span>
    637. 

  637. <span class="sd">            The interceptor can use</span>
    638. 

  638. <span class="sd">            `response_iterator = continuation(client_call_details, request_iterator)`</span>
    639. 

  639. <span class="sd">            to continue with the RPC. `continuation` returns an object that is</span>
    640. 

  640. <span class="sd">            both a Call for the RPC and an iterator for response values.</span>
    641. 

  641. <span class="sd">            Drawing response values from the returned Call-iterator may</span>
    642. 

  642. <span class="sd">            raise RpcError indicating termination of the RPC with non-OK</span>
    643. 

  643. <span class="sd">            status.</span>
    644. 

  644. <span class="sd">          client_call_details: A ClientCallDetails object describing the</span>
    645. 

  645. <span class="sd">            outgoing RPC.</span>
    646. 

  646. <span class="sd">          request_iterator: An iterator that yields request values for the RPC.</span>
    647. 

  647. 

  648. <span class="sd">        Returns:</span>
    649. 

  649. <span class="sd">          An object that is both a Call for the RPC and an iterator of</span>
    650. 

  650. <span class="sd">          response values. Drawing response values from the returned</span>
    651. 

  651. <span class="sd">          Call-iterator may raise RpcError indicating termination of</span>
    652. 

  652. <span class="sd">          the RPC with non-OK status.</span>
    653. 

  653. <span class="sd">        &quot;&quot;&quot;</span>
    654. 

  654.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    655. 

  655. 

  656. 

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

  658. 

  659. 

  660. <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>
    661. 

  661.     <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to create a secure Channel.</span>
    662. 

  662. 

  663. <span class="sd">    This class has no supported interface - it exists to define the type of its</span>
    664. 

  664. <span class="sd">    instances and its instances exist to be passed to other functions. For</span>
    665. 

  665. <span class="sd">    example, ssl_channel_credentials returns an instance of this class and</span>
    666. 

  666. <span class="sd">    secure_channel requires an instance of this class.</span>
    667. 

  667. <span class="sd">    &quot;&quot;&quot;</span>
    668. 

  668. 

  669.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    670. 

  670.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    671. 

  671. 

  672. 

  673. <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>
    674. 

  674.     <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to assert an identity over a call.</span>
    675. 

  675. 

  676. <span class="sd">    A CallCredentials has to be used with secure Channel, otherwise the</span>
    677. 

  677. <span class="sd">    metadata will not be transmitted to the server.</span>
    678. 

  678. 

  679. <span class="sd">    A CallCredentials may be composed with ChannelCredentials to always assert</span>
    680. 

  680. <span class="sd">    identity for every call over that Channel.</span>
    681. 

  681. 

  682. <span class="sd">    This class has no supported interface - it exists to define the type of its</span>
    683. 

  683. <span class="sd">    instances and its instances exist to be passed to other functions.</span>
    684. 

  684. <span class="sd">    &quot;&quot;&quot;</span>
    685. 

  685. 

  686.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    687. 

  687.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    688. 

  688. 

  689. 

  690. <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>
    691. 

  691.     <span class="sd">&quot;&quot;&quot;Provides information to call credentials metadata plugins.</span>
    692. 

  692. 

  693. <span class="sd">    Attributes:</span>
    694. 

  694. <span class="sd">      service_url: A string URL of the service being called into.</span>
    695. 

  695. <span class="sd">      method_name: A string of the fully qualified method name being called.</span>
    696. 

  696. <span class="sd">    &quot;&quot;&quot;</span></div>
    697. 

  697. 

  698. 

  699. <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>
    700. 

  700.     <span class="sd">&quot;&quot;&quot;Callback object received by a metadata plugin.&quot;&quot;&quot;</span>
    701. 

  701. 

  702. <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="fm">__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>
    703. 

  703.         <span class="sd">&quot;&quot;&quot;Passes to the gRPC runtime authentication metadata for an RPC.</span>
    704. 

  704. 

  705. <span class="sd">        Args:</span>
    706. 

  706. <span class="sd">          metadata: The :term:`metadata` used to construct the CallCredentials.</span>
    707. 

  707. <span class="sd">          error: An Exception to indicate error or None to indicate success.</span>
    708. 

  708. <span class="sd">        &quot;&quot;&quot;</span>
    709. 

  709.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    710. 

  710. 

  711. 

  712. <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>
    713. 

  713.     <span class="sd">&quot;&quot;&quot;A specification for custom authentication.&quot;&quot;&quot;</span>
    714. 

  714. 

  715. <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="fm">__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>
    716. 

  716.         <span class="sd">&quot;&quot;&quot;Implements authentication by passing metadata to a callback.</span>
    717. 

  717. 

  718. <span class="sd">        This method will be invoked asynchronously in a separate thread.</span>
    719. 

  719. 

  720. <span class="sd">        Args:</span>
    721. 

  721. <span class="sd">          context: An AuthMetadataContext providing information on the RPC that</span>
    722. 

  722. <span class="sd">            the plugin is being called to authenticate.</span>
    723. 

  723. <span class="sd">          callback: An AuthMetadataPluginCallback to be invoked either</span>
    724. 

  724. <span class="sd">            synchronously or asynchronously.</span>
    725. 

  725. <span class="sd">        &quot;&quot;&quot;</span>
    726. 

  726.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    727. 

  727. 

  728. 

  729. <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>
    730. 

  730.     <span class="sd">&quot;&quot;&quot;An encapsulation of the data required to open a secure port on a Server.</span>
    731. 

  731. 

  732. <span class="sd">    This class has no supported interface - it exists to define the type of its</span>
    733. 

  733. <span class="sd">    instances and its instances exist to be passed to other functions.</span>
    734. 

  734. <span class="sd">    &quot;&quot;&quot;</span>
    735. 

  735. 

  736.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    737. 

  737.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    738. 

  738. 

  739. 

  740. <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>
    741. 

  741.     <span class="sd">&quot;&quot;&quot;A certificate configuration for use with an SSL-enabled Server.</span>
    742. 

  742. 

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

  744. <span class="sd">    fetching callback.</span>
    745. 

  745. 

  746. <span class="sd">    This class has no supported interface -- it exists to define the</span>
    747. 

  747. <span class="sd">    type of its instances and its instances exist to be passed to</span>
    748. 

  748. <span class="sd">    other functions.</span>
    749. 

  749. <span class="sd">    &quot;&quot;&quot;</span>
    750. 

  750. 

  751.     <span class="k">def</span> <span class="fm">__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>
    752. 

  752.         <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>
    753. 

  753. 

  754. 

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

  756. 

  757. 

  758. <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>
    759. 

  759.     <span class="sd">&quot;&quot;&quot;Affords invoking a unary-unary RPC from client-side.&quot;&quot;&quot;</span>
    760. 

  760. 

  761. <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>
    762. 

  762.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    763. 

  763.                  <span class="n">request</span><span class="p">,</span>
    764. 

  764.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    765. 

  765.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    766. 

  766.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    767. 

  767.                  <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    768. 

  768.                  <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    769. 

  769.         <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>
    770. 

  770. 

  771. <span class="sd">        Args:</span>
    772. 

  772. <span class="sd">          request: The request value for the RPC.</span>
    773. 

  773. <span class="sd">          timeout: An optional duration of time in seconds to allow</span>
    774. 

  774. <span class="sd">            for the RPC.</span>
    775. 

  775. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    776. 

  776. <span class="sd">            service-side of the RPC.</span>
    777. 

  777. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    778. 

  778. <span class="sd">            secure Channel.</span>
    779. 

  779. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    780. 

  780. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    781. 

  781. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    782. 

  782. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    783. 

  783. 

  784. <span class="sd">        Returns:</span>
    785. 

  785. <span class="sd">          The response value for the RPC.</span>
    786. 

  786. 

  787. <span class="sd">        Raises:</span>
    788. 

  788. <span class="sd">          RpcError: Indicating that the RPC terminated with non-OK status. The</span>
    789. 

  789. <span class="sd">            raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
    790. 

  790. <span class="sd">            metadata, status code, and details.</span>
    791. 

  791. <span class="sd">        &quot;&quot;&quot;</span>
    792. 

  792.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    793. 

  793. 

  794. <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>
    795. 

  795.     <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    796. 

  796.                   <span class="n">request</span><span class="p">,</span>
    797. 

  797.                   <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    798. 

  798.                   <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    799. 

  799.                   <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    800. 

  800.                   <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    801. 

  801.                   <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    802. 

  802.         <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>
    803. 

  803. 

  804. <span class="sd">        Args:</span>
    805. 

  805. <span class="sd">          request: The request value for the RPC.</span>
    806. 

  806. <span class="sd">          timeout: An optional durating of time in seconds to allow for</span>
    807. 

  807. <span class="sd">            the RPC.</span>
    808. 

  808. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    809. 

  809. <span class="sd">            service-side of the RPC.</span>
    810. 

  810. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    811. 

  811. <span class="sd">            secure Channel.</span>
    812. 

  812. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    813. 

  813. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    814. 

  814. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    815. 

  815. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    816. 

  816. 

  817. <span class="sd">        Returns:</span>
    818. 

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

  819. 

  820. <span class="sd">        Raises:</span>
    821. 

  821. <span class="sd">          RpcError: Indicating that the RPC terminated with non-OK status. The</span>
    822. 

  822. <span class="sd">            raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
    823. 

  823. <span class="sd">            metadata, status code, and details.</span>
    824. 

  824. <span class="sd">        &quot;&quot;&quot;</span>
    825. 

  825.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    826. 

  826. 

  827. <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>
    828. 

  828.     <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    829. 

  829.                <span class="n">request</span><span class="p">,</span>
    830. 

  830.                <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    831. 

  831.                <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    832. 

  832.                <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    833. 

  833.                <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    834. 

  834.                <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    835. 

  835.         <span class="sd">&quot;&quot;&quot;Asynchronously invokes the underlying RPC.</span>
    836. 

  836. 

  837. <span class="sd">        Args:</span>
    838. 

  838. <span class="sd">          request: The request value for the RPC.</span>
    839. 

  839. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    840. 

  840. <span class="sd">            the RPC.</span>
    841. 

  841. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    842. 

  842. <span class="sd">            service-side of the RPC.</span>
    843. 

  843. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    844. 

  844. <span class="sd">            secure Channel.</span>
    845. 

  845. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    846. 

  846. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    847. 

  847. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    848. 

  848. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    849. 

  849. 

  850. <span class="sd">        Returns:</span>
    851. 

  851. <span class="sd">            An object that is both a Call for the RPC and a Future.</span>
    852. 

  852. <span class="sd">            In the event of RPC completion, the return Call-Future&#39;s result</span>
    853. 

  853. <span class="sd">            value will be the response message of the RPC.</span>
    854. 

  854. <span class="sd">            Should the event terminate with non-OK status,</span>
    855. 

  855. <span class="sd">            the returned Call-Future&#39;s exception value will be an RpcError.</span>
    856. 

  856. <span class="sd">        &quot;&quot;&quot;</span>
    857. 

  857.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    858. 

  858. 

  859. 

  860. <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>
    861. 

  861.     <span class="sd">&quot;&quot;&quot;Affords invoking a unary-stream RPC from client-side.&quot;&quot;&quot;</span>
    862. 

  862. 

  863. <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>
    864. 

  864.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    865. 

  865.                  <span class="n">request</span><span class="p">,</span>
    866. 

  866.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    867. 

  867.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    868. 

  868.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    869. 

  869.                  <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    870. 

  870.                  <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    871. 

  871.         <span class="sd">&quot;&quot;&quot;Invokes the underlying RPC.</span>
    872. 

  872. 

  873. <span class="sd">        Args:</span>
    874. 

  874. <span class="sd">          request: The request value for the RPC.</span>
    875. 

  875. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    876. 

  876. <span class="sd">            the RPC. If None, the timeout is considered infinite.</span>
    877. 

  877. <span class="sd">          metadata: An optional :term:`metadata` to be transmitted to the</span>
    878. 

  878. <span class="sd">            service-side of the RPC.</span>
    879. 

  879. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    880. 

  880. <span class="sd">            secure Channel.</span>
    881. 

  881. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    882. 

  882. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    883. 

  883. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    884. 

  884. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    885. 

  885. 

  886. <span class="sd">        Returns:</span>
    887. 

  887. <span class="sd">            An object that is both a Call for the RPC and an iterator of</span>
    888. 

  888. <span class="sd">            response values. Drawing response values from the returned</span>
    889. 

  889. <span class="sd">            Call-iterator may raise RpcError indicating termination of the</span>
    890. 

  890. <span class="sd">            RPC with non-OK status.</span>
    891. 

  891. <span class="sd">        &quot;&quot;&quot;</span>
    892. 

  892.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    893. 

  893. 

  894. 

  895. <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>
    896. 

  896.     <span class="sd">&quot;&quot;&quot;Affords invoking a stream-unary RPC from client-side.&quot;&quot;&quot;</span>
    897. 

  897. 

  898. <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>
    899. 

  899.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    900. 

  900.                  <span class="n">request_iterator</span><span class="p">,</span>
    901. 

  901.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    902. 

  902.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    903. 

  903.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    904. 

  904.                  <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    905. 

  905.                  <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    906. 

  906.         <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC.</span>
    907. 

  907. 

  908. <span class="sd">        Args:</span>
    909. 

  909. <span class="sd">          request_iterator: An iterator that yields request values for</span>
    910. 

  910. <span class="sd">            the RPC.</span>
    911. 

  911. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    912. 

  912. <span class="sd">            the RPC. If None, the timeout is considered infinite.</span>
    913. 

  913. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    914. 

  914. <span class="sd">            service-side of the RPC.</span>
    915. 

  915. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    916. 

  916. <span class="sd">            secure Channel.</span>
    917. 

  917. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    918. 

  918. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    919. 

  919. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    920. 

  920. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    921. 

  921. 

  922. <span class="sd">        Returns:</span>
    923. 

  923. <span class="sd">          The response value for the RPC.</span>
    924. 

  924. 

  925. <span class="sd">        Raises:</span>
    926. 

  926. <span class="sd">          RpcError: Indicating that the RPC terminated with non-OK status. The</span>
    927. 

  927. <span class="sd">            raised RpcError will also implement grpc.Call, affording methods</span>
    928. 

  928. <span class="sd">            such as metadata, code, and details.</span>
    929. 

  929. <span class="sd">        &quot;&quot;&quot;</span>
    930. 

  930.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    931. 

  931. 

  932. <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>
    933. 

  933.     <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    934. 

  934.                   <span class="n">request_iterator</span><span class="p">,</span>
    935. 

  935.                   <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    936. 

  936.                   <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    937. 

  937.                   <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    938. 

  938.                   <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    939. 

  939.                   <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    940. 

  940.         <span class="sd">&quot;&quot;&quot;Synchronously invokes the underlying RPC on the client.</span>
    941. 

  941. 

  942. <span class="sd">        Args:</span>
    943. 

  943. <span class="sd">          request_iterator: An iterator that yields request values for</span>
    944. 

  944. <span class="sd">            the RPC.</span>
    945. 

  945. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    946. 

  946. <span class="sd">            the RPC. If None, the timeout is considered infinite.</span>
    947. 

  947. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    948. 

  948. <span class="sd">            service-side of the RPC.</span>
    949. 

  949. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    950. 

  950. <span class="sd">            secure Channel.</span>
    951. 

  951. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    952. 

  952. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    953. 

  953. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    954. 

  954. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    955. 

  955. 

  956. <span class="sd">        Returns:</span>
    957. 

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

  958. 

  959. <span class="sd">        Raises:</span>
    960. 

  960. <span class="sd">          RpcError: Indicating that the RPC terminated with non-OK status. The</span>
    961. 

  961. <span class="sd">            raised RpcError will also be a Call for the RPC affording the RPC&#39;s</span>
    962. 

  962. <span class="sd">            metadata, status code, and details.</span>
    963. 

  963. <span class="sd">        &quot;&quot;&quot;</span>
    964. 

  964.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    965. 

  965. 

  966. <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>
    967. 

  967.     <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    968. 

  968.                <span class="n">request_iterator</span><span class="p">,</span>
    969. 

  969.                <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    970. 

  970.                <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    971. 

  971.                <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    972. 

  972.                <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    973. 

  973.                <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    974. 

  974.         <span class="sd">&quot;&quot;&quot;Asynchronously invokes the underlying RPC on the client.</span>
    975. 

  975. 

  976. <span class="sd">        Args:</span>
    977. 

  977. <span class="sd">          request_iterator: An iterator that yields request values for the RPC.</span>
    978. 

  978. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    979. 

  979. <span class="sd">            the RPC. If None, the timeout is considered infinite.</span>
    980. 

  980. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    981. 

  981. <span class="sd">            service-side of the RPC.</span>
    982. 

  982. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    983. 

  983. <span class="sd">            secure Channel.</span>
    984. 

  984. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    985. 

  985. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    986. 

  986. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    987. 

  987. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    988. 

  988. 

  989. <span class="sd">        Returns:</span>
    990. 

  990. <span class="sd">            An object that is both a Call for the RPC and a Future.</span>
    991. 

  991. <span class="sd">            In the event of RPC completion, the return Call-Future&#39;s result value</span>
    992. 

  992. <span class="sd">            will be the response message of the RPC. Should the event terminate</span>
    993. 

  993. <span class="sd">            with non-OK status, the returned Call-Future&#39;s exception value will</span>
    994. 

  994. <span class="sd">            be an RpcError.</span>
    995. 

  995. <span class="sd">        &quot;&quot;&quot;</span>
    996. 

  996.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    997. 

  997. 

  998. 

  999. <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>
    1000. 

  1000.     <span class="sd">&quot;&quot;&quot;Affords invoking a stream-stream RPC on client-side.&quot;&quot;&quot;</span>
    1001. 

  1001. 

  1002. <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>
    1003. 

  1003.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1004. 

  1004.                  <span class="n">request_iterator</span><span class="p">,</span>
    1005. 

  1005.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1006. 

  1006.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1007. 

  1007.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1008. 

  1008.                  <span class="n">wait_for_ready</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1009. 

  1009.                  <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1010. 

  1010.         <span class="sd">&quot;&quot;&quot;Invokes the underlying RPC on the client.</span>
    1011. 

  1011. 

  1012. <span class="sd">        Args:</span>
    1013. 

  1013. <span class="sd">          request_iterator: An iterator that yields request values for the RPC.</span>
    1014. 

  1014. <span class="sd">          timeout: An optional duration of time in seconds to allow for</span>
    1015. 

  1015. <span class="sd">            the RPC. If not specified, the timeout is considered infinite.</span>
    1016. 

  1016. <span class="sd">          metadata: Optional :term:`metadata` to be transmitted to the</span>
    1017. 

  1017. <span class="sd">            service-side of the RPC.</span>
    1018. 

  1018. <span class="sd">          credentials: An optional CallCredentials for the RPC. Only valid for</span>
    1019. 

  1019. <span class="sd">            secure Channel.</span>
    1020. 

  1020. <span class="sd">          wait_for_ready: This is an EXPERIMENTAL argument. An optional</span>
    1021. 

  1021. <span class="sd">            flag to enable :term:`wait_for_ready` mechanism.</span>
    1022. 

  1022. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    1023. 

  1023. <span class="sd">            grpc.compression.Gzip. This is an EXPERIMENTAL option.</span>
    1024. 

  1024. 

  1025. <span class="sd">        Returns:</span>
    1026. 

  1026. <span class="sd">            An object that is both a Call for the RPC and an iterator of</span>
    1027. 

  1027. <span class="sd">            response values. Drawing response values from the returned</span>
    1028. 

  1028. <span class="sd">            Call-iterator may raise RpcError indicating termination of the</span>
    1029. 

  1029. <span class="sd">            RPC with non-OK status.</span>
    1030. 

  1030. <span class="sd">        &quot;&quot;&quot;</span>
    1031. 

  1031.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1032. 

  1032. 

  1033. 

  1034. <span class="c1">#############################  Channel Interface  ##############################</span>
    1035. 

  1035. 

  1036. 

  1037. <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>
    1038. 

  1038.     <span class="sd">&quot;&quot;&quot;Affords RPC invocation via generic methods on client-side.</span>
    1039. 

  1039. 

  1040. <span class="sd">    Channel objects implement the Context Manager type, although they need not</span>
    1041. 

  1041. <span class="sd">    support being entered and exited multiple times.</span>
    1042. 

  1042. <span class="sd">    &quot;&quot;&quot;</span>
    1043. 

  1043. 

  1044. <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>
    1045. 

  1045.     <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>
    1046. 

  1046.         <span class="sd">&quot;&quot;&quot;Subscribe to this Channel&#39;s connectivity state machine.</span>
    1047. 

  1047. 

  1048. <span class="sd">        A Channel may be in any of the states described by ChannelConnectivity.</span>
    1049. 

  1049. <span class="sd">        This method allows application to monitor the state transitions.</span>
    1050. 

  1050. <span class="sd">        The typical use case is to debug or gain better visibility into gRPC</span>
    1051. 

  1051. <span class="sd">        runtime&#39;s state.</span>
    1052. 

  1052. 

  1053. <span class="sd">        Args:</span>
    1054. 

  1054. <span class="sd">          callback: A callable to be invoked with ChannelConnectivity argument.</span>
    1055. 

  1055. <span class="sd">            ChannelConnectivity describes current state of the channel.</span>
    1056. 

  1056. <span class="sd">            The callable will be invoked immediately upon subscription</span>
    1057. 

  1057. <span class="sd">            and again for every change to ChannelConnectivity until it</span>
    1058. 

  1058. <span class="sd">            is unsubscribed or this Channel object goes out of scope.</span>
    1059. 

  1059. <span class="sd">          try_to_connect: A boolean indicating whether or not this Channel</span>
    1060. 

  1060. <span class="sd">            should attempt to connect immediately. If set to False, gRPC</span>
    1061. 

  1061. <span class="sd">            runtime decides when to connect.</span>
    1062. 

  1062. <span class="sd">        &quot;&quot;&quot;</span>
    1063. 

  1063.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1064. 

  1064. 

  1065. <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>
    1066. 

  1066.     <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>
    1067. 

  1067.         <span class="sd">&quot;&quot;&quot;Unsubscribes a subscribed callback from this Channel&#39;s connectivity.</span>
    1068. 

  1068. 

  1069. <span class="sd">        Args:</span>
    1070. 

  1070. <span class="sd">          callback: A callable previously registered with this Channel from</span>
    1071. 

  1071. <span class="sd">          having been passed to its &quot;subscribe&quot; method.</span>
    1072. 

  1072. <span class="sd">        &quot;&quot;&quot;</span>
    1073. 

  1073.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1074. 

  1074. 

  1075. <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>
    1076. 

  1076.     <span class="k">def</span> <span class="nf">unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1077. 

  1077.                     <span class="n">method</span><span class="p">,</span>
    1078. 

  1078.                     <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1079. 

  1079.                     <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1080. 

  1080.         <span class="sd">&quot;&quot;&quot;Creates a UnaryUnaryMultiCallable for a unary-unary method.</span>
    1081. 

  1081. 

  1082. <span class="sd">        Args:</span>
    1083. 

  1083. <span class="sd">          method: The name of the RPC method.</span>
    1084. 

  1084. <span class="sd">          request_serializer: Optional :term:`serializer` for serializing the request</span>
    1085. 

  1085. <span class="sd">            message. Request goes unserialized in case None is passed.</span>
    1086. 

  1086. <span class="sd">          response_deserializer: Optional :term:`deserializer` for deserializing the</span>
    1087. 

  1087. <span class="sd">            response message. Response goes undeserialized in case None</span>
    1088. 

  1088. <span class="sd">            is passed.</span>
    1089. 

  1089. 

  1090. <span class="sd">        Returns:</span>
    1091. 

  1091. <span class="sd">          A UnaryUnaryMultiCallable value for the named unary-unary method.</span>
    1092. 

  1092. <span class="sd">        &quot;&quot;&quot;</span>
    1093. 

  1093.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1094. 

  1094. 

  1095. <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>
    1096. 

  1096.     <span class="k">def</span> <span class="nf">unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1097. 

  1097.                      <span class="n">method</span><span class="p">,</span>
    1098. 

  1098.                      <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1099. 

  1099.                      <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1100. 

  1100.         <span class="sd">&quot;&quot;&quot;Creates a UnaryStreamMultiCallable for a unary-stream method.</span>
    1101. 

  1101. 

  1102. <span class="sd">        Args:</span>
    1103. 

  1103. <span class="sd">          method: The name of the RPC method.</span>
    1104. 

  1104. <span class="sd">          request_serializer: Optional :term:`serializer` for serializing the request</span>
    1105. 

  1105. <span class="sd">            message. Request goes unserialized in case None is passed.</span>
    1106. 

  1106. <span class="sd">          response_deserializer: Optional :term:`deserializer` for deserializing the</span>
    1107. 

  1107. <span class="sd">            response message. Response goes undeserialized in case None is</span>
    1108. 

  1108. <span class="sd">            passed.</span>
    1109. 

  1109. 

  1110. <span class="sd">        Returns:</span>
    1111. 

  1111. <span class="sd">          A UnaryStreamMultiCallable value for the name unary-stream method.</span>
    1112. 

  1112. <span class="sd">        &quot;&quot;&quot;</span>
    1113. 

  1113.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1114. 

  1114. 

  1115. <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>
    1116. 

  1116.     <span class="k">def</span> <span class="nf">stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1117. 

  1117.                      <span class="n">method</span><span class="p">,</span>
    1118. 

  1118.                      <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1119. 

  1119.                      <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1120. 

  1120.         <span class="sd">&quot;&quot;&quot;Creates a StreamUnaryMultiCallable for a stream-unary method.</span>
    1121. 

  1121. 

  1122. <span class="sd">        Args:</span>
    1123. 

  1123. <span class="sd">          method: The name of the RPC method.</span>
    1124. 

  1124. <span class="sd">          request_serializer: Optional :term:`serializer` for serializing the request</span>
    1125. 

  1125. <span class="sd">            message. Request goes unserialized in case None is passed.</span>
    1126. 

  1126. <span class="sd">          response_deserializer: Optional :term:`deserializer` for deserializing the</span>
    1127. 

  1127. <span class="sd">            response message. Response goes undeserialized in case None is</span>
    1128. 

  1128. <span class="sd">            passed.</span>
    1129. 

  1129. 

  1130. <span class="sd">        Returns:</span>
    1131. 

  1131. <span class="sd">          A StreamUnaryMultiCallable value for the named stream-unary method.</span>
    1132. 

  1132. <span class="sd">        &quot;&quot;&quot;</span>
    1133. 

  1133.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1134. 

  1134. 

  1135. <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>
    1136. 

  1136.     <span class="k">def</span> <span class="nf">stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1137. 

  1137.                       <span class="n">method</span><span class="p">,</span>
    1138. 

  1138.                       <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1139. 

  1139.                       <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1140. 

  1140.         <span class="sd">&quot;&quot;&quot;Creates a StreamStreamMultiCallable for a stream-stream method.</span>
    1141. 

  1141. 

  1142. <span class="sd">        Args:</span>
    1143. 

  1143. <span class="sd">          method: The name of the RPC method.</span>
    1144. 

  1144. <span class="sd">          request_serializer: Optional :term:`serializer` for serializing the request</span>
    1145. 

  1145. <span class="sd">            message. Request goes unserialized in case None is passed.</span>
    1146. 

  1146. <span class="sd">          response_deserializer: Optional :term:`deserializer` for deserializing the</span>
    1147. 

  1147. <span class="sd">            response message. Response goes undeserialized in case None</span>
    1148. 

  1148. <span class="sd">            is passed.</span>
    1149. 

  1149. 

  1150. <span class="sd">        Returns:</span>
    1151. 

  1151. <span class="sd">          A StreamStreamMultiCallable value for the named stream-stream method.</span>
    1152. 

  1152. <span class="sd">        &quot;&quot;&quot;</span>
    1153. 

  1153.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1154. 

  1154. 

  1155. <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>
    1156. 

  1156.     <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1157. 

  1157.         <span class="sd">&quot;&quot;&quot;Closes this Channel and releases all resources held by it.</span>
    1158. 

  1158. 

  1159. <span class="sd">        Closing the Channel will immediately terminate all RPCs active with the</span>
    1160. 

  1160. <span class="sd">        Channel and it is not valid to invoke new RPCs with the Channel.</span>
    1161. 

  1161. 

  1162. <span class="sd">        This method is idempotent.</span>
    1163. 

  1163. <span class="sd">        &quot;&quot;&quot;</span>
    1164. 

  1164.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1165. 

  1165. 

  1166. <div class="viewcode-block" id="Channel.__enter__"><a class="viewcode-back" href="../grpc.html#grpc.Channel.__enter__">[docs]</a>    <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1167. 

  1167.         <span class="sd">&quot;&quot;&quot;Enters the runtime context related to the channel object.&quot;&quot;&quot;</span>
    1168. 

  1168.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1169. 

  1169. 

  1170. <div class="viewcode-block" id="Channel.__exit__"><a class="viewcode-back" href="../grpc.html#grpc.Channel.__exit__">[docs]</a>    <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
    1171. 

  1171.         <span class="sd">&quot;&quot;&quot;Exits the runtime context related to the channel object.&quot;&quot;&quot;</span>
    1172. 

  1172.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1173. 

  1173. 

  1174. 

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

  1176. 

  1177. 

  1178. <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>
    1179. 

  1179.     <span class="sd">&quot;&quot;&quot;A context object passed to method implementations.&quot;&quot;&quot;</span>
    1180. 

  1180. 

  1181. <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>
    1182. 

  1182.     <span class="k">def</span> <span class="nf">invocation_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1183. 

  1183.         <span class="sd">&quot;&quot;&quot;Accesses the metadata from the sent by the client.</span>
    1184. 

  1184. 

  1185. <span class="sd">        Returns:</span>
    1186. 

  1186. <span class="sd">          The invocation :term:`metadata`.</span>
    1187. 

  1187. <span class="sd">        &quot;&quot;&quot;</span>
    1188. 

  1188.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1189. 

  1189. 

  1190. <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>
    1191. 

  1191.     <span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1192. 

  1192.         <span class="sd">&quot;&quot;&quot;Identifies the peer that invoked the RPC being serviced.</span>
    1193. 

  1193. 

  1194. <span class="sd">        Returns:</span>
    1195. 

  1195. <span class="sd">          A string identifying the peer that invoked the RPC being serviced.</span>
    1196. 

  1196. <span class="sd">          The string format is determined by gRPC runtime.</span>
    1197. 

  1197. <span class="sd">        &quot;&quot;&quot;</span>
    1198. 

  1198.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1199. 

  1199. 

  1200. <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>
    1201. 

  1201.     <span class="k">def</span> <span class="nf">peer_identities</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1202. 

  1202.         <span class="sd">&quot;&quot;&quot;Gets one or more peer identity(s).</span>
    1203. 

  1203. 

  1204. <span class="sd">        Equivalent to</span>
    1205. 

  1205. <span class="sd">        servicer_context.auth_context().get(servicer_context.peer_identity_key())</span>
    1206. 

  1206. 

  1207. <span class="sd">        Returns:</span>
    1208. 

  1208. <span class="sd">          An iterable of the identities, or None if the call is not</span>
    1209. 

  1209. <span class="sd">          authenticated. Each identity is returned as a raw bytes type.</span>
    1210. 

  1210. <span class="sd">        &quot;&quot;&quot;</span>
    1211. 

  1211.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1212. 

  1212. 

  1213. <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>
    1214. 

  1214.     <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>
    1215. 

  1215.         <span class="sd">&quot;&quot;&quot;The auth property used to identify the peer.</span>
    1216. 

  1216. 

  1217. <span class="sd">        For example, &quot;x509_common_name&quot; or &quot;x509_subject_alternative_name&quot; are</span>
    1218. 

  1218. <span class="sd">        used to identify an SSL peer.</span>
    1219. 

  1219. 

  1220. <span class="sd">        Returns:</span>
    1221. 

  1221. <span class="sd">          The auth property (string) that indicates the</span>
    1222. 

  1222. <span class="sd">          peer identity, or None if the call is not authenticated.</span>
    1223. 

  1223. <span class="sd">        &quot;&quot;&quot;</span>
    1224. 

  1224.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1225. 

  1225. 

  1226. <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>
    1227. 

  1227.     <span class="k">def</span> <span class="nf">auth_context</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1228. 

  1228.         <span class="sd">&quot;&quot;&quot;Gets the auth context for the call.</span>
    1229. 

  1229. 

  1230. <span class="sd">        Returns:</span>
    1231. 

  1231. <span class="sd">          A map of strings to an iterable of bytes for each auth property.</span>
    1232. 

  1232. <span class="sd">        &quot;&quot;&quot;</span>
    1233. 

  1233.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1234. 

  1234. 

  1235. <div class="viewcode-block" id="ServicerContext.set_compression"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_compression">[docs]</a>    <span class="k">def</span> <span class="nf">set_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">compression</span><span class="p">):</span>
    1236. 

  1236.         <span class="sd">&quot;&quot;&quot;Set the compression algorithm to be used for the entire call.</span>
    1237. 

  1237. 

  1238. <span class="sd">        This is an EXPERIMENTAL method.</span>
    1239. 

  1239. 

  1240. <span class="sd">        Args:</span>
    1241. 

  1241. <span class="sd">          compression: An element of grpc.compression, e.g.</span>
    1242. 

  1242. <span class="sd">            grpc.compression.Gzip.</span>
    1243. 

  1243. <span class="sd">        &quot;&quot;&quot;</span>
    1244. 

  1244.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1245. 

  1245. 

  1246. <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>
    1247. 

  1247.     <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>
    1248. 

  1248.         <span class="sd">&quot;&quot;&quot;Sends the initial metadata value to the client.</span>
    1249. 

  1249. 

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

  1251. <span class="sd">        metadata to add to what the gRPC runtime will transmit.</span>
    1252. 

  1252. 

  1253. <span class="sd">        Args:</span>
    1254. 

  1254. <span class="sd">          initial_metadata: The initial :term:`metadata`.</span>
    1255. 

  1255. <span class="sd">        &quot;&quot;&quot;</span>
    1256. 

  1256.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1257. 

  1257. 

  1258. <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>
    1259. 

  1259.     <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>
    1260. 

  1260.         <span class="sd">&quot;&quot;&quot;Sets the trailing metadata for the RPC.</span>
    1261. 

  1261. 

  1262. <span class="sd">        Sets the trailing metadata to be sent upon completion of the RPC.</span>
    1263. 

  1263. 

  1264. <span class="sd">        If this method is invoked multiple times throughout the lifetime of an</span>
    1265. 

  1265. <span class="sd">        RPC, the value supplied in the final invocation will be the value sent</span>
    1266. 

  1266. <span class="sd">        over the wire.</span>
    1267. 

  1267. 

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

  1269. <span class="sd">        metadata to add to what the gRPC runtime will transmit.</span>
    1270. 

  1270. 

  1271. <span class="sd">        Args:</span>
    1272. 

  1272. <span class="sd">          trailing_metadata: The trailing :term:`metadata`.</span>
    1273. 

  1273. <span class="sd">        &quot;&quot;&quot;</span>
    1274. 

  1274.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1275. 

  1275. 

  1276. <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>
    1277. 

  1277.     <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>
    1278. 

  1278.         <span class="sd">&quot;&quot;&quot;Raises an exception to terminate the RPC with a non-OK status.</span>
    1279. 

  1279. 

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

  1281. <span class="sd">        ones.</span>
    1282. 

  1282. 

  1283. <span class="sd">        Args:</span>
    1284. 

  1284. <span class="sd">          code: A StatusCode object to be sent to the client.</span>
    1285. 

  1285. <span class="sd">            It must not be StatusCode.OK.</span>
    1286. 

  1286. <span class="sd">          details: A UTF-8-encodable string to be sent to the client upon</span>
    1287. 

  1287. <span class="sd">            termination of the RPC.</span>
    1288. 

  1288. 

  1289. <span class="sd">        Raises:</span>
    1290. 

  1290. <span class="sd">          Exception: An exception is always raised to signal the abortion the</span>
    1291. 

  1291. <span class="sd">            RPC to the gRPC runtime.</span>
    1292. 

  1292. <span class="sd">        &quot;&quot;&quot;</span>
    1293. 

  1293.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1294. 

  1294. 

  1295. <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>
    1296. 

  1296.     <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>
    1297. 

  1297.         <span class="sd">&quot;&quot;&quot;Raises an exception to terminate the RPC with a non-OK status.</span>
    1298. 

  1298. 

  1299. <span class="sd">        The status passed as argument will supercede any existing status code,</span>
    1300. 

  1300. <span class="sd">        status message and trailing metadata.</span>
    1301. 

  1301. 

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

  1303. 

  1304. <span class="sd">        Args:</span>
    1305. 

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

  1306. <span class="sd">            StatusCode.OK.</span>
    1307. 

  1307. 

  1308. <span class="sd">        Raises:</span>
    1309. 

  1309. <span class="sd">          Exception: An exception is always raised to signal the abortion the</span>
    1310. 

  1310. <span class="sd">            RPC to the gRPC runtime.</span>
    1311. 

  1311. <span class="sd">        &quot;&quot;&quot;</span>
    1312. 

  1312.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1313. 

  1313. 

  1314. <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>
    1315. 

  1315.     <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>
    1316. 

  1316.         <span class="sd">&quot;&quot;&quot;Sets the value to be used as status code upon RPC completion.</span>
    1317. 

  1317. 

  1318. <span class="sd">        This method need not be called by method implementations if they wish</span>
    1319. 

  1319. <span class="sd">        the gRPC runtime to determine the status code of the RPC.</span>
    1320. 

  1320. 

  1321. <span class="sd">        Args:</span>
    1322. 

  1322. <span class="sd">          code: A StatusCode object to be sent to the client.</span>
    1323. 

  1323. <span class="sd">        &quot;&quot;&quot;</span>
    1324. 

  1324.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1325. 

  1325. 

  1326. <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>
    1327. 

  1327.     <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>
    1328. 

  1328.         <span class="sd">&quot;&quot;&quot;Sets the value to be used as detail string upon RPC completion.</span>
    1329. 

  1329. 

  1330. <span class="sd">        This method need not be called by method implementations if they have</span>
    1331. 

  1331. <span class="sd">        no details to transmit.</span>
    1332. 

  1332. 

  1333. <span class="sd">        Args:</span>
    1334. 

  1334. <span class="sd">          details: A UTF-8-encodable string to be sent to the client upon</span>
    1335. 

  1335. <span class="sd">            termination of the RPC.</span>
    1336. 

  1336. <span class="sd">        &quot;&quot;&quot;</span>
    1337. 

  1337.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1338. 

  1338. 

  1339. <div class="viewcode-block" id="ServicerContext.disable_next_message_compression"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.disable_next_message_compression">[docs]</a>    <span class="k">def</span> <span class="nf">disable_next_message_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1340. 

  1340.         <span class="sd">&quot;&quot;&quot;Disables compression for the next response message.</span>
    1341. 

  1341. 

  1342. <span class="sd">        This is an EXPERIMENTAL method.</span>
    1343. 

  1343. 

  1344. <span class="sd">        This method will override any compression configuration set during</span>
    1345. 

  1345. <span class="sd">        server creation or set on the call.</span>
    1346. 

  1346. <span class="sd">        &quot;&quot;&quot;</span>
    1347. 

  1347.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1348. 

  1348. 

  1349. 

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

  1351. 

  1352. 

  1353. <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>
    1354. 

  1354.     <span class="sd">&quot;&quot;&quot;An implementation of a single RPC method.</span>
    1355. 

  1355. 

  1356. <span class="sd">    Attributes:</span>
    1357. 

  1357. <span class="sd">      request_streaming: Whether the RPC supports exactly one request message</span>
    1358. 

  1358. <span class="sd">        or any arbitrary number of request messages.</span>
    1359. 

  1359. <span class="sd">      response_streaming: Whether the RPC supports exactly one response message</span>
    1360. 

  1360. <span class="sd">        or any arbitrary number of response messages.</span>
    1361. 

  1361. <span class="sd">      request_deserializer: A callable :term:`deserializer` that accepts a byte string and</span>
    1362. 

  1362. <span class="sd">        returns an object suitable to be passed to this object&#39;s business</span>
    1363. 

  1363. <span class="sd">        logic, or None to indicate that this object&#39;s business logic should be</span>
    1364. 

  1364. <span class="sd">        passed the raw request bytes.</span>
    1365. 

  1365. <span class="sd">      response_serializer: A callable :term:`serializer` that accepts an object produced</span>
    1366. 

  1366. <span class="sd">        by this object&#39;s business logic and returns a byte string, or None to</span>
    1367. 

  1367. <span class="sd">        indicate that the byte strings produced by this object&#39;s business logic</span>
    1368. 

  1368. <span class="sd">        should be transmitted on the wire as they are.</span>
    1369. 

  1369. <span class="sd">      unary_unary: This object&#39;s application-specific business logic as a</span>
    1370. 

  1370. <span class="sd">        callable value that takes a request value and a ServicerContext object</span>
    1371. 

  1371. <span class="sd">        and returns a response value. Only non-None if both request_streaming</span>
    1372. 

  1372. <span class="sd">        and response_streaming are False.</span>
    1373. 

  1373. <span class="sd">      unary_stream: This object&#39;s application-specific business logic as a</span>
    1374. 

  1374. <span class="sd">        callable value that takes a request value and a ServicerContext object</span>
    1375. 

  1375. <span class="sd">        and returns an iterator of response values. Only non-None if</span>
    1376. 

  1376. <span class="sd">        request_streaming is False and response_streaming is True.</span>
    1377. 

  1377. <span class="sd">      stream_unary: This object&#39;s application-specific business logic as a</span>
    1378. 

  1378. <span class="sd">        callable value that takes an iterator of request values and a</span>
    1379. 

  1379. <span class="sd">        ServicerContext object and returns a response value. Only non-None if</span>
    1380. 

  1380. <span class="sd">        request_streaming is True and response_streaming is False.</span>
    1381. 

  1381. <span class="sd">      stream_stream: This object&#39;s application-specific business logic as a</span>
    1382. 

  1382. <span class="sd">        callable value that takes an iterator of request values and a</span>
    1383. 

  1383. <span class="sd">        ServicerContext object and returns an iterator of response values.</span>
    1384. 

  1384. <span class="sd">        Only non-None if request_streaming and response_streaming are both</span>
    1385. 

  1385. <span class="sd">        True.</span>
    1386. 

  1386. <span class="sd">    &quot;&quot;&quot;</span></div>
    1387. 

  1387. 

  1388. 

  1389. <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>
    1390. 

  1390.     <span class="sd">&quot;&quot;&quot;Describes an RPC that has just arrived for service.</span>
    1391. 

  1391. 

  1392. <span class="sd">    Attributes:</span>
    1393. 

  1393. <span class="sd">      method: The method name of the RPC.</span>
    1394. 

  1394. <span class="sd">      invocation_metadata: The :term:`metadata` sent by the client.</span>
    1395. 

  1395. <span class="sd">    &quot;&quot;&quot;</span></div>
    1396. 

  1396. 

  1397. 

  1398. <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>
    1399. 

  1399.     <span class="sd">&quot;&quot;&quot;An implementation of arbitrarily many RPC methods.&quot;&quot;&quot;</span>
    1400. 

  1400. 

  1401. <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>
    1402. 

  1402.     <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>
    1403. 

  1403.         <span class="sd">&quot;&quot;&quot;Returns the handler for servicing the RPC.</span>
    1404. 

  1404. 

  1405. <span class="sd">        Args:</span>
    1406. 

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

  1407. 

  1408. <span class="sd">        Returns:</span>
    1409. 

  1409. <span class="sd">          An RpcMethodHandler with which the RPC may be serviced if the</span>
    1410. 

  1410. <span class="sd">          implementation chooses to service this RPC, or None otherwise.</span>
    1411. 

  1411. <span class="sd">        &quot;&quot;&quot;</span>
    1412. 

  1412.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1413. 

  1413. 

  1414. 

  1415. <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>
    1416. 

  1416.     <span class="sd">&quot;&quot;&quot;An implementation of RPC methods belonging to a service.</span>
    1417. 

  1417. 

  1418. <span class="sd">    A service handles RPC methods with structured names of the form</span>
    1419. 

  1419. <span class="sd">    &#39;/Service.Name/Service.Method&#39;, where &#39;Service.Name&#39; is the value</span>
    1420. 

  1420. <span class="sd">    returned by service_name(), and &#39;Service.Method&#39; is the method</span>
    1421. 

  1421. <span class="sd">    name.  A service can have multiple method names, but only a single</span>
    1422. 

  1422. <span class="sd">    service name.</span>
    1423. 

  1423. <span class="sd">    &quot;&quot;&quot;</span>
    1424. 

  1424. 

  1425. <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>
    1426. 

  1426.     <span class="k">def</span> <span class="nf">service_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1427. 

  1427.         <span class="sd">&quot;&quot;&quot;Returns this service&#39;s name.</span>
    1428. 

  1428. 

  1429. <span class="sd">        Returns:</span>
    1430. 

  1430. <span class="sd">          The service name.</span>
    1431. 

  1431. <span class="sd">        &quot;&quot;&quot;</span>
    1432. 

  1432.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1433. 

  1433. 

  1434. 

  1435. <span class="c1">####################  Service-Side Interceptor Interfaces  #####################</span>
    1436. 

  1436. 

  1437. 

  1438. <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>
    1439. 

  1439.     <span class="sd">&quot;&quot;&quot;Affords intercepting incoming RPCs on the service-side.</span>
    1440. 

  1440. 

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

  1442. <span class="sd">    &quot;&quot;&quot;</span>
    1443. 

  1443. 

  1444. <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>
    1445. 

  1445.     <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>
    1446. 

  1446.         <span class="sd">&quot;&quot;&quot;Intercepts incoming RPCs before handing them over to a handler.</span>
    1447. 

  1447. 

  1448. <span class="sd">        Args:</span>
    1449. 

  1449. <span class="sd">          continuation: A function that takes a HandlerCallDetails and</span>
    1450. 

  1450. <span class="sd">            proceeds to invoke the next interceptor in the chain, if any,</span>
    1451. 

  1451. <span class="sd">            or the RPC handler lookup logic, with the call details passed</span>
    1452. 

  1452. <span class="sd">            as an argument, and returns an RpcMethodHandler instance if</span>
    1453. 

  1453. <span class="sd">            the RPC is considered serviced, or None otherwise.</span>
    1454. 

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

  1455. 

  1456. <span class="sd">        Returns:</span>
    1457. 

  1457. <span class="sd">          An RpcMethodHandler with which the RPC may be serviced if the</span>
    1458. 

  1458. <span class="sd">          interceptor chooses to service this RPC, or None otherwise.</span>
    1459. 

  1459. <span class="sd">        &quot;&quot;&quot;</span>
    1460. 

  1460.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1461. 

  1461. 

  1462. 

  1463. <span class="c1">#############################  Server Interface  ###############################</span>
    1464. 

  1464. 

  1465. 

  1466. <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>
    1467. 

  1467.     <span class="sd">&quot;&quot;&quot;Services RPCs.&quot;&quot;&quot;</span>
    1468. 

  1468. 

  1469. <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>
    1470. 

  1470.     <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>
    1471. 

  1471.         <span class="sd">&quot;&quot;&quot;Registers GenericRpcHandlers with this Server.</span>
    1472. 

  1472. 

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

  1474. 

  1475. <span class="sd">        Args:</span>
    1476. 

  1476. <span class="sd">          generic_rpc_handlers: An iterable of GenericRpcHandlers that will be</span>
    1477. 

  1477. <span class="sd">          used to service RPCs.</span>
    1478. 

  1478. <span class="sd">        &quot;&quot;&quot;</span>
    1479. 

  1479.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1480. 

  1480. 

  1481. <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>
    1482. 

  1482.     <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>
    1483. 

  1483.         <span class="sd">&quot;&quot;&quot;Opens an insecure port for accepting RPCs.</span>
    1484. 

  1484. 

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

  1486. 

  1487. <span class="sd">        Args:</span>
    1488. 

  1488. <span class="sd">          address: The address for which to open a port. If the port is 0,</span>
    1489. 

  1489. <span class="sd">            or not specified in the address, then gRPC runtime will choose a port.</span>
    1490. 

  1490. 

  1491. <span class="sd">        Returns:</span>
    1492. 

  1492. <span class="sd">          An integer port on which server will accept RPC requests.</span>
    1493. 

  1493. <span class="sd">        &quot;&quot;&quot;</span>
    1494. 

  1494.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1495. 

  1495. 

  1496. <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>
    1497. 

  1497.     <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>
    1498. 

  1498.         <span class="sd">&quot;&quot;&quot;Opens a secure port for accepting RPCs.</span>
    1499. 

  1499. 

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

  1501. 

  1502. <span class="sd">        Args:</span>
    1503. 

  1503. <span class="sd">          address: The address for which to open a port.</span>
    1504. 

  1504. <span class="sd">            if the port is 0, or not specified in the address, then gRPC</span>
    1505. 

  1505. <span class="sd">            runtime will choose a port.</span>
    1506. 

  1506. <span class="sd">          server_credentials: A ServerCredentials object.</span>
    1507. 

  1507. 

  1508. <span class="sd">        Returns:</span>
    1509. 

  1509. <span class="sd">          An integer port on which server will accept RPC requests.</span>
    1510. 

  1510. <span class="sd">        &quot;&quot;&quot;</span>
    1511. 

  1511.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1512. 

  1512. 

  1513. <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>
    1514. 

  1514.     <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1515. 

  1515.         <span class="sd">&quot;&quot;&quot;Starts this Server.</span>
    1516. 

  1516. 

  1517. <span class="sd">        This method may only be called once. (i.e. it is not idempotent).</span>
    1518. 

  1518. <span class="sd">        &quot;&quot;&quot;</span>
    1519. 

  1519.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1520. 

  1520. 

  1521. <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>
    1522. 

  1522.     <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>
    1523. 

  1523.         <span class="sd">&quot;&quot;&quot;Stops this Server.</span>
    1524. 

  1524. 

  1525. <span class="sd">        This method immediately stop service of new RPCs in all cases.</span>
    1526. 

  1526. 

  1527. <span class="sd">        If a grace period is specified, this method returns immediately</span>
    1528. 

  1528. <span class="sd">        and all RPCs active at the end of the grace period are aborted.</span>
    1529. 

  1529. <span class="sd">        If a grace period is not specified (by passing None for `grace`),</span>
    1530. 

  1530. <span class="sd">        all existing RPCs are aborted immediately and this method</span>
    1531. 

  1531. <span class="sd">        blocks until the last RPC handler terminates.</span>
    1532. 

  1532. 

  1533. <span class="sd">        This method is idempotent and may be called at any time.</span>
    1534. 

  1534. <span class="sd">        Passing a smaller grace value in a subsequent call will have</span>
    1535. 

  1535. <span class="sd">        the effect of stopping the Server sooner (passing None will</span>
    1536. 

  1536. <span class="sd">        have the effect of stopping the server immediately). Passing</span>
    1537. 

  1537. <span class="sd">        a larger grace value in a subsequent call *will not* have the</span>
    1538. 

  1538. <span class="sd">        effect of stopping the server later (i.e. the most restrictive</span>
    1539. 

  1539. <span class="sd">        grace value is used).</span>
    1540. 

  1540. 

  1541. <span class="sd">        Args:</span>
    1542. 

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

  1543. 

  1544. <span class="sd">        Returns:</span>
    1545. 

  1545. <span class="sd">          A threading.Event that will be set when this Server has completely</span>
    1546. 

  1546. <span class="sd">          stopped, i.e. when running RPCs either complete or are aborted and</span>
    1547. 

  1547. <span class="sd">          all handlers have terminated.</span>
    1548. 

  1548. <span class="sd">        &quot;&quot;&quot;</span>
    1549. 

  1549.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
    1550. 

  1550. 

  1551. <div class="viewcode-block" id="Server.wait_for_termination"><a class="viewcode-back" href="../grpc.html#grpc.Server.wait_for_termination">[docs]</a>    <span class="k">def</span> <span class="nf">wait_for_termination</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>
    1552. 

  1552.         <span class="sd">&quot;&quot;&quot;Block current thread until the server stops.</span>
    1553. 

  1553. 

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

  1555. 

  1556. <span class="sd">        The wait will not consume computational resources during blocking, and</span>
    1557. 

  1557. <span class="sd">        it will block until one of the two following conditions are met:</span>
    1558. 

  1558. 

  1559. <span class="sd">        1) The server is stopped or terminated;</span>
    1560. 

  1560. <span class="sd">        2) A timeout occurs if timeout is not `None`.</span>
    1561. 

  1561. 

  1562. <span class="sd">        The timeout argument works in the same way as `threading.Event.wait()`.</span>
    1563. 

  1563. <span class="sd">        https://docs.python.org/3/library/threading.html#threading.Event.wait</span>
    1564. 

  1564. 

  1565. <span class="sd">        Args:</span>
    1566. 

  1566. <span class="sd">          timeout: A floating point number specifying a timeout for the</span>
    1567. 

  1567. <span class="sd">            operation in seconds.</span>
    1568. 

  1568. 

  1569. <span class="sd">        Returns:</span>
    1570. 

  1570. <span class="sd">          A bool indicates if the operation times out.</span>
    1571. 

  1571. <span class="sd">        &quot;&quot;&quot;</span>
    1572. 

  1572.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
    1573. 

  1573. 

  1574. 

  1575. <span class="c1">#################################  Functions    ################################</span>
    1576. 

  1576. 

  1577. 

  1578. <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>
    1579. 

  1579.                                    <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1580. 

  1580.                                    <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1581. 

  1581.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-unary RPC method.</span>
    1582. 

  1582. 

  1583. <span class="sd">    Args:</span>
    1584. 

  1584. <span class="sd">      behavior: The implementation of an RPC that accepts one request</span>
    1585. 

  1585. <span class="sd">        and returns one response.</span>
    1586. 

  1586. <span class="sd">      request_deserializer: An optional :term:`deserializer` for request deserialization.</span>
    1587. 

  1587. <span class="sd">      response_serializer: An optional :term:`serializer` for response serialization.</span>
    1588. 

  1588. 

  1589. <span class="sd">    Returns:</span>
    1590. 

  1590. <span class="sd">      An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1591. 

  1591. <span class="sd">    &quot;&quot;&quot;</span>
    1592. 

  1592.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1593. 

  1593.     <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>
    1594. 

  1594.                                        <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>
    1595. 

  1595.                                        <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1596. 

  1596. 

  1597. 

  1598. <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>
    1599. 

  1599.                                     <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1600. 

  1600.                                     <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1601. 

  1601.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-stream RPC method.</span>
    1602. 

  1602. 

  1603. <span class="sd">    Args:</span>
    1604. 

  1604. <span class="sd">      behavior: The implementation of an RPC that accepts one request</span>
    1605. 

  1605. <span class="sd">        and returns an iterator of response values.</span>
    1606. 

  1606. <span class="sd">      request_deserializer: An optional :term:`deserializer` for request deserialization.</span>
    1607. 

  1607. <span class="sd">      response_serializer: An optional :term:`serializer` for response serialization.</span>
    1608. 

  1608. 

  1609. <span class="sd">    Returns:</span>
    1610. 

  1610. <span class="sd">      An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1611. 

  1611. <span class="sd">    &quot;&quot;&quot;</span>
    1612. 

  1612.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1613. 

  1613.     <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>
    1614. 

  1614.                                        <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>
    1615. 

  1615.                                        <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1616. 

  1616. 

  1617. 

  1618. <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>
    1619. 

  1619.                                     <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1620. 

  1620.                                     <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1621. 

  1621.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-unary RPC method.</span>
    1622. 

  1622. 

  1623. <span class="sd">    Args:</span>
    1624. 

  1624. <span class="sd">      behavior: The implementation of an RPC that accepts an iterator of</span>
    1625. 

  1625. <span class="sd">        request values and returns a single response value.</span>
    1626. 

  1626. <span class="sd">      request_deserializer: An optional :term:`deserializer` for request deserialization.</span>
    1627. 

  1627. <span class="sd">      response_serializer: An optional :term:`serializer` for response serialization.</span>
    1628. 

  1628. 

  1629. <span class="sd">    Returns:</span>
    1630. 

  1630. <span class="sd">      An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1631. 

  1631. <span class="sd">    &quot;&quot;&quot;</span>
    1632. 

  1632.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1633. 

  1633.     <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>
    1634. 

  1634.                                        <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>
    1635. 

  1635.                                        <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1636. 

  1636. 

  1637. 

  1638. <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>
    1639. 

  1639.                                      <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1640. 

  1640.                                      <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1641. 

  1641.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-stream RPC method.</span>
    1642. 

  1642. 

  1643. <span class="sd">    Args:</span>
    1644. 

  1644. <span class="sd">      behavior: The implementation of an RPC that accepts an iterator of</span>
    1645. 

  1645. <span class="sd">        request values and returns an iterator of response values.</span>
    1646. 

  1646. <span class="sd">      request_deserializer: An optional :term:`deserializer` for request deserialization.</span>
    1647. 

  1647. <span class="sd">      response_serializer: An optional :term:`serializer` for response serialization.</span>
    1648. 

  1648. 

  1649. <span class="sd">    Returns:</span>
    1650. 

  1650. <span class="sd">      An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1651. 

  1651. <span class="sd">    &quot;&quot;&quot;</span>
    1652. 

  1652.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1653. 

  1653.     <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>
    1654. 

  1654.                                        <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>
    1655. 

  1655.                                        <span class="n">behavior</span><span class="p">)</span></div>
    1656. 

  1656. 

  1657. 

  1658. <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>
    1659. 

  1659.     <span class="sd">&quot;&quot;&quot;Creates a GenericRpcHandler from RpcMethodHandlers.</span>
    1660. 

  1660. 

  1661. <span class="sd">    Args:</span>
    1662. 

  1662. <span class="sd">      service: The name of the service that is implemented by the</span>
    1663. 

  1663. <span class="sd">        method_handlers.</span>
    1664. 

  1664. <span class="sd">      method_handlers: A dictionary that maps method names to corresponding</span>
    1665. 

  1665. <span class="sd">        RpcMethodHandler.</span>
    1666. 

  1666. 

  1667. <span class="sd">    Returns:</span>
    1668. 

  1668. <span class="sd">      A GenericRpcHandler. This is typically added to the grpc.Server object</span>
    1669. 

  1669. <span class="sd">      with add_generic_rpc_handlers() before starting the server.</span>
    1670. 

  1670. <span class="sd">    &quot;&quot;&quot;</span>
    1671. 

  1671.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1672. 

  1672.     <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>
    1673. 

  1673. 

  1674. 

  1675. <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>
    1676. 

  1676.                             <span class="n">private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1677. 

  1677.                             <span class="n">certificate_chain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1678. 

  1678.     <span class="sd">&quot;&quot;&quot;Creates a ChannelCredentials for use with an SSL-enabled Channel.</span>
    1679. 

  1679. 

  1680. <span class="sd">    Args:</span>
    1681. 

  1681. <span class="sd">      root_certificates: The PEM-encoded root certificates as a byte string,</span>
    1682. 

  1682. <span class="sd">        or None to retrieve them from a default location chosen by gRPC</span>
    1683. 

  1683. <span class="sd">        runtime.</span>
    1684. 

  1684. <span class="sd">      private_key: The PEM-encoded private key as a byte string, or None if no</span>
    1685. 

  1685. <span class="sd">        private key should be used.</span>
    1686. 

  1686. <span class="sd">      certificate_chain: The PEM-encoded certificate chain as a byte string</span>
    1687. 

  1687. <span class="sd">        to use or None if no certificate chain should be used.</span>
    1688. 

  1688. 

  1689. <span class="sd">    Returns:</span>
    1690. 

  1690. <span class="sd">      A ChannelCredentials for use with an SSL-enabled Channel.</span>
    1691. 

  1691. <span class="sd">    &quot;&quot;&quot;</span>
    1692. 

  1692.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1693. 

  1693.         <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>
    1694. 

  1694.                                       <span class="n">certificate_chain</span><span class="p">))</span></div>
    1695. 

  1695. 

  1696. 

  1697. <span class="k">def</span> <span class="nf">xds_channel_credentials</span><span class="p">(</span><span class="n">fallback_credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1698. 

  1698.     <span class="sd">&quot;&quot;&quot;Creates a ChannelCredentials for use with xDS. This is an EXPERIMENTAL</span>
    1699. 

  1699. <span class="sd">      API.</span>
    1700. 

  1700. 

  1701. <span class="sd">    Args:</span>
    1702. 

  1702. <span class="sd">      fallback_credentials: Credentials to use in case it is not possible to</span>
    1703. 

  1703. <span class="sd">        establish a secure connection via xDS. If no fallback_credentials</span>
    1704. 

  1704. <span class="sd">        argument is supplied, a default SSLChannelCredentials is used.</span>
    1705. 

  1705. <span class="sd">    &quot;&quot;&quot;</span>
    1706. 

  1706.     <span class="n">fallback_credentials</span> <span class="o">=</span> <span class="n">ssl_channel_credentials</span><span class="p">(</span>
    1707. 

  1707.     <span class="p">)</span> <span class="k">if</span> <span class="n">fallback_credentials</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">fallback_credentials</span>
    1708. 

  1708.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1709. 

  1709.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">XDSChannelCredentials</span><span class="p">(</span><span class="n">fallback_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span>
    1710. 

  1710. 

  1711. 

  1712. <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>
    1713. 

  1713.     <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an AuthMetadataPlugin.</span>
    1714. 

  1714. 

  1715. <span class="sd">    Args:</span>
    1716. 

  1716. <span class="sd">      metadata_plugin: An AuthMetadataPlugin to use for authentication.</span>
    1717. 

  1717. <span class="sd">      name: An optional name for the plugin.</span>
    1718. 

  1718. 

  1719. <span class="sd">    Returns:</span>
    1720. 

  1720. <span class="sd">      A CallCredentials.</span>
    1721. 

  1721. <span class="sd">    &quot;&quot;&quot;</span>
    1722. 

  1722.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_plugin_wrapping</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1723. 

  1723.     <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>
    1724. 

  1724.         <span class="n">metadata_plugin</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
    1725. 

  1725. 

  1726. 

  1727. <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>
    1728. 

  1728.     <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an access token.</span>
    1729. 

  1729. 

  1730. <span class="sd">    Args:</span>
    1731. 

  1731. <span class="sd">      access_token: A string to place directly in the http request</span>
    1732. 

  1732. <span class="sd">        authorization header, for example</span>
    1733. 

  1733. <span class="sd">        &quot;authorization: Bearer &lt;access_token&gt;&quot;.</span>
    1734. 

  1734. 

  1735. <span class="sd">    Returns:</span>
    1736. 

  1736. <span class="sd">      A CallCredentials.</span>
    1737. 

  1737. <span class="sd">    &quot;&quot;&quot;</span>
    1738. 

  1738.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_auth</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1739. 

  1739.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_plugin_wrapping</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1740. 

  1740.     <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>
    1741. 

  1741.         <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>
    1742. 

  1742. 

  1743. 

  1744. <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>
    1745. 

  1745.     <span class="sd">&quot;&quot;&quot;Compose multiple CallCredentials to make a new CallCredentials.</span>
    1746. 

  1746. 

  1747. <span class="sd">    Args:</span>
    1748. 

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

  1749. 

  1750. <span class="sd">    Returns:</span>
    1751. 

  1751. <span class="sd">      A CallCredentials object composed of the given CallCredentials objects.</span>
    1752. 

  1752. <span class="sd">    &quot;&quot;&quot;</span>
    1753. 

  1753.     <span class="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
    1754. 

  1754.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeCallCredentials</span><span class="p">(</span>
    1755. 

  1755.             <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>
    1756. 

  1756.                   <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>
    1757. 

  1757. 

  1758. 

  1759. <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>
    1760. 

  1760.     <span class="sd">&quot;&quot;&quot;Compose a ChannelCredentials and one or more CallCredentials objects.</span>
    1761. 

  1761. 

  1762. <span class="sd">    Args:</span>
    1763. 

  1763. <span class="sd">      channel_credentials: A ChannelCredentials object.</span>
    1764. 

  1764. <span class="sd">      *call_credentials: One or more CallCredentials objects.</span>
    1765. 

  1765. 

  1766. <span class="sd">    Returns:</span>
    1767. 

  1767. <span class="sd">      A ChannelCredentials composed of the given ChannelCredentials and</span>
    1768. 

  1768. <span class="sd">        CallCredentials objects.</span>
    1769. 

  1769. <span class="sd">    &quot;&quot;&quot;</span>
    1770. 

  1770.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1771. 

  1771.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeChannelCredentials</span><span class="p">(</span>
    1772. 

  1772.             <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>
    1773. 

  1773.                   <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>
    1774. 

  1774.             <span class="n">channel_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
    1775. 

  1775. 

  1776. 

  1777. <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>
    1778. 

  1778.                            <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1779. 

  1779.                            <span class="n">require_client_auth</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1780. 

  1780.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an SSL-enabled Server.</span>
    1781. 

  1781. 

  1782. <span class="sd">    Args:</span>
    1783. 

  1783. <span class="sd">      private_key_certificate_chain_pairs: A list of pairs of the form</span>
    1784. 

  1784. <span class="sd">        [PEM-encoded private key, PEM-encoded certificate chain].</span>
    1785. 

  1785. <span class="sd">      root_certificates: An optional byte string of PEM-encoded client root</span>
    1786. 

  1786. <span class="sd">        certificates that the server will use to verify client authentication.</span>
    1787. 

  1787. <span class="sd">        If omitted, require_client_auth must also be False.</span>
    1788. 

  1788. <span class="sd">      require_client_auth: A boolean indicating whether or not to require</span>
    1789. 

  1789. <span class="sd">        clients to be authenticated. May only be True if root_certificates</span>
    1790. 

  1790. <span class="sd">        is not None.</span>
    1791. 

  1791. 

  1792. <span class="sd">    Returns:</span>
    1793. 

  1793. <span class="sd">      A ServerCredentials for use with an SSL-enabled Server. Typically, this</span>
    1794. 

  1794. <span class="sd">      object is an argument to add_secure_port() method during server setup.</span>
    1795. 

  1795. <span class="sd">    &quot;&quot;&quot;</span>
    1796. 

  1796.     <span class="k">if</span> <span class="ow">not</span> <span class="n">private_key_certificate_chain_pairs</span><span class="p">:</span>
    1797. 

  1797.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1798. 

  1798.             <span class="s1">&#39;At least one private key-certificate chain pair is required!&#39;</span><span class="p">)</span>
    1799. 

  1799.     <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>
    1800. 

  1800.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1801. 

  1801.             <span class="s1">&#39;Illegal to require client auth without providing root certificates!&#39;</span>
    1802. 

  1802.         <span class="p">)</span>
    1803. 

  1803.     <span class="k">else</span><span class="p">:</span>
    1804. 

  1804.         <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1805. 

  1805.             <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>
    1806. 

  1806.                 <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>
    1807. 

  1807.                 <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>
    1808. 

  1808.             <span class="p">],</span> <span class="n">require_client_auth</span><span class="p">))</span></div>
    1809. 

  1809. 

  1810. 

  1811. <span class="k">def</span> <span class="nf">xds_server_credentials</span><span class="p">(</span><span class="n">fallback_credentials</span><span class="p">):</span>
    1812. 

  1812.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with xDS. This is an EXPERIMENTAL</span>
    1813. 

  1813. <span class="sd">      API.</span>
    1814. 

  1814. 

  1815. <span class="sd">    Args:</span>
    1816. 

  1816. <span class="sd">      fallback_credentials: Credentials to use in case it is not possible to</span>
    1817. 

  1817. <span class="sd">        establish a secure connection via xDS. No default value is provided.</span>
    1818. 

  1818. <span class="sd">    &quot;&quot;&quot;</span>
    1819. 

  1819.     <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1820. 

  1820.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">xds_server_credentials</span><span class="p">(</span><span class="n">fallback_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span>
    1821. 

  1821. 

  1822. 

  1823. <span class="k">def</span> <span class="nf">insecure_server_credentials</span><span class="p">():</span>
    1824. 

  1824.     <span class="sd">&quot;&quot;&quot;Creates a credentials object directing the server to use no credentials.</span>
    1825. 

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

  1826. 

  1827. <span class="sd">    This object cannot be used directly in a call to `add_secure_port`.</span>
    1828. 

  1828. <span class="sd">    Instead, it should be used to construct other credentials objects, e.g.</span>
    1829. 

  1829. <span class="sd">    with xds_server_credentials.</span>
    1830. 

  1830. <span class="sd">    &quot;&quot;&quot;</span>
    1831. 

  1831.     <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">insecure_server_credentials</span><span class="p">())</span>
    1832. 

  1832. 

  1833. 

  1834. <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>
    1835. 

  1835.                                          <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1836. 

  1836.     <span class="sd">&quot;&quot;&quot;Creates a ServerCertificateConfiguration for use with a Server.</span>
    1837. 

  1837. 

  1838. <span class="sd">    Args:</span>
    1839. 

  1839. <span class="sd">      private_key_certificate_chain_pairs: A collection of pairs of</span>
    1840. 

  1840. <span class="sd">        the form [PEM-encoded private key, PEM-encoded certificate</span>
    1841. 

  1841. <span class="sd">        chain].</span>
    1842. 

  1842. <span class="sd">      root_certificates: An optional byte string of PEM-encoded client root</span>
    1843. 

  1843. <span class="sd">        certificates that the server will use to verify client authentication.</span>
    1844. 

  1844. 

  1845. <span class="sd">    Returns:</span>
    1846. 

  1846. <span class="sd">      A ServerCertificateConfiguration that can be returned in the certificate</span>
    1847. 

  1847. <span class="sd">        configuration fetching callback.</span>
    1848. 

  1848. <span class="sd">    &quot;&quot;&quot;</span>
    1849. 

  1849.     <span class="k">if</span> <span class="n">private_key_certificate_chain_pairs</span><span class="p">:</span>
    1850. 

  1850.         <span class="k">return</span> <span class="n">ServerCertificateConfiguration</span><span class="p">(</span>
    1851. 

  1851.             <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>
    1852. 

  1852.                 <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>
    1853. 

  1853.                 <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>
    1854. 

  1854.             <span class="p">]))</span>
    1855. 

  1855.     <span class="k">else</span><span class="p">:</span>
    1856. 

  1856.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1857. 

  1857.             <span class="s1">&#39;At least one private key-certificate chain pair is required!&#39;</span><span class="p">)</span></div>
    1858. 

  1858. 

  1859. 

  1860. <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>
    1861. 

  1861.                                    <span class="n">certificate_configuration_fetcher</span><span class="p">,</span>
    1862. 

  1862.                                    <span class="n">require_client_authentication</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1863. 

  1863.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an SSL-enabled Server.</span>
    1864. 

  1864. 

  1865. <span class="sd">    Args:</span>
    1866. 

  1866. <span class="sd">      initial_certificate_configuration (ServerCertificateConfiguration): The</span>
    1867. 

  1867. <span class="sd">        certificate configuration with which the server will be initialized.</span>
    1868. 

  1868. <span class="sd">      certificate_configuration_fetcher (callable): A callable that takes no</span>
    1869. 

  1869. <span class="sd">        arguments and should return a ServerCertificateConfiguration to</span>
    1870. 

  1870. <span class="sd">        replace the server&#39;s current certificate, or None for no change</span>
    1871. 

  1871. <span class="sd">        (i.e., the server will continue its current certificate</span>
    1872. 

  1872. <span class="sd">        config). The library will call this callback on *every* new</span>
    1873. 

  1873. <span class="sd">        client connection before starting the TLS handshake with the</span>
    1874. 

  1874. <span class="sd">        client, thus allowing the user application to optionally</span>
    1875. 

  1875. <span class="sd">        return a new ServerCertificateConfiguration that the server will then</span>
    1876. 

  1876. <span class="sd">        use for the handshake.</span>
    1877. 

  1877. <span class="sd">      require_client_authentication: A boolean indicating whether or not to</span>
    1878. 

  1878. <span class="sd">        require clients to be authenticated.</span>
    1879. 

  1879. 

  1880. <span class="sd">    Returns:</span>
    1881. 

  1881. <span class="sd">      A ServerCredentials.</span>
    1882. 

  1882. <span class="sd">    &quot;&quot;&quot;</span>
    1883. 

  1883.     <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1884. 

  1884.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_credentials_ssl_dynamic_cert_config</span><span class="p">(</span>
    1885. 

  1885.             <span class="n">initial_certificate_configuration</span><span class="p">,</span>
    1886. 

  1886.             <span class="n">certificate_configuration_fetcher</span><span class="p">,</span> <span class="n">require_client_authentication</span><span class="p">))</span></div>
    1887. 

  1887. 

  1888. 

  1889. <div class="viewcode-block" id="LocalConnectionType"><a class="viewcode-back" href="../grpc.html#grpc.LocalConnectionType">[docs]</a><span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
    1890. 

  1890. <span class="k">class</span> <span class="nc">LocalConnectionType</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
    1891. 

  1891.     <span class="sd">&quot;&quot;&quot;Types of local connection for local credential creation.</span>
    1892. 

  1892. 

  1893. <span class="sd">    Attributes:</span>
    1894. 

  1894. <span class="sd">      UDS: Unix domain socket connections</span>
    1895. 

  1895. <span class="sd">      LOCAL_TCP: Local TCP connections.</span>
    1896. 

  1896. <span class="sd">    &quot;&quot;&quot;</span>
    1897. 

  1897.     <span class="n">UDS</span> <span class="o">=</span> <span class="n">_cygrpc</span><span class="o">.</span><span class="n">LocalConnectionType</span><span class="o">.</span><span class="n">uds</span>
    1898. 

  1898.     <span class="n">LOCAL_TCP</span> <span class="o">=</span> <span class="n">_cygrpc</span><span class="o">.</span><span class="n">LocalConnectionType</span><span class="o">.</span><span class="n">local_tcp</span></div>
    1899. 

  1899. 

  1900. 

  1901. <div class="viewcode-block" id="local_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.local_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">local_channel_credentials</span><span class="p">(</span><span class="n">local_connect_type</span><span class="o">=</span><span class="n">LocalConnectionType</span><span class="o">.</span><span class="n">LOCAL_TCP</span><span class="p">):</span>
    1902. 

  1902.     <span class="sd">&quot;&quot;&quot;Creates a local ChannelCredentials used for local connections.</span>
    1903. 

  1903. 

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

  1905. 

  1906. <span class="sd">    Local credentials are used by local TCP endpoints (e.g. localhost:10000)</span>
    1907. 

  1907. <span class="sd">    also UDS connections.</span>
    1908. 

  1908. 

  1909. <span class="sd">    The connections created by local channel credentials are not</span>
    1910. 

  1910. <span class="sd">    encrypted, but will be checked if they are local or not.</span>
    1911. 

  1911. <span class="sd">    The UDS connections are considered secure by providing peer authentication</span>
    1912. 

  1912. <span class="sd">    and data confidentiality while TCP connections are considered insecure.</span>
    1913. 

  1913. 

  1914. <span class="sd">    It is allowed to transmit call credentials over connections created by</span>
    1915. 

  1915. <span class="sd">    local channel credentials.</span>
    1916. 

  1916. 

  1917. <span class="sd">    Local channel credentials are useful for 1) eliminating insecure_channel usage;</span>
    1918. 

  1918. <span class="sd">    2) enable unit testing for call credentials without setting up secrets.</span>
    1919. 

  1919. 

  1920. <span class="sd">    Args:</span>
    1921. 

  1921. <span class="sd">      local_connect_type: Local connection type (either</span>
    1922. 

  1922. <span class="sd">        grpc.LocalConnectionType.UDS or grpc.LocalConnectionType.LOCAL_TCP)</span>
    1923. 

  1923. 

  1924. <span class="sd">    Returns:</span>
    1925. 

  1925. <span class="sd">      A ChannelCredentials for use with a local Channel</span>
    1926. 

  1926. <span class="sd">    &quot;&quot;&quot;</span>
    1927. 

  1927.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1928. 

  1928.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_local</span><span class="p">(</span><span class="n">local_connect_type</span><span class="o">.</span><span class="n">value</span><span class="p">))</span></div>
    1929. 

  1929. 

  1930. 

  1931. <div class="viewcode-block" id="local_server_credentials"><a class="viewcode-back" href="../grpc.html#grpc.local_server_credentials">[docs]</a><span class="k">def</span> <span class="nf">local_server_credentials</span><span class="p">(</span><span class="n">local_connect_type</span><span class="o">=</span><span class="n">LocalConnectionType</span><span class="o">.</span><span class="n">LOCAL_TCP</span><span class="p">):</span>
    1932. 

  1932.     <span class="sd">&quot;&quot;&quot;Creates a local ServerCredentials used for local connections.</span>
    1933. 

  1933. 

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

  1935. 

  1936. <span class="sd">    Local credentials are used by local TCP endpoints (e.g. localhost:10000)</span>
    1937. 

  1937. <span class="sd">    also UDS connections.</span>
    1938. 

  1938. 

  1939. <span class="sd">    The connections created by local server credentials are not</span>
    1940. 

  1940. <span class="sd">    encrypted, but will be checked if they are local or not.</span>
    1941. 

  1941. <span class="sd">    The UDS connections are considered secure by providing peer authentication</span>
    1942. 

  1942. <span class="sd">    and data confidentiality while TCP connections are considered insecure.</span>
    1943. 

  1943. 

  1944. <span class="sd">    It is allowed to transmit call credentials over connections created by local</span>
    1945. 

  1945. <span class="sd">    server credentials.</span>
    1946. 

  1946. 

  1947. <span class="sd">    Local server credentials are useful for 1) eliminating insecure_channel usage;</span>
    1948. 

  1948. <span class="sd">    2) enable unit testing for call credentials without setting up secrets.</span>
    1949. 

  1949. 

  1950. <span class="sd">    Args:</span>
    1951. 

  1951. <span class="sd">      local_connect_type: Local connection type (either</span>
    1952. 

  1952. <span class="sd">        grpc.LocalConnectionType.UDS or grpc.LocalConnectionType.LOCAL_TCP)</span>
    1953. 

  1953. 

  1954. <span class="sd">    Returns:</span>
    1955. 

  1955. <span class="sd">      A ServerCredentials for use with a local Server</span>
    1956. 

  1956. <span class="sd">    &quot;&quot;&quot;</span>
    1957. 

  1957.     <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1958. 

  1958.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_credentials_local</span><span class="p">(</span><span class="n">local_connect_type</span><span class="o">.</span><span class="n">value</span><span class="p">))</span></div>
    1959. 

  1959. 

  1960. 

  1961. <span class="k">def</span> <span class="nf">alts_channel_credentials</span><span class="p">(</span><span class="n">service_accounts</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1962. 

  1962.     <span class="sd">&quot;&quot;&quot;Creates a ChannelCredentials for use with an ALTS-enabled Channel.</span>
    1963. 

  1963. 

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

  1965. <span class="sd">    ALTS credentials API can only be used in GCP environment as it relies on</span>
    1966. 

  1966. <span class="sd">    handshaker service being available. For more info about ALTS see</span>
    1967. 

  1967. <span class="sd">    https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</span>
    1968. 

  1968. 

  1969. <span class="sd">    Args:</span>
    1970. 

  1970. <span class="sd">      service_accounts: A list of server identities accepted by the client.</span>
    1971. 

  1971. <span class="sd">        If target service accounts are provided and none of them matches the</span>
    1972. 

  1972. <span class="sd">        peer identity of the server, handshake will fail. The arg can be empty</span>
    1973. 

  1973. <span class="sd">        if the client does not have any information about trusted server</span>
    1974. 

  1974. <span class="sd">        identity.</span>
    1975. 

  1975. <span class="sd">    Returns:</span>
    1976. 

  1976. <span class="sd">      A ChannelCredentials for use with an ALTS-enabled Channel</span>
    1977. 

  1977. <span class="sd">    &quot;&quot;&quot;</span>
    1978. 

  1978.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1979. 

  1979.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_alts</span><span class="p">(</span><span class="n">service_accounts</span> <span class="ow">or</span> <span class="p">[]))</span>
    1980. 

  1980. 

  1981. 

  1982. <span class="k">def</span> <span class="nf">alts_server_credentials</span><span class="p">():</span>
    1983. 

  1983.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an ALTS-enabled connection.</span>
    1984. 

  1984. 

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

  1986. <span class="sd">    ALTS credentials API can only be used in GCP environment as it relies on</span>
    1987. 

  1987. <span class="sd">    handshaker service being available. For more info about ALTS see</span>
    1988. 

  1988. <span class="sd">    https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</span>
    1989. 

  1989. 

  1990. <span class="sd">    Returns:</span>
    1991. 

  1991. <span class="sd">      A ServerCredentials for use with an ALTS-enabled Server</span>
    1992. 

  1992. <span class="sd">    &quot;&quot;&quot;</span>
    1993. 

  1993.     <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_alts</span><span class="p">())</span>
    1994. 

  1994. 

  1995. 

  1996. <div class="viewcode-block" id="compute_engine_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.compute_engine_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">compute_engine_channel_credentials</span><span class="p">(</span><span class="n">call_credentials</span><span class="p">):</span>
    1997. 

  1997.     <span class="sd">&quot;&quot;&quot;Creates a compute engine channel credential.</span>
    1998. 

  1998. 

  1999. <span class="sd">    This credential can only be used in a GCP environment as it relies on</span>
    2000. 

  2000. <span class="sd">    a handshaker service. For more info about ALTS, see</span>
    2001. 

  2001. <span class="sd">    https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</span>
    2002. 

  2002. 

  2003. <span class="sd">    This channel credential is expected to be used as part of a composite</span>
    2004. 

  2004. <span class="sd">    credential in conjunction with a call credentials that authenticates the</span>
    2005. 

  2005. <span class="sd">    VM&#39;s default service account. If used with any other sort of call</span>
    2006. 

  2006. <span class="sd">    credential, the connection may suddenly and unexpectedly begin failing RPCs.</span>
    2007. 

  2007. <span class="sd">    &quot;&quot;&quot;</span>
    2008. 

  2008.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    2009. 

  2009.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_compute_engine</span><span class="p">(</span>
    2010. 

  2010.             <span class="n">call_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
    2011. 

  2011. 

  2012. 

  2013. <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>
    2014. 

  2014.     <span class="sd">&quot;&quot;&quot;Creates a Future that tracks when a Channel is ready.</span>
    2015. 

  2015. 

  2016. <span class="sd">    Cancelling the Future does not affect the channel&#39;s state machine.</span>
    2017. 

  2017. <span class="sd">    It merely decouples the Future from channel state machine.</span>
    2018. 

  2018. 

  2019. <span class="sd">    Args:</span>
    2020. 

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

  2021. 

  2022. <span class="sd">    Returns:</span>
    2023. 

  2023. <span class="sd">      A Future object that matures when the channel connectivity is</span>
    2024. 

  2024. <span class="sd">      ChannelConnectivity.READY.</span>
    2025. 

  2025. <span class="sd">    &quot;&quot;&quot;</span>
    2026. 

  2026.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2027. 

  2027.     <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>
    2028. 

  2028. 

  2029. 

  2030. <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="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    2031. 

  2031.     <span class="sd">&quot;&quot;&quot;Creates an insecure Channel to a server.</span>
    2032. 

  2032. 

  2033. <span class="sd">    The returned Channel is thread-safe.</span>
    2034. 

  2034. 

  2035. <span class="sd">    Args:</span>
    2036. 

  2036. <span class="sd">      target: The server address</span>
    2037. 

  2037. <span class="sd">      options: An optional list of key-value pairs (:term:`channel_arguments`</span>
    2038. 

  2038. <span class="sd">        in gRPC Core runtime) to configure the channel.</span>
    2039. 

  2039. <span class="sd">      compression: An optional value indicating the compression method to be</span>
    2040. 

  2040. <span class="sd">        used over the lifetime of the channel. This is an EXPERIMENTAL option.</span>
    2041. 

  2041. 

  2042. <span class="sd">    Returns:</span>
    2043. 

  2043. <span class="sd">      A Channel.</span>
    2044. 

  2044. <span class="sd">    &quot;&quot;&quot;</span>
    2045. 

  2045.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2046. 

  2046.     <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>
    2047. 

  2047.                             <span class="n">compression</span><span class="p">)</span></div>
    2048. 

  2048. 

  2049. 

  2050. <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="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    2051. 

  2051.     <span class="sd">&quot;&quot;&quot;Creates a secure Channel to a server.</span>
    2052. 

  2052. 

  2053. <span class="sd">    The returned Channel is thread-safe.</span>
    2054. 

  2054. 

  2055. <span class="sd">    Args:</span>
    2056. 

  2056. <span class="sd">      target: The server address.</span>
    2057. 

  2057. <span class="sd">      credentials: A ChannelCredentials instance.</span>
    2058. 

  2058. <span class="sd">      options: An optional list of key-value pairs (:term:`channel_arguments`</span>
    2059. 

  2059. <span class="sd">        in gRPC Core runtime) to configure the channel.</span>
    2060. 

  2060. <span class="sd">      compression: An optional value indicating the compression method to be</span>
    2061. 

  2061. <span class="sd">        used over the lifetime of the channel. This is an EXPERIMENTAL option.</span>
    2062. 

  2062. 

  2063. <span class="sd">    Returns:</span>
    2064. 

  2064. <span class="sd">      A Channel.</span>
    2065. 

  2065. <span class="sd">    &quot;&quot;&quot;</span>
    2066. 

  2066.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2067. 

  2067.     <span class="kn">from</span> <span class="nn">grpc.experimental</span> <span class="kn">import</span> <span class="n">_insecure_channel_credentials</span>
    2068. 

  2068.     <span class="k">if</span> <span class="n">credentials</span><span class="o">.</span><span class="n">_credentials</span> <span class="ow">is</span> <span class="n">_insecure_channel_credentials</span><span class="p">:</span>
    2069. 

  2069.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    2070. 

  2070.             <span class="s2">&quot;secure_channel cannot be called with insecure credentials.&quot;</span> <span class="o">+</span>
    2071. 

  2071.             <span class="s2">&quot; Call insecure_channel instead.&quot;</span><span class="p">)</span>
    2072. 

  2072.     <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>
    2073. 

  2073.                             <span class="n">credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">,</span> <span class="n">compression</span><span class="p">)</span></div>
    2074. 

  2074. 

  2075. 

  2076. <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>
    2077. 

  2077.     <span class="sd">&quot;&quot;&quot;Intercepts a channel through a set of interceptors.</span>
    2078. 

  2078. 

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

  2080. 

  2081. <span class="sd">    Args:</span>
    2082. 

  2082. <span class="sd">      channel: A Channel.</span>
    2083. 

  2083. <span class="sd">      interceptors: Zero or more objects of type</span>
    2084. 

  2084. <span class="sd">        UnaryUnaryClientInterceptor,</span>
    2085. 

  2085. <span class="sd">        UnaryStreamClientInterceptor,</span>
    2086. 

  2086. <span class="sd">        StreamUnaryClientInterceptor, or</span>
    2087. 

  2087. <span class="sd">        StreamStreamClientInterceptor.</span>
    2088. 

  2088. <span class="sd">        Interceptors are given control in the order they are listed.</span>
    2089. 

  2089. 

  2090. <span class="sd">    Returns:</span>
    2091. 

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

  2092. 

  2093. <span class="sd">    Raises:</span>
    2094. 

  2094. <span class="sd">      TypeError: If interceptor does not derive from any of</span>
    2095. 

  2095. <span class="sd">        UnaryUnaryClientInterceptor,</span>
    2096. 

  2096. <span class="sd">        UnaryStreamClientInterceptor,</span>
    2097. 

  2097. <span class="sd">        StreamUnaryClientInterceptor, or</span>
    2098. 

  2098. <span class="sd">        StreamStreamClientInterceptor.</span>
    2099. 

  2099. <span class="sd">    &quot;&quot;&quot;</span>
    2100. 

  2100.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_interceptor</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2101. 

  2101.     <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>
    2102. 

  2102. 

  2103. 

  2104. <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>
    2105. 

  2105.            <span class="n">handlers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    2106. 

  2106.            <span class="n">interceptors</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    2107. 

  2107.            <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    2108. 

  2108.            <span class="n">maximum_concurrent_rpcs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    2109. 

  2109.            <span class="n">compression</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    2110. 

  2110.            <span class="n">xds</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    2111. 

  2111.     <span class="sd">&quot;&quot;&quot;Creates a Server with which RPCs can be serviced.</span>
    2112. 

  2112. 

  2113. <span class="sd">    Args:</span>
    2114. 

  2114. <span class="sd">      thread_pool: A futures.ThreadPoolExecutor to be used by the Server</span>
    2115. 

  2115. <span class="sd">        to execute RPC handlers.</span>
    2116. 

  2116. <span class="sd">      handlers: An optional list of GenericRpcHandlers used for executing RPCs.</span>
    2117. 

  2117. <span class="sd">        More handlers may be added by calling add_generic_rpc_handlers any time</span>
    2118. 

  2118. <span class="sd">        before the server is started.</span>
    2119. 

  2119. <span class="sd">      interceptors: An optional list of ServerInterceptor objects that observe</span>
    2120. 

  2120. <span class="sd">        and optionally manipulate the incoming RPCs before handing them over to</span>
    2121. 

  2121. <span class="sd">        handlers. The interceptors are given control in the order they are</span>
    2122. 

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

  2123. <span class="sd">      options: An optional list of key-value pairs (:term:`channel_arguments` in gRPC runtime)</span>
    2124. 

  2124. <span class="sd">        to configure the channel.</span>
    2125. 

  2125. <span class="sd">      maximum_concurrent_rpcs: The maximum number of concurrent RPCs this server</span>
    2126. 

  2126. <span class="sd">        will service before returning RESOURCE_EXHAUSTED status, or None to</span>
    2127. 

  2127. <span class="sd">        indicate no limit.</span>
    2128. 

  2128. <span class="sd">      compression: An element of grpc.compression, e.g.</span>
    2129. 

  2129. <span class="sd">        grpc.compression.Gzip. This compression algorithm will be used for the</span>
    2130. 

  2130. <span class="sd">        lifetime of the server unless overridden. This is an EXPERIMENTAL option.</span>
    2131. 

  2131. <span class="sd">      xds: If set to true, retrieves server configuration via xDS. This is an</span>
    2132. 

  2132. <span class="sd">        EXPERIMENTAL option.</span>
    2133. 

  2133. 

  2134. <span class="sd">    Returns:</span>
    2135. 

  2135. <span class="sd">      A Server object.</span>
    2136. 

  2136. <span class="sd">    &quot;&quot;&quot;</span>
    2137. 

  2137.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_server</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2138. 

  2138.     <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>
    2139. 

  2139.                                  <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>
    2140. 

  2140.                                  <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>
    2141. 

  2141.                                  <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>
    2142. 

  2142.                                  <span class="n">maximum_concurrent_rpcs</span><span class="p">,</span> <span class="n">compression</span><span class="p">,</span> <span class="n">xds</span><span class="p">)</span></div>
    2143. 

  2143. 

  2144. 

  2145. <span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
    2146. 

  2146. <span class="k">def</span> <span class="nf">_create_servicer_context</span><span class="p">(</span><span class="n">rpc_event</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">):</span>
    2147. 

  2147.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_server</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    2148. 

  2148.     <span class="n">context</span> <span class="o">=</span> <span class="n">_server</span><span class="o">.</span><span class="n">_Context</span><span class="p">(</span><span class="n">rpc_event</span><span class="p">,</span> <span class="n">state</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">)</span>
    2149. 

  2149.     <span class="k">yield</span> <span class="n">context</span>
    2150. 

  2150.     <span class="n">context</span><span class="o">.</span><span class="n">_finalize_state</span><span class="p">()</span>  <span class="c1"># pylint: disable=protected-access</span>
    2151. 

  2151. 

  2152. 

  2153. <div class="viewcode-block" id="Compression"><a class="viewcode-back" href="../grpc.html#grpc.Compression">[docs]</a><span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
    2154. 

  2154. <span class="k">class</span> <span class="nc">Compression</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">IntEnum</span><span class="p">):</span>
    2155. 

  2155.     <span class="sd">&quot;&quot;&quot;Indicates the compression method to be used for an RPC.</span>
    2156. 

  2156. 

  2157. <span class="sd">       This enumeration is part of an EXPERIMENTAL API.</span>
    2158. 

  2158. 

  2159. <span class="sd">       Attributes:</span>
    2160. 

  2160. <span class="sd">        NoCompression: Do not use compression algorithm.</span>
    2161. 

  2161. <span class="sd">        Deflate: Use &quot;Deflate&quot; compression algorithm.</span>
    2162. 

  2162. <span class="sd">        Gzip: Use &quot;Gzip&quot; compression algorithm.</span>
    2163. 

  2163. <span class="sd">    &quot;&quot;&quot;</span>
    2164. 

  2164.     <span class="n">NoCompression</span> <span class="o">=</span> <span class="n">_compression</span><span class="o">.</span><span class="n">NoCompression</span>
    2165. 

  2165.     <span class="n">Deflate</span> <span class="o">=</span> <span class="n">_compression</span><span class="o">.</span><span class="n">Deflate</span>
    2166. 

  2166.     <span class="n">Gzip</span> <span class="o">=</span> <span class="n">_compression</span><span class="o">.</span><span class="n">Gzip</span></div>
    2167. 

  2167. 

  2168. 

  2169. <span class="kn">from</span> <span class="nn">grpc._runtime_protos</span> <span class="kn">import</span> <span class="n">protos</span><span class="p">,</span> <span class="n">services</span><span class="p">,</span> <span class="n">protos_and_services</span>  <span class="c1"># pylint: disable=wrong-import-position</span>
    2170. 

  2170. 

  2171. <span class="c1">###################################  __all__  #################################</span>
    2172. 

  2172. 

  2173. <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
    2174. 

  2174.     <span class="s1">&#39;FutureTimeoutError&#39;</span><span class="p">,</span>
    2175. 

  2175.     <span class="s1">&#39;FutureCancelledError&#39;</span><span class="p">,</span>
    2176. 

  2176.     <span class="s1">&#39;Future&#39;</span><span class="p">,</span>
    2177. 

  2177.     <span class="s1">&#39;ChannelConnectivity&#39;</span><span class="p">,</span>
    2178. 

  2178.     <span class="s1">&#39;StatusCode&#39;</span><span class="p">,</span>
    2179. 

  2179.     <span class="s1">&#39;Status&#39;</span><span class="p">,</span>
    2180. 

  2180.     <span class="s1">&#39;RpcError&#39;</span><span class="p">,</span>
    2181. 

  2181.     <span class="s1">&#39;RpcContext&#39;</span><span class="p">,</span>
    2182. 

  2182.     <span class="s1">&#39;Call&#39;</span><span class="p">,</span>
    2183. 

  2183.     <span class="s1">&#39;ChannelCredentials&#39;</span><span class="p">,</span>
    2184. 

  2184.     <span class="s1">&#39;CallCredentials&#39;</span><span class="p">,</span>
    2185. 

  2185.     <span class="s1">&#39;AuthMetadataContext&#39;</span><span class="p">,</span>
    2186. 

  2186.     <span class="s1">&#39;AuthMetadataPluginCallback&#39;</span><span class="p">,</span>
    2187. 

  2187.     <span class="s1">&#39;AuthMetadataPlugin&#39;</span><span class="p">,</span>
    2188. 

  2188.     <span class="s1">&#39;Compression&#39;</span><span class="p">,</span>
    2189. 

  2189.     <span class="s1">&#39;ClientCallDetails&#39;</span><span class="p">,</span>
    2190. 

  2190.     <span class="s1">&#39;ServerCertificateConfiguration&#39;</span><span class="p">,</span>
    2191. 

  2191.     <span class="s1">&#39;ServerCredentials&#39;</span><span class="p">,</span>
    2192. 

  2192.     <span class="s1">&#39;LocalConnectionType&#39;</span><span class="p">,</span>
    2193. 

  2193.     <span class="s1">&#39;UnaryUnaryMultiCallable&#39;</span><span class="p">,</span>
    2194. 

  2194.     <span class="s1">&#39;UnaryStreamMultiCallable&#39;</span><span class="p">,</span>
    2195. 

  2195.     <span class="s1">&#39;StreamUnaryMultiCallable&#39;</span><span class="p">,</span>
    2196. 

  2196.     <span class="s1">&#39;StreamStreamMultiCallable&#39;</span><span class="p">,</span>
    2197. 

  2197.     <span class="s1">&#39;UnaryUnaryClientInterceptor&#39;</span><span class="p">,</span>
    2198. 

  2198.     <span class="s1">&#39;UnaryStreamClientInterceptor&#39;</span><span class="p">,</span>
    2199. 

  2199.     <span class="s1">&#39;StreamUnaryClientInterceptor&#39;</span><span class="p">,</span>
    2200. 

  2200.     <span class="s1">&#39;StreamStreamClientInterceptor&#39;</span><span class="p">,</span>
    2201. 

  2201.     <span class="s1">&#39;Channel&#39;</span><span class="p">,</span>
    2202. 

  2202.     <span class="s1">&#39;ServicerContext&#39;</span><span class="p">,</span>
    2203. 

  2203.     <span class="s1">&#39;RpcMethodHandler&#39;</span><span class="p">,</span>
    2204. 

  2204.     <span class="s1">&#39;HandlerCallDetails&#39;</span><span class="p">,</span>
    2205. 

  2205.     <span class="s1">&#39;GenericRpcHandler&#39;</span><span class="p">,</span>
    2206. 

  2206.     <span class="s1">&#39;ServiceRpcHandler&#39;</span><span class="p">,</span>
    2207. 

  2207.     <span class="s1">&#39;Server&#39;</span><span class="p">,</span>
    2208. 

  2208.     <span class="s1">&#39;ServerInterceptor&#39;</span><span class="p">,</span>
    2209. 

  2209.     <span class="s1">&#39;unary_unary_rpc_method_handler&#39;</span><span class="p">,</span>
    2210. 

  2210.     <span class="s1">&#39;unary_stream_rpc_method_handler&#39;</span><span class="p">,</span>
    2211. 

  2211.     <span class="s1">&#39;stream_unary_rpc_method_handler&#39;</span><span class="p">,</span>
    2212. 

  2212.     <span class="s1">&#39;stream_stream_rpc_method_handler&#39;</span><span class="p">,</span>
    2213. 

  2213.     <span class="s1">&#39;method_handlers_generic_handler&#39;</span><span class="p">,</span>
    2214. 

  2214.     <span class="s1">&#39;ssl_channel_credentials&#39;</span><span class="p">,</span>
    2215. 

  2215.     <span class="s1">&#39;metadata_call_credentials&#39;</span><span class="p">,</span>
    2216. 

  2216.     <span class="s1">&#39;access_token_call_credentials&#39;</span><span class="p">,</span>
    2217. 

  2217.     <span class="s1">&#39;composite_call_credentials&#39;</span><span class="p">,</span>
    2218. 

  2218.     <span class="s1">&#39;composite_channel_credentials&#39;</span><span class="p">,</span>
    2219. 

  2219.     <span class="s1">&#39;local_channel_credentials&#39;</span><span class="p">,</span>
    2220. 

  2220.     <span class="s1">&#39;local_server_credentials&#39;</span><span class="p">,</span>
    2221. 

  2221.     <span class="s1">&#39;alts_channel_credentials&#39;</span><span class="p">,</span>
    2222. 

  2222.     <span class="s1">&#39;alts_server_credentials&#39;</span><span class="p">,</span>
    2223. 

  2223.     <span class="s1">&#39;ssl_server_credentials&#39;</span><span class="p">,</span>
    2224. 

  2224.     <span class="s1">&#39;ssl_server_certificate_configuration&#39;</span><span class="p">,</span>
    2225. 

  2225.     <span class="s1">&#39;dynamic_ssl_server_credentials&#39;</span><span class="p">,</span>
    2226. 

  2226.     <span class="s1">&#39;channel_ready_future&#39;</span><span class="p">,</span>
    2227. 

  2227.     <span class="s1">&#39;insecure_channel&#39;</span><span class="p">,</span>
    2228. 

  2228.     <span class="s1">&#39;secure_channel&#39;</span><span class="p">,</span>
    2229. 

  2229.     <span class="s1">&#39;intercept_channel&#39;</span><span class="p">,</span>
    2230. 

  2230.     <span class="s1">&#39;server&#39;</span><span class="p">,</span>
    2231. 

  2231.     <span class="s1">&#39;protos&#39;</span><span class="p">,</span>
    2232. 

  2232.     <span class="s1">&#39;services&#39;</span><span class="p">,</span>
    2233. 

  2233.     <span class="s1">&#39;protos_and_services&#39;</span><span class="p">,</span>
    2234. 

  2234. <span class="p">)</span>
    2235. 

  2235. 

  2236. <span class="c1">############################### Extension Shims ################################</span>
    2237. 

  2237. 

  2238. <span class="c1"># Here to maintain backwards compatibility; avoid using these in new code!</span>
    2239. 

  2239. <span class="k">try</span><span class="p">:</span>
    2240. 

  2240.     <span class="kn">import</span> <span class="nn">grpc_tools</span>
    2241. 

  2241.     <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>
    2242. 

  2242. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    2243. 

  2243.     <span class="k">pass</span>
    2244. 

  2244. <span class="k">try</span><span class="p">:</span>
    2245. 

  2245.     <span class="kn">import</span> <span class="nn">grpc_health</span>
    2246. 

  2246.     <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>
    2247. 

  2247. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    2248. 

  2248.     <span class="k">pass</span>
    2249. 

  2249. <span class="k">try</span><span class="p">:</span>
    2250. 

  2250.     <span class="kn">import</span> <span class="nn">grpc_reflection</span>
    2251. 

  2251.     <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>
    2252. 

  2252. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    2253. 

  2253.     <span class="k">pass</span>
    2254. 

  2254. 

  2255. <span class="c1"># Prevents import order issue in the case of renamed path.</span>
    2256. 

  2256. <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span> <span class="ow">and</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;grpc&quot;</span><span class="p">:</span>
    2257. 

  2257.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">aio</span>  <span class="c1"># pylint: disable=ungrouped-imports</span>
    2258. 

  2258.     <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.aio&#39;</span><span class="p">:</span> <span class="n">aio</span><span class="p">})</span>
    2259. 

  2259. </pre></div>
    2260. 

  2260. 

  2261.           </div>
    2262. 

  2262.           
    2263. 

  2263.         </div>
    2264. 

  2264.       </div>
    2265. 

  2265.     <div class="clearer"></div>
    2266. 

  2266.   </div>
    2267. 

  2267.     <div class="footer">
    2268. 

  2268.       &copy;2020, The gRPC Authors.
    2269. 

  2269.       
    2270. 

  2270.     </div>
    2271. 

  2271. 

  2272.     
    2273. 

  2273. 

  2274.     
    2275. 

  2275.     <script type="text/javascript">
    2276. 

  2276. 

  2277.       var _gaq = _gaq || [];
    2278. 

  2278.       _gaq.push(['_setAccount', 'UA-60127042-1']);
    2279. 

  2279.       _gaq.push(['_setDomainName', 'none']);
    2280. 

  2280.       _gaq.push(['_setAllowLinker', true]);
    2281. 

  2281.       _gaq.push(['_trackPageview']);
    2282. 

  2282. 

  2283.       (function() {
    2284. 

  2284.         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    2285. 

  2285.         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    2286. 

  2286.         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    2287. 

  2287.       })();
    2288. 

  2288. 

  2289.     </script>
    2290. 

  2290.     
    2291. 

  2291.   </body>
    2292. 

  2292. </html>
    2293.