Головна сторінка Огляд Довідка
Увійти
carto
/
grpc
2
0
Відгалуження 0
Файли Проблеми 0 Запити на злиття 0 Wiki
Дерево: 4d24ed5573
Гілки Теги
grpc
/
python
/
_modules
/
grpc.html

grpc.html 155 KB
Історія Запис

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

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

  8.   
    9. 

  9.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    10. 

  10.   
    11. 

  11.   <title>grpc &mdash; grpcio 1.8.0 documentation</title>
    12. 

  12.   
    13. 

  13. 

  14.   
    15. 

  15.   
    16. 

  16.   
    17. 

  17.   
    18. 

  18. 

  19.   
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

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

  30.   
    31. 

  31. 

  32.   
    33. 

  33. 

  34.   
    35. 

  35.         <link rel="index" title="Index"
    36. 

  36.               href="../genindex.html"/>
    37. 

  37.         <link rel="search" title="Search" href="../search.html"/>
    38. 

  38.     <link rel="top" title="grpcio 1.8.0 documentation" href="../index.html"/>
    39. 

  39.         <link rel="up" title="Module code" href="index.html"/> 
    40. 

  40. 

  41.   
    42. 

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

  43. 

  44. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
    45. 

  45. 

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

  47. 

  48.    
    49. 

  49.   <div class="wy-grid-for-nav">
    50. 

  50. 

  51.     
    52. 

  52.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    53. 

  53.       <div class="wy-side-scroll">
    54. 

  54.         <div class="wy-side-nav-search">
    55. 

  55.           
    56. 

  56. 

  57.           
    58. 

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

  59.           
    60. 

  60. 

  61.           
    62. 

  62.           </a>
    63. 

  63. 

  64.           
    65. 

  65.             
    66. 

  66.             
    67. 

  67.               <div class="version">
    68. 

  68.                 1.8.0
    69. 

  69.               </div>
    70. 

  70.             
    71. 

  71.           
    72. 

  72. 

  73.           
    74. 

  74. <div role="search">
    75. 

  75.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    76. 

  76.     <input type="text" name="q" placeholder="Search docs" />
    77. 

  77.     <input type="hidden" name="check_keywords" value="yes" />
    78. 

  78.     <input type="hidden" name="area" value="default" />
    79. 

  79.   </form>
    80. 

  80. </div>
    81. 

  81. 

  82.           
    83. 

  83.         </div>
    84. 

  84. 

  85.         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    86. 

  86.           
    87. 

  87.             
    88. 

  88.             
    89. 

  89.               
    90. 

  90.             
    91. 

  91.             
    92. 

  92.               <p class="caption"><span class="caption-text">Contents:</span></p>
    93. 

  93. <ul>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../grpc.html">grpc package</a></li>
    95. 

  95. <li class="toctree-l1"><a class="reference internal" href="../grpc.html#glossary">Glossary</a></li>
    96. 

  96. </ul>
    97. 

  97. 

  98.             
    99. 

  99.           
    100. 

  100.         </div>
    101. 

  101.       </div>
    102. 

  102.     </nav>
    103. 

  103. 

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

  105. 

  106.       
    107. 

  107.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    108. 

  108.         
    109. 

  109.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    110. 

  110.           <a href="../index.html">grpcio</a>
    111. 

  111.         
    112. 

  112.       </nav>
    113. 

  113. 

  114. 

  115.       
    116. 

  116.       <div class="wy-nav-content">
    117. 

  117.         <div class="rst-content">
    118. 

  118.           
    119. 

  119. 

  120. 

  121. 

  122. 

  123. 

  124. 

  125. 

  126. 

  127. 

  128. 

  129. 

  130. 

  131. 

  132. 

  133. 

  134. <div role="navigation" aria-label="breadcrumbs navigation">
    135. 

  135. 

  136.   <ul class="wy-breadcrumbs">
    137. 

  137.     
    138. 

  138.       <li><a href="../index.html">Docs</a> &raquo;</li>
    139. 

  139.         
    140. 

  140.           <li><a href="index.html">Module code</a> &raquo;</li>
    141. 

  141.         
    142. 

  142.       <li>grpc</li>
    143. 

  143.     
    144. 

  144.     
    145. 

  145.       <li class="wy-breadcrumbs-aside">
    146. 

  146.         
    147. 

  147.             
    148. 

  148.         
    149. 

  149.       </li>
    150. 

  150.     
    151. 

  151.   </ul>
    152. 

  152. 

  153.   
    154. 

  154.   <hr/>
    155. 

  155. </div>
    156. 

  156.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    157. 

  157.            <div itemprop="articleBody">
    158. 

  158.             
    159. 

  159.   <h1>Source code for grpc</h1><div class="highlight"><pre>
    160. 

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

  161. <span class="c1">#</span>
    162. 

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

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

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

  165. <span class="c1">#</span>
    166. 

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

  167. <span class="c1">#</span>
    168. 

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

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

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

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

  172. <span class="c1"># limitations under the License.</span>
    173. 

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

  174. 

  175. <span class="kn">import</span> <span class="nn">abc</span>
    176. 

  176. <span class="kn">import</span> <span class="nn">enum</span>
    177. 

  177. <span class="kn">import</span> <span class="nn">sys</span>
    178. 

  178. 

  179. <span class="kn">import</span> <span class="nn">six</span>
    180. 

  180. 

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

  182. 

  183. <span class="c1">############################## Future Interface  ###############################</span>
    184. 

  184. 

  185. 

  186. <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>
    187. 

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

  188. 

  189. 

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

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

  192. 

  193. 

  194. <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>
    195. 

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

  196. 

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

  198. <span class="sd">  or may have already completed.</span>
    199. 

  199. <span class="sd">  &quot;&quot;&quot;</span>
    200. 

  200. 

  201. <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>
    202. 

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

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

  204. 

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

  206. 

  207. <span class="sd">    Returns:</span>
    208. 

  208. <span class="sd">        bool:</span>
    209. 

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

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

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

  212. <span class="sd">        2. computation has finished</span>
    213. 

  213. <span class="sd">        3. computation is scheduled for execution and it is impossible to</span>
    214. 

  214. <span class="sd">           determine its state without blocking.</span>
    215. 

  215. <span class="sd">    &quot;&quot;&quot;</span>
    216. 

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

  217. 

  218. <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>
    219. 

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

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

  221. 

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

  223. 

  224. <span class="sd">    Returns:</span>
    225. 

  225. <span class="sd">        bool:</span>
    226. 

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

  227. <span class="sd">        available.</span>
    228. 

  228. <span class="sd">        False under all other circumstances, for example:</span>
    229. 

  229. <span class="sd">        1. computation was not cancelled.</span>
    230. 

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

  231. <span class="sd">    &quot;&quot;&quot;</span>
    232. 

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

  233. 

  234. <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>
    235. 

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

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

  237. 

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

  239. 

  240. <span class="sd">    Returns:</span>
    241. 

  241. <span class="sd">        bool:</span>
    242. 

  242. <span class="sd">        Returns True if the computation is scheduled for execution or currently</span>
    243. 

  243. <span class="sd">        executing.</span>
    244. 

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

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

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

  247. 

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

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

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

  251. 

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

  253. 

  254. <span class="sd">    Returns:</span>
    255. 

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

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

  257. <span class="sd">        Returns False if the computation is scheduled for execution or currently</span>
    258. 

  258. <span class="sd">        executing.</span>
    259. 

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

  260. <span class="sd">    &quot;&quot;&quot;</span>
    261. 

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

  262. 

  263. <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>
    264. 

  264.     <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>
    265. 

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

  266. 

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

  268. 

  269. <span class="sd">    Args:</span>
    270. 

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

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

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

  273. 

  274. <span class="sd">    Returns:</span>
    275. 

  275. <span class="sd">      The return value of the computation.</span>
    276. 

  276. 

  277. <span class="sd">    Raises:</span>
    278. 

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

  279. <span class="sd">        not terminate within the allotted time.</span>
    280. 

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

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

  282. <span class="sd">        the same exception.</span>
    283. 

  283. <span class="sd">    &quot;&quot;&quot;</span>
    284. 

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

  285. 

  286. <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>
    287. 

  287.     <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>
    288. 

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

  289. 

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

  291. 

  292. <span class="sd">    Args:</span>
    293. 

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

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

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

  296. 

  297. <span class="sd">    Returns:</span>
    298. 

  298. <span class="sd">        The exception raised by the computation, or None if the computation did</span>
    299. 

  299. <span class="sd">        not raise an exception.</span>
    300. 

  300. 

  301. <span class="sd">    Raises:</span>
    302. 

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

  303. <span class="sd">        not terminate within the allotted time.</span>
    304. 

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

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

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

  307. 

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

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

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

  311. 

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

  313. 

  314. <span class="sd">    Args:</span>
    315. 

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

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

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

  318. 

  319. <span class="sd">    Returns:</span>
    320. 

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

  321. <span class="sd">        computation did not raise an exception.</span>
    322. 

  322. 

  323. <span class="sd">    Raises:</span>
    324. 

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

  325. <span class="sd">        not terminate within the allotted time.</span>
    326. 

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

  327. <span class="sd">    &quot;&quot;&quot;</span>
    328. 

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

  329. 

  330. <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>
    331. 

  331.     <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>
    332. 

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

  333. 

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

  335. <span class="sd">    the computation.</span>
    336. 

  336. 

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

  338. <span class="sd">    immediately.</span>
    339. 

  339. 

  340. <span class="sd">    Args:</span>
    341. 

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

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

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

  344. 

  345. 

  346. <span class="c1">################################  gRPC Enums  ##################################</span>
    347. 

  347. 

  348. 

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

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

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

  352. 

  353. <span class="sd">  Attributes:</span>
    354. 

  354. <span class="sd">    IDLE: The channel is idle.</span>
    355. 

  355. <span class="sd">    CONNECTING: The channel is connecting.</span>
    356. 

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

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

  358. <span class="sd">      recover.</span>
    359. 

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

  360. <span class="sd">  &quot;&quot;&quot;</span>
    361. 

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

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

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

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

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

  366.     <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>
    367. 

  367. 

  368. 

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

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

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

  372.     <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>
    373. 

  373.     <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>
    374. 

  374.     <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>
    375. 

  375.     <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>
    376. 

  376.     <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>
    377. 

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

  378.     <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>
    379. 

  379.     <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>
    380. 

  380.     <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>
    381. 

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

  382.     <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>
    383. 

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

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

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

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

  387.     <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>
    388. 

  388.     <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>
    389. 

  389.     <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>
    390. 

  390.     <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>
    391. 

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

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

  393. 

  394. 

  395. <span class="c1">#############################  gRPC Exceptions  ################################</span>
    396. 

  396. 

  397. 

  398. <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>
    399. 

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

  400. 

  401. 

  402. <span class="c1">##############################  Shared Context  ################################</span>
    403. 

  403. 

  404. 

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

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

  407. 

  408. <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>
    409. 

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

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

  411. 

  412. <span class="sd">    Returns:</span>
    413. 

  413. <span class="sd">      bool:</span>
    414. 

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

  415. <span class="sd">    &quot;&quot;&quot;</span>
    416. 

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

  417. 

  418. <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>
    419. 

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

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

  421. 

  422. <span class="sd">    Returns:</span>
    423. 

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

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

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

  426. <span class="sd">    &quot;&quot;&quot;</span>
    427. 

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

  428. 

  429. <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>
    430. 

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

  431.         <span class="sd">&quot;&quot;&quot;Cancels the RPC.</span>
    432. 

  432. 

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

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

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

  436. 

  437. <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>
    438. 

  438.     <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>
    439. 

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

  440. 

  441. <span class="sd">    Args:</span>
    442. 

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

  443. 

  444. <span class="sd">    Returns:</span>
    445. 

  445. <span class="sd">      bool:</span>
    446. 

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

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

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

  449. <span class="sd">    &quot;&quot;&quot;</span>
    450. 

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

  451. 

  452. 

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

  454. 

  455. 

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

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

  458. 

  459. <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>
    460. 

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

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

  462. 

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

  464. 

  465. <span class="sd">    Returns:</span>
    466. 

  466. <span class="sd">      The initial :term:`metadata`.</span>
    467. 

  467. <span class="sd">    &quot;&quot;&quot;</span>
    468. 

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

  469. 

  470. <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>
    471. 

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

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

  473. 

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

  475. 

  476. <span class="sd">    Returns:</span>
    477. 

  477. <span class="sd">      The trailing :term:`metadata`.</span>
    478. 

  478. <span class="sd">    &quot;&quot;&quot;</span>
    479. 

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

  480. 

  481. <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>
    482. 

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

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

  484. 

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

  486. 

  487. <span class="sd">    Returns:</span>
    488. 

  488. <span class="sd">      The StatusCode value for the RPC.</span>
    489. 

  489. <span class="sd">    &quot;&quot;&quot;</span>
    490. 

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

  491. 

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

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

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

  495. 

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

  497. 

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

  499. <span class="sd">      The details string of the RPC.</span>
    500. 

  500. <span class="sd">    &quot;&quot;&quot;</span>
    501. 

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

  502. 

  503. 

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

  505. 

  506. 

  507. <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>
    508. 

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

  509. 

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

  511. 

  512. <span class="sd">    Attributes:</span>
    513. 

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

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

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

  516. <span class="sd">        the service-side of the RPC.</span>
    517. 

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

  518. <span class="sd">    &quot;&quot;&quot;</span></div>
    519. 

  519. 

  520. 

  521. <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>
    522. 

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

  523. 

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

  525. <span class="sd">    &quot;&quot;&quot;</span>
    526. 

  526. 

  527. <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>
    528. 

  528.     <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>
    529. 

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

  530. 

  531. <span class="sd">        Args:</span>
    532. 

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

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

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

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

  536. <span class="sd">            The interceptor can use</span>
    537. 

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

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

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

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

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

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

  543. <span class="sd">            will be an RpcError.</span>
    544. 

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

  545. <span class="sd">            outgoing RPC.</span>
    546. 

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

  547. 

  548. <span class="sd">        Returns:</span>
    549. 

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

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

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

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

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

  554. <span class="sd">        &quot;&quot;&quot;</span>
    555. 

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

  556. 

  557. 

  558. <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>
    559. 

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

  560. 

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

  562. <span class="sd">    &quot;&quot;&quot;</span>
    563. 

  563. 

  564. <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>
    565. 

  565.     <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>
    566. 

  566.                                <span class="n">request</span><span class="p">):</span>
    567. 

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

  568. 

  569. <span class="sd">        Args:</span>
    570. 

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

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

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

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

  574. <span class="sd">            The interceptor can use</span>
    575. 

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

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

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

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

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

  580. <span class="sd">            status.</span>
    581. 

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

  582. <span class="sd">            outgoing RPC.</span>
    583. 

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

  584. 

  585. <span class="sd">        Returns:</span>
    586. 

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

  587. <span class="sd">            response values. Drawing response values from the returned</span>
    588. 

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

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

  590. <span class="sd">        &quot;&quot;&quot;</span>
    591. 

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

  592. 

  593. 

  594. <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>
    595. 

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

  596. 

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

  598. <span class="sd">    &quot;&quot;&quot;</span>
    599. 

  599. 

  600. <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>
    601. 

  601.     <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>
    602. 

  602.                                <span class="n">request_iterator</span><span class="p">):</span>
    603. 

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

  604. 

  605. <span class="sd">        Args:</span>
    606. 

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

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

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

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

  610. <span class="sd">            The interceptor can use</span>
    611. 

  611. <span class="sd">            `response_future = continuation(client_call_details,</span>
    612. 

  612. <span class="sd">                                            request_iterator)`</span>
    613. 

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

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

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

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

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

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

  619. <span class="sd">            outgoing RPC.</span>
    620. 

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

  621. 

  622. <span class="sd">        Returns:</span>
    623. 

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

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

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

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

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

  628. <span class="sd">        &quot;&quot;&quot;</span>
    629. 

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

  630. 

  631. 

  632. <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>
    633. 

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

  634. 

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

  636. <span class="sd">    &quot;&quot;&quot;</span>
    637. 

  637. 

  638. <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>
    639. 

  639.     <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>
    640. 

  640.                                 <span class="n">request_iterator</span><span class="p">):</span>
    641. 

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

  642. 

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

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

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

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

  647. <span class="sd">            The interceptor can use</span>
    648. 

  648. <span class="sd">            `response_iterator = continuation(client_call_details,</span>
    649. 

  649. <span class="sd">                                              request_iterator)`</span>
    650. 

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

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

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

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

  654. <span class="sd">            status.</span>
    655. 

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

  656. <span class="sd">            outgoing RPC.</span>
    657. 

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

  658. 

  659. <span class="sd">        Returns:</span>
    660. 

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

  661. <span class="sd">            response values. Drawing response values from the returned</span>
    662. 

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

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

  664. <span class="sd">        &quot;&quot;&quot;</span>
    665. 

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

  666. 

  667. 

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

  669. 

  670. 

  671. <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>
    672. 

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

  673. 

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

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

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

  677. <span class="sd">    secure_channel requires an instance of this class.</span>
    678. 

  678. <span class="sd">    &quot;&quot;&quot;</span>
    679. 

  679. 

  680.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    681. 

  681.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    682. 

  682. 

  683. 

  684. <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>
    685. 

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

  686. 

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

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

  689. 

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

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

  692. <span class="sd">    &quot;&quot;&quot;</span>
    693. 

  693. 

  694.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    695. 

  695.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    696. 

  696. 

  697. 

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

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

  700. 

  701. <span class="sd">    Attributes:</span>
    702. 

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

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

  704. <span class="sd">    &quot;&quot;&quot;</span></div>
    705. 

  705. 

  706. 

  707. <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>
    708. 

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

  709. 

  710. <div class="viewcode-block" id="AuthMetadataPluginCallback.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPluginCallback.__call__">[docs]</a>    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
    711. 

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

  712. 

  713. <span class="sd">        Args:</span>
    714. 

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

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

  716. <span class="sd">        &quot;&quot;&quot;</span>
    717. 

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

  718. 

  719. 

  720. <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>
    721. 

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

  722. 

  723. <div class="viewcode-block" id="AuthMetadataPlugin.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPlugin.__call__">[docs]</a>    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
    724. 

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

  725. 

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

  727. 

  728. <span class="sd">        Args:</span>
    729. 

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

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

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

  732. <span class="sd">            synchronously or asynchronously.</span>
    733. 

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

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

  735. 

  736. 

  737. <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>
    738. 

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

  739. 

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

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

  742. <span class="sd">  &quot;&quot;&quot;</span>
    743. 

  743. 

  744.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
    745. 

  745.         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span></div>
    746. 

  746. 

  747. 

  748. <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>
    749. 

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

  750. 

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

  752. <span class="sd">    fetching callback.</span>
    753. 

  753. 

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

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

  756. <span class="sd">    other functions.</span>
    757. 

  757. <span class="sd">    &quot;&quot;&quot;</span>
    758. 

  758. 

  759.     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">certificate_configuration</span><span class="p">):</span>
    760. 

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

  761. 

  762. 

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

  764. 

  765. 

  766. <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>
    767. 

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

  768. 

  769. <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>
    770. 

  770.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    771. 

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

  772. 

  773. <span class="sd">    Args:</span>
    774. 

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

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

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

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

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

  779. 

  780. <span class="sd">    Returns:</span>
    781. 

  781. <span class="sd">      The response value for the RPC.</span>
    782. 

  782. 

  783. <span class="sd">    Raises:</span>
    784. 

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

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

  786. <span class="sd">        metadata, status code, and details.</span>
    787. 

  787. <span class="sd">    &quot;&quot;&quot;</span>
    788. 

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

  789. 

  790. <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>
    791. 

  791.     <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    792. 

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

  793. 

  794. <span class="sd">    Args:</span>
    795. 

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

  796. <span class="sd">      timeout: An optional durating of time in seconds to allow for the RPC.</span>
    797. 

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

  798. <span class="sd">        service-side of the RPC.</span>
    799. 

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

  800. 

  801. <span class="sd">    Returns:</span>
    802. 

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

  803. 

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

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

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

  807. <span class="sd">        metadata, status code, and details.</span>
    808. 

  808. <span class="sd">    &quot;&quot;&quot;</span>
    809. 

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

  810. 

  811. <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>
    812. 

  812.     <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    813. 

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

  814. 

  815. <span class="sd">    Args:</span>
    816. 

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

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

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

  819. <span class="sd">        service-side of the RPC.</span>
    820. 

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

  821. 

  822. <span class="sd">    Returns:</span>
    823. 

  823. <span class="sd">        An object that is both a Call for the RPC and a Future. In the event of</span>
    824. 

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

  825. <span class="sd">        response message of the RPC. Should the event terminate with non-OK</span>
    826. 

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

  827. <span class="sd">    &quot;&quot;&quot;</span>
    828. 

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

  829. 

  830. 

  831. <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>
    832. 

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

  833. 

  834. <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>
    835. 

  835.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    836. 

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

  837. 

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

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

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

  841. <span class="sd">               If None, the timeout is considered infinite.</span>
    842. 

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

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

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

  845. 

  846. <span class="sd">    Returns:</span>
    847. 

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

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

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

  850. <span class="sd">    &quot;&quot;&quot;</span>
    851. 

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

  852. 

  853. 

  854. <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>
    855. 

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

  856. 

  857. <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>
    858. 

  858.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    859. 

  859.                  <span class="n">request_iterator</span><span class="p">,</span>
    860. 

  860.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    861. 

  861.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    862. 

  862.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    863. 

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

  864. 

  865. <span class="sd">    Args:</span>
    866. 

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

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

  868. <span class="sd">               If None, the timeout is considered infinite.</span>
    869. 

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

  870. <span class="sd">        service-side of the RPC.</span>
    871. 

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

  872. 

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

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

  875. 

  876. <span class="sd">    Raises:</span>
    877. 

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

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

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

  880. <span class="sd">    &quot;&quot;&quot;</span>
    881. 

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

  882. 

  883. <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>
    884. 

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

  885.                   <span class="n">request_iterator</span><span class="p">,</span>
    886. 

  886.                   <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    887. 

  887.                   <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    888. 

  888.                   <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    889. 

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

  890. 

  891. <span class="sd">    Args:</span>
    892. 

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

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

  894. <span class="sd">               If None, the timeout is considered infinite.</span>
    895. 

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

  896. <span class="sd">        service-side of the RPC.</span>
    897. 

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

  898. 

  899. <span class="sd">    Returns:</span>
    900. 

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

  901. 

  902. <span class="sd">    Raises:</span>
    903. 

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

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

  905. <span class="sd">        metadata, status code, and details.</span>
    906. 

  906. <span class="sd">    &quot;&quot;&quot;</span>
    907. 

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

  908. 

  909. <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>
    910. 

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

  911.                <span class="n">request_iterator</span><span class="p">,</span>
    912. 

  912.                <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    913. 

  913.                <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    914. 

  914.                <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    915. 

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

  916. 

  917. <span class="sd">    Args:</span>
    918. 

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

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

  920. <span class="sd">               If None, the timeout is considered infinite.</span>
    921. 

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

  922. <span class="sd">        service-side of the RPC.</span>
    923. 

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

  924. 

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

  926. <span class="sd">        An object that is both a Call for the RPC and a Future. In the event of</span>
    927. 

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

  928. <span class="sd">        response message of the RPC. Should the event terminate with non-OK</span>
    929. 

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

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

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

  932. 

  933. 

  934. <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>
    935. 

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

  936. 

  937. <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>
    938. 

  938.     <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    939. 

  939.                  <span class="n">request_iterator</span><span class="p">,</span>
    940. 

  940.                  <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    941. 

  941.                  <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    942. 

  942.                  <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    943. 

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

  944. 

  945. <span class="sd">    Args:</span>
    946. 

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

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

  948. <span class="sd">               if not specified the timeout is considered infinite.</span>
    949. 

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

  950. <span class="sd">        service-side of the RPC.</span>
    951. 

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

  952. 

  953. <span class="sd">    Returns:</span>
    954. 

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

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

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

  957. <span class="sd">    &quot;&quot;&quot;</span>
    958. 

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

  959. 

  960. 

  961. <span class="c1">#############################  Channel Interface  ##############################</span>
    962. 

  962. 

  963. 

  964. <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>
    965. 

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

  966. 

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

  968.     <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>
    969. 

  969.         <span class="sd">&quot;&quot;&quot;Subscribe to this Channel&#39;s connectivity state machine.</span>
    970. 

  970. 

  971. <span class="sd">    A Channel may be in any of the states described by ChannelConnectivity.</span>
    972. 

  972. <span class="sd">    This method allows application to monitor the state transitions.</span>
    973. 

  973. <span class="sd">    The typical use case is to debug or gain better visibility into gRPC</span>
    974. 

  974. <span class="sd">    runtime&#39;s state.</span>
    975. 

  975. 

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

  977. <span class="sd">      callback: A callable to be invoked with ChannelConnectivity argument.</span>
    978. 

  978. <span class="sd">        ChannelConnectivity describes current state of the channel.</span>
    979. 

  979. <span class="sd">        The callable will be invoked immediately upon subscription and again for</span>
    980. 

  980. <span class="sd">        every change to ChannelConnectivity until it is unsubscribed or this</span>
    981. 

  981. <span class="sd">        Channel object goes out of scope.</span>
    982. 

  982. <span class="sd">      try_to_connect: A boolean indicating whether or not this Channel should</span>
    983. 

  983. <span class="sd">        attempt to connect immediately. If set to False, gRPC runtime decides</span>
    984. 

  984. <span class="sd">        when to connect.</span>
    985. 

  985. <span class="sd">    &quot;&quot;&quot;</span>
    986. 

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

  987. 

  988. <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>
    989. 

  989.     <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>
    990. 

  990.         <span class="sd">&quot;&quot;&quot;Unsubscribes a subscribed callback from this Channel&#39;s connectivity.</span>
    991. 

  991. 

  992. <span class="sd">    Args:</span>
    993. 

  993. <span class="sd">      callback: A callable previously registered with this Channel from having</span>
    994. 

  994. <span class="sd">        been passed to its &quot;subscribe&quot; method.</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>
    997. 

  997. 

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

  999.     <span class="k">def</span> <span class="nf">unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1000. 

  1000.                     <span class="n">method</span><span class="p">,</span>
    1001. 

  1001.                     <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1002. 

  1002.                     <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1003. 

  1003.         <span class="sd">&quot;&quot;&quot;Creates a UnaryUnaryMultiCallable for a unary-unary method.</span>
    1004. 

  1004. 

  1005. <span class="sd">    Args:</span>
    1006. 

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

  1007. <span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
    1008. 

  1008. <span class="sd">        message. Request goes unserialized in case None is passed.</span>
    1009. 

  1009. <span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
    1010. 

  1010. <span class="sd">        message. Response goes undeserialized in case None is passed.</span>
    1011. 

  1011. 

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

  1013. <span class="sd">      A UnaryUnaryMultiCallable value for the named unary-unary method.</span>
    1014. 

  1014. <span class="sd">    &quot;&quot;&quot;</span>
    1015. 

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

  1016. 

  1017. <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>
    1018. 

  1018.     <span class="k">def</span> <span class="nf">unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1019. 

  1019.                      <span class="n">method</span><span class="p">,</span>
    1020. 

  1020.                      <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1021. 

  1021.                      <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1022. 

  1022.         <span class="sd">&quot;&quot;&quot;Creates a UnaryStreamMultiCallable for a unary-stream method.</span>
    1023. 

  1023. 

  1024. <span class="sd">    Args:</span>
    1025. 

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

  1026. <span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
    1027. 

  1027. <span class="sd">        message. Request goes unserialized in case None is passed.</span>
    1028. 

  1028. <span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
    1029. 

  1029. <span class="sd">        message. Response goes undeserialized in case None is passed.</span>
    1030. 

  1030. 

  1031. <span class="sd">    Returns:</span>
    1032. 

  1032. <span class="sd">      A UnaryStreamMultiCallable value for the name unary-stream method.</span>
    1033. 

  1033. <span class="sd">    &quot;&quot;&quot;</span>
    1034. 

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

  1035. 

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

  1037.     <span class="k">def</span> <span class="nf">stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1038. 

  1038.                      <span class="n">method</span><span class="p">,</span>
    1039. 

  1039.                      <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1040. 

  1040.                      <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1041. 

  1041.         <span class="sd">&quot;&quot;&quot;Creates a StreamUnaryMultiCallable for a stream-unary method.</span>
    1042. 

  1042. 

  1043. <span class="sd">    Args:</span>
    1044. 

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

  1045. <span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
    1046. 

  1046. <span class="sd">        message. Request goes unserialized in case None is passed.</span>
    1047. 

  1047. <span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
    1048. 

  1048. <span class="sd">        message. Response goes undeserialized in case None is passed.</span>
    1049. 

  1049. 

  1050. <span class="sd">    Returns:</span>
    1051. 

  1051. <span class="sd">      A StreamUnaryMultiCallable value for the named stream-unary method.</span>
    1052. 

  1052. <span class="sd">    &quot;&quot;&quot;</span>
    1053. 

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

  1054. 

  1055. <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>
    1056. 

  1056.     <span class="k">def</span> <span class="nf">stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    1057. 

  1057.                       <span class="n">method</span><span class="p">,</span>
    1058. 

  1058.                       <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1059. 

  1059.                       <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1060. 

  1060.         <span class="sd">&quot;&quot;&quot;Creates a StreamStreamMultiCallable for a stream-stream method.</span>
    1061. 

  1061. 

  1062. <span class="sd">    Args:</span>
    1063. 

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

  1064. <span class="sd">      request_serializer: Optional behaviour for serializing the request</span>
    1065. 

  1065. <span class="sd">        message. Request goes unserialized in case None is passed.</span>
    1066. 

  1066. <span class="sd">      response_deserializer: Optional behaviour for deserializing the response</span>
    1067. 

  1067. <span class="sd">        message. Response goes undeserialized in case None is passed.</span>
    1068. 

  1068. 

  1069. <span class="sd">    Returns:</span>
    1070. 

  1070. <span class="sd">      A StreamStreamMultiCallable value for the named stream-stream method.</span>
    1071. 

  1071. <span class="sd">    &quot;&quot;&quot;</span>
    1072. 

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

  1073. 

  1074. 

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

  1076. 

  1077. 

  1078. <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>
    1079. 

  1079.     <span class="sd">&quot;&quot;&quot;A context object passed to method implementations.&quot;&quot;&quot;</span>
    1080. 

  1080. 

  1081. <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>
    1082. 

  1082.     <span class="k">def</span> <span class="nf">invocation_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1083. 

  1083.         <span class="sd">&quot;&quot;&quot;Accesses the metadata from the sent by the client.</span>
    1084. 

  1084. 

  1085. <span class="sd">    Returns:</span>
    1086. 

  1086. <span class="sd">      The invocation :term:`metadata`.</span>
    1087. 

  1087. <span class="sd">    &quot;&quot;&quot;</span>
    1088. 

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

  1089. 

  1090. <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>
    1091. 

  1091.     <span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1092. 

  1092.         <span class="sd">&quot;&quot;&quot;Identifies the peer that invoked the RPC being serviced.</span>
    1093. 

  1093. 

  1094. <span class="sd">    Returns:</span>
    1095. 

  1095. <span class="sd">      A string identifying the peer that invoked the RPC being serviced.</span>
    1096. 

  1096. <span class="sd">      The string format is determined by gRPC runtime.</span>
    1097. 

  1097. <span class="sd">    &quot;&quot;&quot;</span>
    1098. 

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

  1099. 

  1100. <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>
    1101. 

  1101.     <span class="k">def</span> <span class="nf">peer_identities</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1102. 

  1102.         <span class="sd">&quot;&quot;&quot;Gets one or more peer identity(s).</span>
    1103. 

  1103. 

  1104. <span class="sd">      Equivalent to</span>
    1105. 

  1105. <span class="sd">      servicer_context.auth_context().get(</span>
    1106. 

  1106. <span class="sd">          servicer_context.peer_identity_key())</span>
    1107. 

  1107. 

  1108. <span class="sd">    Returns:</span>
    1109. 

  1109. <span class="sd">      An iterable of the identities, or None if the call is not authenticated.</span>
    1110. 

  1110. <span class="sd">      Each identity is returned as a raw bytes type.</span>
    1111. 

  1111. <span class="sd">     &quot;&quot;&quot;</span>
    1112. 

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

  1113. 

  1114. <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>
    1115. 

  1115.     <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>
    1116. 

  1116.         <span class="sd">&quot;&quot;&quot;The auth property used to identify the peer.</span>
    1117. 

  1117. 

  1118. <span class="sd">    For example, &quot;x509_common_name&quot; or &quot;x509_subject_alternative_name&quot; are</span>
    1119. 

  1119. <span class="sd">    used to identify an SSL peer.</span>
    1120. 

  1120. 

  1121. <span class="sd">    Returns:</span>
    1122. 

  1122. <span class="sd">      The auth property (string) that indicates the</span>
    1123. 

  1123. <span class="sd">      peer identity, or None if the call is not authenticated.</span>
    1124. 

  1124. <span class="sd">    &quot;&quot;&quot;</span>
    1125. 

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

  1126. 

  1127. <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>
    1128. 

  1128.     <span class="k">def</span> <span class="nf">auth_context</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1129. 

  1129.         <span class="sd">&quot;&quot;&quot;Gets the auth context for the call.</span>
    1130. 

  1130. 

  1131. <span class="sd">      Returns:</span>
    1132. 

  1132. <span class="sd">        A map of strings to an iterable of bytes for each auth property.</span>
    1133. 

  1133. <span class="sd">      &quot;&quot;&quot;</span>
    1134. 

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

  1135. 

  1136. <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>
    1137. 

  1137.     <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>
    1138. 

  1138.         <span class="sd">&quot;&quot;&quot;Sends the initial metadata value to the client.</span>
    1139. 

  1139. 

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

  1141. <span class="sd">    metadata to add to what the gRPC runtime will transmit.</span>
    1142. 

  1142. 

  1143. <span class="sd">    Args:</span>
    1144. 

  1144. <span class="sd">      initial_metadata: The initial :term:`metadata`.</span>
    1145. 

  1145. <span class="sd">    &quot;&quot;&quot;</span>
    1146. 

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

  1147. 

  1148. <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>
    1149. 

  1149.     <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>
    1150. 

  1150.         <span class="sd">&quot;&quot;&quot;Sends the trailing metadata for the RPC.</span>
    1151. 

  1151. 

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

  1153. <span class="sd">    metadata to add to what the gRPC runtime will transmit.</span>
    1154. 

  1154. 

  1155. <span class="sd">    Args:</span>
    1156. 

  1156. <span class="sd">      trailing_metadata: The trailing :term:`metadata`.</span>
    1157. 

  1157. <span class="sd">    &quot;&quot;&quot;</span>
    1158. 

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

  1159. 

  1160. <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>
    1161. 

  1161.     <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>
    1162. 

  1162.         <span class="sd">&quot;&quot;&quot;Raises an exception to terminate the RPC with a non-OK status.</span>
    1163. 

  1163. 

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

  1165. <span class="sd">        ones.</span>
    1166. 

  1166. 

  1167. <span class="sd">        Args:</span>
    1168. 

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

  1169. <span class="sd">            It must not be StatusCode.OK.</span>
    1170. 

  1170. <span class="sd">          details: An ASCII-encodable string to be sent to the client upon</span>
    1171. 

  1171. <span class="sd">            termination of the RPC.</span>
    1172. 

  1172. 

  1173. <span class="sd">        Raises:</span>
    1174. 

  1174. <span class="sd">          Exception: An exception is always raised to signal the abortion the</span>
    1175. 

  1175. <span class="sd">            RPC to the gRPC runtime.</span>
    1176. 

  1176. <span class="sd">        &quot;&quot;&quot;</span>
    1177. 

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

  1178. 

  1179. <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>
    1180. 

  1180.     <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>
    1181. 

  1181.         <span class="sd">&quot;&quot;&quot;Sets the value to be used as status code upon RPC completion.</span>
    1182. 

  1182. 

  1183. <span class="sd">        This method need not be called by method implementations if they wish</span>
    1184. 

  1184. <span class="sd">        the gRPC runtime to determine the status code of the RPC.</span>
    1185. 

  1185. 

  1186. <span class="sd">        Args:</span>
    1187. 

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

  1188. <span class="sd">        &quot;&quot;&quot;</span>
    1189. 

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

  1190. 

  1191. <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>
    1192. 

  1192.     <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>
    1193. 

  1193.         <span class="sd">&quot;&quot;&quot;Sets the value to be used as detail string upon RPC completion.</span>
    1194. 

  1194. 

  1195. <span class="sd">        This method need not be called by method implementations if they have</span>
    1196. 

  1196. <span class="sd">        no details to transmit.</span>
    1197. 

  1197. 

  1198. <span class="sd">        Args:</span>
    1199. 

  1199. <span class="sd">          details: An ASCII-encodable string to be sent to the client upon</span>
    1200. 

  1200. <span class="sd">            termination of the RPC.</span>
    1201. 

  1201. <span class="sd">        &quot;&quot;&quot;</span>
    1202. 

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

  1203. 

  1204. 

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

  1206. 

  1207. 

  1208. <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>
    1209. 

  1209.     <span class="sd">&quot;&quot;&quot;An implementation of a single RPC method.</span>
    1210. 

  1210. 

  1211. <span class="sd">  Attributes:</span>
    1212. 

  1212. <span class="sd">    request_streaming: Whether the RPC supports exactly one request message or</span>
    1213. 

  1213. <span class="sd">      any arbitrary number of request messages.</span>
    1214. 

  1214. <span class="sd">    response_streaming: Whether the RPC supports exactly one response message or</span>
    1215. 

  1215. <span class="sd">      any arbitrary number of response messages.</span>
    1216. 

  1216. <span class="sd">    request_deserializer: A callable behavior that accepts a byte string and</span>
    1217. 

  1217. <span class="sd">      returns an object suitable to be passed to this object&#39;s business logic,</span>
    1218. 

  1218. <span class="sd">      or None to indicate that this object&#39;s business logic should be passed the</span>
    1219. 

  1219. <span class="sd">      raw request bytes.</span>
    1220. 

  1220. <span class="sd">    response_serializer: A callable behavior that accepts an object produced by</span>
    1221. 

  1221. <span class="sd">      this object&#39;s business logic and returns a byte string, or None to</span>
    1222. 

  1222. <span class="sd">      indicate that the byte strings produced by this object&#39;s business logic</span>
    1223. 

  1223. <span class="sd">      should be transmitted on the wire as they are.</span>
    1224. 

  1224. <span class="sd">    unary_unary: This object&#39;s application-specific business logic as a callable</span>
    1225. 

  1225. <span class="sd">      value that takes a request value and a ServicerContext object and returns</span>
    1226. 

  1226. <span class="sd">      a response value. Only non-None if both request_streaming and</span>
    1227. 

  1227. <span class="sd">      response_streaming are False.</span>
    1228. 

  1228. <span class="sd">    unary_stream: This object&#39;s application-specific business logic as a</span>
    1229. 

  1229. <span class="sd">      callable value that takes a request value and a ServicerContext object and</span>
    1230. 

  1230. <span class="sd">      returns an iterator of response values. Only non-None if request_streaming</span>
    1231. 

  1231. <span class="sd">      is False and response_streaming is True.</span>
    1232. 

  1232. <span class="sd">    stream_unary: This object&#39;s application-specific business logic as a</span>
    1233. 

  1233. <span class="sd">      callable value that takes an iterator of request values and a</span>
    1234. 

  1234. <span class="sd">      ServicerContext object and returns a response value. Only non-None if</span>
    1235. 

  1235. <span class="sd">      request_streaming is True and response_streaming is False.</span>
    1236. 

  1236. <span class="sd">    stream_stream: This object&#39;s application-specific business logic as a</span>
    1237. 

  1237. <span class="sd">      callable value that takes an iterator of request values and a</span>
    1238. 

  1238. <span class="sd">      ServicerContext object and returns an iterator of response values. Only</span>
    1239. 

  1239. <span class="sd">      non-None if request_streaming and response_streaming are both True.</span>
    1240. 

  1240. <span class="sd">  &quot;&quot;&quot;</span></div>
    1241. 

  1241. 

  1242. 

  1243. <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>
    1244. 

  1244.     <span class="sd">&quot;&quot;&quot;Describes an RPC that has just arrived for service.</span>
    1245. 

  1245. <span class="sd">  Attributes:</span>
    1246. 

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

  1247. <span class="sd">    invocation_metadata: The :term:`metadata` sent by the client.</span>
    1248. 

  1248. <span class="sd">  &quot;&quot;&quot;</span></div>
    1249. 

  1249. 

  1250. 

  1251. <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>
    1252. 

  1252.     <span class="sd">&quot;&quot;&quot;An implementation of arbitrarily many RPC methods.&quot;&quot;&quot;</span>
    1253. 

  1253. 

  1254. <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>
    1255. 

  1255.     <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>
    1256. 

  1256.         <span class="sd">&quot;&quot;&quot;Returns the handler for servicing the RPC.</span>
    1257. 

  1257. 

  1258. <span class="sd">    Args:</span>
    1259. 

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

  1260. 

  1261. <span class="sd">    Returns:</span>
    1262. 

  1262. <span class="sd">      An RpcMethodHandler with which the RPC may be serviced if the</span>
    1263. 

  1263. <span class="sd">      implementation chooses to service this RPC, or None otherwise.</span>
    1264. 

  1264. <span class="sd">    &quot;&quot;&quot;</span>
    1265. 

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

  1266. 

  1267. 

  1268. <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>
    1269. 

  1269.     <span class="sd">&quot;&quot;&quot;An implementation of RPC methods belonging to a service.</span>
    1270. 

  1270. 

  1271. <span class="sd">  A service handles RPC methods with structured names of the form</span>
    1272. 

  1272. <span class="sd">  &#39;/Service.Name/Service.Method&#39;, where &#39;Service.Name&#39; is the value</span>
    1273. 

  1273. <span class="sd">  returned by service_name(), and &#39;Service.Method&#39; is the method</span>
    1274. 

  1274. <span class="sd">  name.  A service can have multiple method names, but only a single</span>
    1275. 

  1275. <span class="sd">  service name.</span>
    1276. 

  1276. <span class="sd">  &quot;&quot;&quot;</span>
    1277. 

  1277. 

  1278. <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>
    1279. 

  1279.     <span class="k">def</span> <span class="nf">service_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1280. 

  1280.         <span class="sd">&quot;&quot;&quot;Returns this service&#39;s name.</span>
    1281. 

  1281. 

  1282. <span class="sd">    Returns:</span>
    1283. 

  1283. <span class="sd">      The service name.</span>
    1284. 

  1284. <span class="sd">    &quot;&quot;&quot;</span>
    1285. 

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

  1286. 

  1287. 

  1288. <span class="c1">####################  Service-Side Interceptor Interfaces  #####################</span>
    1289. 

  1289. 

  1290. 

  1291. <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>
    1292. 

  1292.     <span class="sd">&quot;&quot;&quot;Affords intercepting incoming RPCs on the service-side.</span>
    1293. 

  1293. 

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

  1295. <span class="sd">    &quot;&quot;&quot;</span>
    1296. 

  1296. 

  1297. <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>
    1298. 

  1298.     <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>
    1299. 

  1299.         <span class="sd">&quot;&quot;&quot;Intercepts incoming RPCs before handing them over to a handler.</span>
    1300. 

  1300. 

  1301. <span class="sd">        Args:</span>
    1302. 

  1302. <span class="sd">          continuation: A function that takes a HandlerCallDetails and</span>
    1303. 

  1303. <span class="sd">            proceeds to invoke the next interceptor in the chain, if any,</span>
    1304. 

  1304. <span class="sd">            or the RPC handler lookup logic, with the call details passed</span>
    1305. 

  1305. <span class="sd">            as an argument, and returns an RpcMethodHandler instance if</span>
    1306. 

  1306. <span class="sd">            the RPC is considered serviced, or None otherwise.</span>
    1307. 

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

  1308. 

  1309. <span class="sd">        Returns:</span>
    1310. 

  1310. <span class="sd">          An RpcMethodHandler with which the RPC may be serviced if the</span>
    1311. 

  1311. <span class="sd">          interceptor chooses to service this RPC, or None otherwise.</span>
    1312. 

  1312. <span class="sd">        &quot;&quot;&quot;</span>
    1313. 

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

  1314. 

  1315. 

  1316. <span class="c1">#############################  Server Interface  ###############################</span>
    1317. 

  1317. 

  1318. 

  1319. <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>
    1320. 

  1320.     <span class="sd">&quot;&quot;&quot;Services RPCs.&quot;&quot;&quot;</span>
    1321. 

  1321. 

  1322. <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>
    1323. 

  1323.     <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>
    1324. 

  1324.         <span class="sd">&quot;&quot;&quot;Registers GenericRpcHandlers with this Server.</span>
    1325. 

  1325. 

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

  1327. 

  1328. <span class="sd">    Args:</span>
    1329. 

  1329. <span class="sd">      generic_rpc_handlers: An iterable of GenericRpcHandlers that will be used</span>
    1330. 

  1330. <span class="sd">      to service RPCs.</span>
    1331. 

  1331. <span class="sd">    &quot;&quot;&quot;</span>
    1332. 

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

  1333. 

  1334. <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>
    1335. 

  1335.     <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>
    1336. 

  1336.         <span class="sd">&quot;&quot;&quot;Opens an insecure port for accepting RPCs.</span>
    1337. 

  1337. 

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

  1339. 

  1340. <span class="sd">    Args:</span>
    1341. 

  1341. <span class="sd">      address: The address for which to open a port.</span>
    1342. 

  1342. <span class="sd">      if the port is 0, or not specified in the address, then gRPC runtime</span>
    1343. 

  1343. <span class="sd">      will choose a port.</span>
    1344. 

  1344. 

  1345. <span class="sd">    Returns:</span>
    1346. 

  1346. <span class="sd">      integer:</span>
    1347. 

  1347. <span class="sd">      An integer port on which server will accept RPC requests.</span>
    1348. 

  1348. <span class="sd">    &quot;&quot;&quot;</span>
    1349. 

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

  1350. 

  1351. <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>
    1352. 

  1352.     <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>
    1353. 

  1353.         <span class="sd">&quot;&quot;&quot;Opens a secure port for accepting RPCs.</span>
    1354. 

  1354. 

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

  1356. 

  1357. <span class="sd">    Args:</span>
    1358. 

  1358. <span class="sd">      address: The address for which to open a port.</span>
    1359. 

  1359. <span class="sd">        if the port is 0, or not specified in the address, then gRPC runtime</span>
    1360. 

  1360. <span class="sd">        will choose a port.</span>
    1361. 

  1361. <span class="sd">      server_credentials: A ServerCredentials object.</span>
    1362. 

  1362. 

  1363. <span class="sd">    Returns:</span>
    1364. 

  1364. <span class="sd">      integer:</span>
    1365. 

  1365. <span class="sd">      An integer port on which server will accept RPC requests.</span>
    1366. 

  1366. <span class="sd">    &quot;&quot;&quot;</span>
    1367. 

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

  1368. 

  1369. <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>
    1370. 

  1370.     <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    1371. 

  1371.         <span class="sd">&quot;&quot;&quot;Starts this Server.</span>
    1372. 

  1372. 

  1373. <span class="sd">    This method may only be called once. (i.e. it is not idempotent).</span>
    1374. 

  1374. <span class="sd">    &quot;&quot;&quot;</span>
    1375. 

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

  1376. 

  1377. <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>
    1378. 

  1378.     <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>
    1379. 

  1379.         <span class="sd">&quot;&quot;&quot;Stops this Server.</span>
    1380. 

  1380. 

  1381. <span class="sd">    This method immediately stop service of new RPCs in all cases.</span>
    1382. 

  1382. <span class="sd">    If a grace period is specified, this method returns immediately</span>
    1383. 

  1383. <span class="sd">    and all RPCs active at the end of the grace period are aborted.</span>
    1384. 

  1384. 

  1385. <span class="sd">    If a grace period is not specified, then all existing RPCs are</span>
    1386. 

  1386. <span class="sd">    teriminated immediately and the this method blocks until the last</span>
    1387. 

  1387. <span class="sd">    RPC handler terminates.</span>
    1388. 

  1388. 

  1389. <span class="sd">    This method is idempotent and may be called at any time. Passing a smaller</span>
    1390. 

  1390. <span class="sd">    grace value in subsequentcall will have the effect of stopping the Server</span>
    1391. 

  1391. <span class="sd">    sooner. Passing a larger grace value in subsequent call *will not* have the</span>
    1392. 

  1392. <span class="sd">    effect of stopping the server later (i.e. the most restrictive grace</span>
    1393. 

  1393. <span class="sd">    value is used).</span>
    1394. 

  1394. 

  1395. <span class="sd">    Args:</span>
    1396. 

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

  1397. 

  1398. <span class="sd">    Returns:</span>
    1399. 

  1399. <span class="sd">      A threading.Event that will be set when this Server has completely</span>
    1400. 

  1400. <span class="sd">      stopped, i.e. when running RPCs either complete or are aborted and</span>
    1401. 

  1401. <span class="sd">      all handlers have terminated.</span>
    1402. 

  1402. <span class="sd">    &quot;&quot;&quot;</span>
    1403. 

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

  1404. 

  1405. 

  1406. <span class="c1">#################################  Functions    ################################</span>
    1407. 

  1407. 

  1408. 

  1409. <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>
    1410. 

  1410.                                    <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1411. 

  1411.                                    <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1412. 

  1412.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-unary RPC method.</span>
    1413. 

  1413. 

  1414. <span class="sd">  Args:</span>
    1415. 

  1415. <span class="sd">    behavior: The implementation of an RPC that accepts one request and returns</span>
    1416. 

  1416. <span class="sd">    one response.</span>
    1417. 

  1417. <span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
    1418. 

  1418. <span class="sd">    response_serializer: An optional behavior for response serialization.</span>
    1419. 

  1419. 

  1420. <span class="sd">  Returns:</span>
    1421. 

  1421. <span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1422. 

  1422. <span class="sd">  &quot;&quot;&quot;</span>
    1423. 

  1423.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1424. 

  1424.     <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>
    1425. 

  1425.                                        <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>
    1426. 

  1426.                                        <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1427. 

  1427. 

  1428. 

  1429. <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>
    1430. 

  1430.                                     <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1431. 

  1431.                                     <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1432. 

  1432.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a unary-stream RPC method.</span>
    1433. 

  1433. 

  1434. <span class="sd">  Args:</span>
    1435. 

  1435. <span class="sd">    behavior: The implementation of an RPC that accepts one request and returns</span>
    1436. 

  1436. <span class="sd">      an iterator of response values.</span>
    1437. 

  1437. <span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
    1438. 

  1438. <span class="sd">    response_serializer: An optional behavior for response serialization.</span>
    1439. 

  1439. 

  1440. <span class="sd">  Returns:</span>
    1441. 

  1441. <span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1442. 

  1442. <span class="sd">  &quot;&quot;&quot;</span>
    1443. 

  1443.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1444. 

  1444.     <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>
    1445. 

  1445.                                        <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>
    1446. 

  1446.                                        <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1447. 

  1447. 

  1448. 

  1449. <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>
    1450. 

  1450.                                     <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1451. 

  1451.                                     <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1452. 

  1452.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-unary RPC method.</span>
    1453. 

  1453. 

  1454. <span class="sd">  Args:</span>
    1455. 

  1455. <span class="sd">    behavior: The implementation of an RPC that accepts an iterator of request</span>
    1456. 

  1456. <span class="sd">    values and returns a single response value.</span>
    1457. 

  1457. <span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
    1458. 

  1458. <span class="sd">    response_serializer: An optional behavior for response serialization.</span>
    1459. 

  1459. 

  1460. <span class="sd">  Returns:</span>
    1461. 

  1461. <span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1462. 

  1462. <span class="sd">  &quot;&quot;&quot;</span>
    1463. 

  1463.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1464. 

  1464.     <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>
    1465. 

  1465.                                        <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>
    1466. 

  1466.                                        <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1467. 

  1467. 

  1468. 

  1469. <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>
    1470. 

  1470.                                      <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1471. 

  1471.                                      <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1472. 

  1472.     <span class="sd">&quot;&quot;&quot;Creates an RpcMethodHandler for a stream-stream RPC method.</span>
    1473. 

  1473. 

  1474. <span class="sd">  Args:</span>
    1475. 

  1475. <span class="sd">    behavior: The implementation of an RPC that accepts an iterator of request</span>
    1476. 

  1476. <span class="sd">    values and returns an iterator of response values.</span>
    1477. 

  1477. <span class="sd">    request_deserializer: An optional behavior for request deserialization.</span>
    1478. 

  1478. <span class="sd">    response_serializer: An optional behavior for response serialization.</span>
    1479. 

  1479. 

  1480. <span class="sd">  Returns:</span>
    1481. 

  1481. <span class="sd">    An RpcMethodHandler object that is typically used by grpc.Server.</span>
    1482. 

  1482. <span class="sd">  &quot;&quot;&quot;</span>
    1483. 

  1483.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1484. 

  1484.     <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>
    1485. 

  1485.                                        <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>
    1486. 

  1486.                                        <span class="n">behavior</span><span class="p">)</span></div>
    1487. 

  1487. 

  1488. 

  1489. <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>
    1490. 

  1490.     <span class="sd">&quot;&quot;&quot;Creates a GenericRpcHandler from RpcMethodHandlers.</span>
    1491. 

  1491. 

  1492. <span class="sd">  Args:</span>
    1493. 

  1493. <span class="sd">    service: The name of the service that is implemented by the method_handlers.</span>
    1494. 

  1494. <span class="sd">    method_handlers: A dictionary that maps method names to corresponding</span>
    1495. 

  1495. <span class="sd">    RpcMethodHandler.</span>
    1496. 

  1496. 

  1497. <span class="sd">  Returns:</span>
    1498. 

  1498. <span class="sd">    A GenericRpcHandler. This is typically added to the grpc.Server object</span>
    1499. 

  1499. <span class="sd">    with add_generic_rpc_handlers() before starting the server.</span>
    1500. 

  1500. <span class="sd">  &quot;&quot;&quot;</span>
    1501. 

  1501.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1502. 

  1502.     <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>
    1503. 

  1503. 

  1504. 

  1505. <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>
    1506. 

  1506.                             <span class="n">private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1507. 

  1507.                             <span class="n">certificate_chain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1508. 

  1508.     <span class="sd">&quot;&quot;&quot;Creates a ChannelCredentials for use with an SSL-enabled Channel.</span>
    1509. 

  1509. 

  1510. <span class="sd">    Args:</span>
    1511. 

  1511. <span class="sd">      root_certificates: The PEM-encoded root certificates as a byte string,</span>
    1512. 

  1512. <span class="sd">        or None to retrieve them from a default location chosen by gRPC</span>
    1513. 

  1513. <span class="sd">        runtime.</span>
    1514. 

  1514. <span class="sd">      private_key: The PEM-encoded private key as a byte string, or None if no</span>
    1515. 

  1515. <span class="sd">        private key should be used.</span>
    1516. 

  1516. <span class="sd">      certificate_chain: The PEM-encoded certificate chain as a byte string</span>
    1517. 

  1517. <span class="sd">        to use or or None if no certificate chain should be used.</span>
    1518. 

  1518. 

  1519. <span class="sd">    Returns:</span>
    1520. 

  1520. <span class="sd">      A ChannelCredentials for use with an SSL-enabled Channel.</span>
    1521. 

  1521. <span class="sd">    &quot;&quot;&quot;</span>
    1522. 

  1522.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1523. 

  1523.         <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>
    1524. 

  1524.                                       <span class="n">certificate_chain</span><span class="p">))</span></div>
    1525. 

  1525. 

  1526. 

  1527. <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>
    1528. 

  1528.     <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an AuthMetadataPlugin.</span>
    1529. 

  1529. 

  1530. <span class="sd">    Args:</span>
    1531. 

  1531. <span class="sd">      metadata_plugin: An AuthMetadataPlugin to use for authentication.</span>
    1532. 

  1532. <span class="sd">      name: An optional name for the plugin.</span>
    1533. 

  1533. 

  1534. <span class="sd">    Returns:</span>
    1535. 

  1535. <span class="sd">      A CallCredentials.</span>
    1536. 

  1536. <span class="sd">    &quot;&quot;&quot;</span>
    1537. 

  1537.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_plugin_wrapping</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1538. 

  1538.     <span class="k">return</span> <span class="n">_plugin_wrapping</span><span class="o">.</span><span class="n">metadata_plugin_call_credentials</span><span class="p">(</span><span class="n">metadata_plugin</span><span class="p">,</span>
    1539. 

  1539.                                                              <span class="n">name</span><span class="p">)</span></div>
    1540. 

  1540. 

  1541. 

  1542. <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>
    1543. 

  1543.     <span class="sd">&quot;&quot;&quot;Construct CallCredentials from an access token.</span>
    1544. 

  1544. 

  1545. <span class="sd">    Args:</span>
    1546. 

  1546. <span class="sd">      access_token: A string to place directly in the http request</span>
    1547. 

  1547. <span class="sd">        authorization header, for example</span>
    1548. 

  1548. <span class="sd">        &quot;authorization: Bearer &lt;access_token&gt;&quot;.</span>
    1549. 

  1549. 

  1550. <span class="sd">    Returns:</span>
    1551. 

  1551. <span class="sd">      A CallCredentials.</span>
    1552. 

  1552. <span class="sd">    &quot;&quot;&quot;</span>
    1553. 

  1553.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_auth</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1554. 

  1554.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_plugin_wrapping</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1555. 

  1555.     <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>
    1556. 

  1556.         <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>
    1557. 

  1557. 

  1558. 

  1559. <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>
    1560. 

  1560.     <span class="sd">&quot;&quot;&quot;Compose multiple CallCredentials to make a new CallCredentials.</span>
    1561. 

  1561. 

  1562. <span class="sd">    Args:</span>
    1563. 

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

  1564. 

  1565. <span class="sd">    Returns:</span>
    1566. 

  1566. <span class="sd">      A CallCredentials object composed of the given CallCredentials objects.</span>
    1567. 

  1567. <span class="sd">    &quot;&quot;&quot;</span>
    1568. 

  1568.     <span class="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
    1569. 

  1569.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeCallCredentials</span><span class="p">(</span>
    1570. 

  1570.             <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>
    1571. 

  1571.                   <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>
    1572. 

  1572. 

  1573. 

  1574. <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>
    1575. 

  1575.     <span class="sd">&quot;&quot;&quot;Compose a ChannelCredentials and one or more CallCredentials objects.</span>
    1576. 

  1576. 

  1577. <span class="sd">    Args:</span>
    1578. 

  1578. <span class="sd">      channel_credentials: A ChannelCredentials object.</span>
    1579. 

  1579. <span class="sd">      *call_credentials: One or more CallCredentials objects.</span>
    1580. 

  1580. 

  1581. <span class="sd">    Returns:</span>
    1582. 

  1582. <span class="sd">      A ChannelCredentials composed of the given ChannelCredentials and</span>
    1583. 

  1583. <span class="sd">        CallCredentials objects.</span>
    1584. 

  1584. <span class="sd">    &quot;&quot;&quot;</span>
    1585. 

  1585.     <span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
    1586. 

  1586.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">CompositeChannelCredentials</span><span class="p">(</span>
    1587. 

  1587.             <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>
    1588. 

  1588.                   <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>
    1589. 

  1589.             <span class="n">channel_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
    1590. 

  1590. 

  1591. 

  1592. <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>
    1593. 

  1593.                            <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1594. 

  1594.                            <span class="n">require_client_auth</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1595. 

  1595.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an SSL-enabled Server.</span>
    1596. 

  1596. 

  1597. <span class="sd">  Args:</span>
    1598. 

  1598. <span class="sd">    private_key_certificate_chain_pairs: A list of pairs of the form</span>
    1599. 

  1599. <span class="sd">      [PEM-encoded private key, PEM-encoded certificate chain].</span>
    1600. 

  1600. <span class="sd">    root_certificates: An optional byte string of PEM-encoded client root</span>
    1601. 

  1601. <span class="sd">      certificates that the server will use to verify client authentication.</span>
    1602. 

  1602. <span class="sd">      If omitted, require_client_auth must also be False.</span>
    1603. 

  1603. <span class="sd">    require_client_auth: A boolean indicating whether or not to require</span>
    1604. 

  1604. <span class="sd">      clients to be authenticated. May only be True if root_certificates</span>
    1605. 

  1605. <span class="sd">      is not None.</span>
    1606. 

  1606. 

  1607. <span class="sd">  Returns:</span>
    1608. 

  1608. <span class="sd">    A ServerCredentials for use with an SSL-enabled Server. Typically, this</span>
    1609. 

  1609. <span class="sd">    object is an argument to add_secure_port() method during server setup.</span>
    1610. 

  1610. <span class="sd">  &quot;&quot;&quot;</span>
    1611. 

  1611.     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">private_key_certificate_chain_pairs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    1612. 

  1612.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1613. 

  1613.             <span class="s1">&#39;At least one private key-certificate chain pair is required!&#39;</span><span class="p">)</span>
    1614. 

  1614.     <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>
    1615. 

  1615.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1616. 

  1616.             <span class="s1">&#39;Illegal to require client auth without providing root certificates!&#39;</span>
    1617. 

  1617.         <span class="p">)</span>
    1618. 

  1618.     <span class="k">else</span><span class="p">:</span>
    1619. 

  1619.         <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1620. 

  1620.             <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>
    1621. 

  1621.                 <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>
    1622. 

  1622.                 <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>
    1623. 

  1623.             <span class="p">],</span> <span class="n">require_client_auth</span><span class="p">))</span></div>
    1624. 

  1624. 

  1625. 

  1626. <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>
    1627. 

  1627.                                          <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1628. 

  1628.     <span class="sd">&quot;&quot;&quot;Creates a ServerCertificateConfiguration for use with a Server.</span>
    1629. 

  1629. 

  1630. <span class="sd">    Args:</span>
    1631. 

  1631. <span class="sd">      private_key_certificate_chain_pairs: A collection of pairs of</span>
    1632. 

  1632. <span class="sd">        the form [PEM-encoded private key, PEM-encoded certificate</span>
    1633. 

  1633. <span class="sd">        chain].</span>
    1634. 

  1634. <span class="sd">      root_certificates: An optional byte string of PEM-encoded client root</span>
    1635. 

  1635. <span class="sd">        certificates that the server will use to verify client authentication.</span>
    1636. 

  1636. 

  1637. <span class="sd">    Returns:</span>
    1638. 

  1638. <span class="sd">      A ServerCertificateConfiguration that can be returned in the certificate</span>
    1639. 

  1639. <span class="sd">        configuration fetching callback.</span>
    1640. 

  1640. <span class="sd">    &quot;&quot;&quot;</span>
    1641. 

  1641.     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">private_key_certificate_chain_pairs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
    1642. 

  1642.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1643. 

  1643.             <span class="s1">&#39;At least one private key-certificate chain pair is required!&#39;</span><span class="p">)</span>
    1644. 

  1644.     <span class="k">else</span><span class="p">:</span>
    1645. 

  1645.         <span class="k">return</span> <span class="n">ServerCertificateConfiguration</span><span class="p">(</span>
    1646. 

  1646.             <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>
    1647. 

  1647.                 <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>
    1648. 

  1648.                 <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>
    1649. 

  1649.             <span class="p">]))</span></div>
    1650. 

  1650. 

  1651. 

  1652. <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>
    1653. 

  1653.                                    <span class="n">certificate_configuration_fetcher</span><span class="p">,</span>
    1654. 

  1654.                                    <span class="n">require_client_authentication</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    1655. 

  1655.     <span class="sd">&quot;&quot;&quot;Creates a ServerCredentials for use with an SSL-enabled Server.</span>
    1656. 

  1656. 

  1657. <span class="sd">    Args:</span>
    1658. 

  1658. <span class="sd">      initial_certificate_configuration (ServerCertificateConfiguration): The</span>
    1659. 

  1659. <span class="sd">        certificate configuration with which the server will be initialized.</span>
    1660. 

  1660. <span class="sd">      certificate_configuration_fetcher (callable): A callable that takes no</span>
    1661. 

  1661. <span class="sd">        arguments and should return a ServerCertificateConfiguration to</span>
    1662. 

  1662. <span class="sd">        replace the server&#39;s current certificate, or None for no change</span>
    1663. 

  1663. <span class="sd">        (i.e., the server will continue its current certificate</span>
    1664. 

  1664. <span class="sd">        config). The library will call this callback on *every* new</span>
    1665. 

  1665. <span class="sd">        client connection before starting the TLS handshake with the</span>
    1666. 

  1666. <span class="sd">        client, thus allowing the user application to optionally</span>
    1667. 

  1667. <span class="sd">        return a new ServerCertificateConfiguration that the server will then</span>
    1668. 

  1668. <span class="sd">        use for the handshake.</span>
    1669. 

  1669. <span class="sd">      require_client_authentication: A boolean indicating whether or not to</span>
    1670. 

  1670. <span class="sd">        require clients to be authenticated.</span>
    1671. 

  1671. 

  1672. <span class="sd">    Returns:</span>
    1673. 

  1673. <span class="sd">      A ServerCredentials.</span>
    1674. 

  1674. <span class="sd">    &quot;&quot;&quot;</span>
    1675. 

  1675.     <span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span>
    1676. 

  1676.         <span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_credentials_ssl_dynamic_cert_config</span><span class="p">(</span>
    1677. 

  1677.             <span class="n">initial_certificate_configuration</span><span class="p">,</span>
    1678. 

  1678.             <span class="n">certificate_configuration_fetcher</span><span class="p">,</span> <span class="n">require_client_authentication</span><span class="p">))</span></div>
    1679. 

  1679. 

  1680. 

  1681. <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>
    1682. 

  1682.     <span class="sd">&quot;&quot;&quot;Creates a Future that tracks when a Channel is ready.</span>
    1683. 

  1683. 

  1684. <span class="sd">  Cancelling the Future does not affect the channel&#39;s state machine.</span>
    1685. 

  1685. <span class="sd">  It merely decouples the Future from channel state machine.</span>
    1686. 

  1686. 

  1687. <span class="sd">  Args:</span>
    1688. 

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

  1689. 

  1690. <span class="sd">  Returns:</span>
    1691. 

  1691. <span class="sd">    A Future object that matures when the channel connectivity is</span>
    1692. 

  1692. <span class="sd">    ChannelConnectivity.READY.</span>
    1693. 

  1693. <span class="sd">  &quot;&quot;&quot;</span>
    1694. 

  1694.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1695. 

  1695.     <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>
    1696. 

  1696. 

  1697. 

  1698. <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>
    1699. 

  1699.     <span class="sd">&quot;&quot;&quot;Creates an insecure Channel to a server.</span>
    1700. 

  1700. 

  1701. <span class="sd">  Args:</span>
    1702. 

  1702. <span class="sd">    target: The server address</span>
    1703. 

  1703. <span class="sd">    options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
    1704. 

  1704. <span class="sd">    to configure the channel.</span>
    1705. 

  1705. 

  1706. <span class="sd">  Returns:</span>
    1707. 

  1707. <span class="sd">    A Channel object.</span>
    1708. 

  1708. <span class="sd">  &quot;&quot;&quot;</span>
    1709. 

  1709.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1710. 

  1710.     <span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
    1711. 

  1711. 

  1712. 

  1713. <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>
    1714. 

  1714.     <span class="sd">&quot;&quot;&quot;Creates a secure Channel to a server.</span>
    1715. 

  1715. 

  1716. <span class="sd">  Args:</span>
    1717. 

  1717. <span class="sd">    target: The server address.</span>
    1718. 

  1718. <span class="sd">    credentials: A ChannelCredentials instance.</span>
    1719. 

  1719. <span class="sd">    options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
    1720. 

  1720. <span class="sd">    to configure the channel.</span>
    1721. 

  1721. 

  1722. <span class="sd">  Returns:</span>
    1723. 

  1723. <span class="sd">    A Channel object.</span>
    1724. 

  1724. <span class="sd">  &quot;&quot;&quot;</span>
    1725. 

  1725.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1726. 

  1726.     <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>
    1727. 

  1727.                             <span class="n">credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">)</span></div>
    1728. 

  1728. 

  1729. 

  1730. <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>
    1731. 

  1731.     <span class="sd">&quot;&quot;&quot;Intercepts a channel through a set of interceptors.</span>
    1732. 

  1732. 

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

  1734. 

  1735. <span class="sd">    Args:</span>
    1736. 

  1736. <span class="sd">      channel: A Channel.</span>
    1737. 

  1737. <span class="sd">      interceptors: Zero or more objects of type</span>
    1738. 

  1738. <span class="sd">        UnaryUnaryClientInterceptor,</span>
    1739. 

  1739. <span class="sd">        UnaryStreamClientInterceptor,</span>
    1740. 

  1740. <span class="sd">        StreamUnaryClientInterceptor, or</span>
    1741. 

  1741. <span class="sd">        StreamStreamClientInterceptor.</span>
    1742. 

  1742. <span class="sd">        Interceptors are given control in the order they are listed.</span>
    1743. 

  1743. 

  1744. <span class="sd">    Returns:</span>
    1745. 

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

  1746. 

  1747. <span class="sd">    Raises:</span>
    1748. 

  1748. <span class="sd">      TypeError: If interceptor does not derive from any of</span>
    1749. 

  1749. <span class="sd">        UnaryUnaryClientInterceptor,</span>
    1750. 

  1750. <span class="sd">        UnaryStreamClientInterceptor,</span>
    1751. 

  1751. <span class="sd">        StreamUnaryClientInterceptor, or</span>
    1752. 

  1752. <span class="sd">        StreamStreamClientInterceptor.</span>
    1753. 

  1753. <span class="sd">    &quot;&quot;&quot;</span>
    1754. 

  1754.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_interceptor</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1755. 

  1755.     <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>
    1756. 

  1756. 

  1757. 

  1758. <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>
    1759. 

  1759.            <span class="n">handlers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1760. 

  1760.            <span class="n">interceptors</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1761. 

  1761.            <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    1762. 

  1762.            <span class="n">maximum_concurrent_rpcs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1763. 

  1763.     <span class="sd">&quot;&quot;&quot;Creates a Server with which RPCs can be serviced.</span>
    1764. 

  1764. 

  1765. <span class="sd">    Args:</span>
    1766. 

  1766. <span class="sd">      thread_pool: A futures.ThreadPoolExecutor to be used by the Server</span>
    1767. 

  1767. <span class="sd">        to execute RPC handlers.</span>
    1768. 

  1768. <span class="sd">      handlers: An optional list of GenericRpcHandlers used for executing RPCs.</span>
    1769. 

  1769. <span class="sd">        More handlers may be added by calling add_generic_rpc_handlers any time</span>
    1770. 

  1770. <span class="sd">        before the server is started.</span>
    1771. 

  1771. <span class="sd">      interceptors: An optional list of ServerInterceptor objects that observe</span>
    1772. 

  1772. <span class="sd">        and optionally manipulate the incoming RPCs before handing them over to</span>
    1773. 

  1773. <span class="sd">        handlers. The interceptors are given control in the order they are</span>
    1774. 

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

  1775. <span class="sd">      options: An optional list of key-value pairs (channel args in gRPC runtime)</span>
    1776. 

  1776. <span class="sd">      to configure the channel.</span>
    1777. 

  1777. <span class="sd">      maximum_concurrent_rpcs: The maximum number of concurrent RPCs this server</span>
    1778. 

  1778. <span class="sd">        will service before returning RESOURCE_EXHAUSTED status, or None to</span>
    1779. 

  1779. <span class="sd">        indicate no limit.</span>
    1780. 

  1780. 

  1781. <span class="sd">    Returns:</span>
    1782. 

  1782. <span class="sd">      A Server object.</span>
    1783. 

  1783. <span class="sd">    &quot;&quot;&quot;</span>
    1784. 

  1784.     <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_server</span>  <span class="c1"># pylint: disable=cyclic-import</span>
    1785. 

  1785.     <span class="k">return</span> <span class="n">_server</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="n">thread_pool</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">handlers</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">handlers</span><span class="p">,</span> <span class="p">()</span>
    1786. 

  1786.                           <span class="k">if</span> <span class="n">interceptors</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">interceptors</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span>
    1787. 

  1787.                           <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span><span class="p">,</span> <span class="n">maximum_concurrent_rpcs</span><span class="p">)</span></div>
    1788. 

  1788. 

  1789. 

  1790. <span class="c1">###################################  __all__  #################################</span>
    1791. 

  1791. 

  1792. <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
    1793. 

  1793.     <span class="s1">&#39;FutureTimeoutError&#39;</span><span class="p">,</span> <span class="s1">&#39;FutureCancelledError&#39;</span><span class="p">,</span> <span class="s1">&#39;Future&#39;</span><span class="p">,</span>
    1794. 

  1794.     <span class="s1">&#39;ChannelConnectivity&#39;</span><span class="p">,</span> <span class="s1">&#39;StatusCode&#39;</span><span class="p">,</span> <span class="s1">&#39;RpcError&#39;</span><span class="p">,</span> <span class="s1">&#39;RpcContext&#39;</span><span class="p">,</span> <span class="s1">&#39;Call&#39;</span><span class="p">,</span>
    1795. 

  1795.     <span class="s1">&#39;ChannelCredentials&#39;</span><span class="p">,</span> <span class="s1">&#39;CallCredentials&#39;</span><span class="p">,</span> <span class="s1">&#39;AuthMetadataContext&#39;</span><span class="p">,</span>
    1796. 

  1796.     <span class="s1">&#39;AuthMetadataPluginCallback&#39;</span><span class="p">,</span> <span class="s1">&#39;AuthMetadataPlugin&#39;</span><span class="p">,</span> <span class="s1">&#39;ClientCallDetails&#39;</span><span class="p">,</span>
    1797. 

  1797.     <span class="s1">&#39;ServerCertificateConfiguration&#39;</span><span class="p">,</span> <span class="s1">&#39;ServerCredentials&#39;</span><span class="p">,</span>
    1798. 

  1798.     <span class="s1">&#39;UnaryUnaryMultiCallable&#39;</span><span class="p">,</span> <span class="s1">&#39;UnaryStreamMultiCallable&#39;</span><span class="p">,</span>
    1799. 

  1799.     <span class="s1">&#39;StreamUnaryMultiCallable&#39;</span><span class="p">,</span> <span class="s1">&#39;StreamStreamMultiCallable&#39;</span><span class="p">,</span>
    1800. 

  1800.     <span class="s1">&#39;UnaryUnaryClientInterceptor&#39;</span><span class="p">,</span> <span class="s1">&#39;UnaryStreamClientInterceptor&#39;</span><span class="p">,</span>
    1801. 

  1801.     <span class="s1">&#39;StreamUnaryClientInterceptor&#39;</span><span class="p">,</span> <span class="s1">&#39;StreamStreamClientInterceptor&#39;</span><span class="p">,</span> <span class="s1">&#39;Channel&#39;</span><span class="p">,</span>
    1802. 

  1802.     <span class="s1">&#39;ServicerContext&#39;</span><span class="p">,</span> <span class="s1">&#39;RpcMethodHandler&#39;</span><span class="p">,</span> <span class="s1">&#39;HandlerCallDetails&#39;</span><span class="p">,</span>
    1803. 

  1803.     <span class="s1">&#39;GenericRpcHandler&#39;</span><span class="p">,</span> <span class="s1">&#39;ServiceRpcHandler&#39;</span><span class="p">,</span> <span class="s1">&#39;Server&#39;</span><span class="p">,</span> <span class="s1">&#39;ServerInterceptor&#39;</span><span class="p">,</span>
    1804. 

  1804.     <span class="s1">&#39;unary_unary_rpc_method_handler&#39;</span><span class="p">,</span> <span class="s1">&#39;unary_stream_rpc_method_handler&#39;</span><span class="p">,</span>
    1805. 

  1805.     <span class="s1">&#39;stream_unary_rpc_method_handler&#39;</span><span class="p">,</span> <span class="s1">&#39;stream_stream_rpc_method_handler&#39;</span><span class="p">,</span>
    1806. 

  1806.     <span class="s1">&#39;method_handlers_generic_handler&#39;</span><span class="p">,</span> <span class="s1">&#39;ssl_channel_credentials&#39;</span><span class="p">,</span>
    1807. 

  1807.     <span class="s1">&#39;metadata_call_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;access_token_call_credentials&#39;</span><span class="p">,</span>
    1808. 

  1808.     <span class="s1">&#39;composite_call_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;composite_channel_credentials&#39;</span><span class="p">,</span>
    1809. 

  1809.     <span class="s1">&#39;ssl_server_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;ssl_server_certificate_configuration&#39;</span><span class="p">,</span>
    1810. 

  1810.     <span class="s1">&#39;dynamic_ssl_server_credentials&#39;</span><span class="p">,</span> <span class="s1">&#39;channel_ready_future&#39;</span><span class="p">,</span>
    1811. 

  1811.     <span class="s1">&#39;insecure_channel&#39;</span><span class="p">,</span> <span class="s1">&#39;secure_channel&#39;</span><span class="p">,</span> <span class="s1">&#39;intercept_channel&#39;</span><span class="p">,</span> <span class="s1">&#39;server&#39;</span><span class="p">,)</span>
    1812. 

  1812. 

  1813. <span class="c1">############################### Extension Shims ################################</span>
    1814. 

  1814. 

  1815. <span class="c1"># Here to maintain backwards compatibility; avoid using these in new code!</span>
    1816. 

  1816. <span class="k">try</span><span class="p">:</span>
    1817. 

  1817.     <span class="kn">import</span> <span class="nn">grpc_tools</span>
    1818. 

  1818.     <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>
    1819. 

  1819. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    1820. 

  1820.     <span class="k">pass</span>
    1821. 

  1821. <span class="k">try</span><span class="p">:</span>
    1822. 

  1822.     <span class="kn">import</span> <span class="nn">grpc_health</span>
    1823. 

  1823.     <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>
    1824. 

  1824. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    1825. 

  1825.     <span class="k">pass</span>
    1826. 

  1826. <span class="k">try</span><span class="p">:</span>
    1827. 

  1827.     <span class="kn">import</span> <span class="nn">grpc_reflection</span>
    1828. 

  1828.     <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>
    1829. 

  1829. <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
    1830. 

  1830.     <span class="k">pass</span>
    1831. 

  1831. </pre></div>
    1832. 

  1832. 

  1833.            </div>
    1834. 

  1834.            <div class="articleComments">
    1835. 

  1835.             
    1836. 

  1836.            </div>
    1837. 

  1837.           </div>
    1838. 

  1838.           <footer>
    1839. 

  1839.   
    1840. 

  1840. 

  1841.   <hr/>
    1842. 

  1842. 

  1843.   <div role="contentinfo">
    1844. 

  1844.     <p>
    1845. 

  1845.         &copy; Copyright 2016, The gRPC Authors.
    1846. 

  1846. 

  1847.     </p>
    1848. 

  1848.   </div>
    1849. 

  1849.   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
    1850. 

  1850. 

  1851. </footer>
    1852. 

  1852. 

  1853.         </div>
    1854. 

  1854.       </div>
    1855. 

  1855. 

  1856.     </section>
    1857. 

  1857. 

  1858.   </div>
    1859. 

  1859.   
    1860. 

  1860. 

  1861. 

  1862.   
    1863. 

  1863. 

  1864.     <script type="text/javascript">
    1865. 

  1865.         var DOCUMENTATION_OPTIONS = {
    1866. 

  1866.             URL_ROOT:'../',
    1867. 

  1867.             VERSION:'1.8.0',
    1868. 

  1868.             COLLAPSE_INDEX:false,
    1869. 

  1869.             FILE_SUFFIX:'.html',
    1870. 

  1870.             HAS_SOURCE:  true,
    1871. 

  1871.             SOURCELINK_SUFFIX: '.txt'
    1872. 

  1872.         };
    1873. 

  1873.     </script>
    1874. 

  1874.       <script type="text/javascript" src="../_static/jquery.js"></script>
    1875. 

  1875.       <script type="text/javascript" src="../_static/underscore.js"></script>
    1876. 

  1876.       <script type="text/javascript" src="../_static/doctools.js"></script>
    1877. 

  1877. 

  1878.   
    1879. 

  1879. 

  1880.   
    1881. 

  1881.   
    1882. 

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

  1883.   
    1884. 

  1884. 

  1885.   
    1886. 

  1886.   
    1887. 

  1887.   <script type="text/javascript">
    1888. 

  1888.       jQuery(function () {
    1889. 

  1889.           SphinxRtdTheme.StickyNav.enable();
    1890. 

  1890.       });
    1891. 

  1891.   </script>
    1892. 

  1892.    
    1893. 

  1893. 

  1894. </body>
    1895. 

  1895. </html>
    1896.