|
@@ -8,7 +8,7 @@
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
- <title>grpc — grpcio 0.15.0 documentation</title>
|
|
|
+ <title>grpc — grpcio 1.0.0rc1 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
@@ -30,7 +30,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
- <link rel="top" title="grpcio 0.15.0 documentation" href="../index.html"/>
|
|
|
+ <link rel="top" title="grpcio 1.0.0rc1 documentation" href="../index.html"/>
|
|
|
<link rel="up" title="Module code" href="index.html"/>
|
|
|
|
|
|
|
|
@@ -60,7 +60,7 @@
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
|
- 0.15.0
|
|
|
+ 1.0.0rc1
|
|
|
</div>
|
|
|
|
|
|
|
|
@@ -83,6 +83,7 @@
|
|
|
|
|
|
<ul>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../grpc.html">grpc package</a></li>
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../grpc.html#glossary">Glossary</a></li>
|
|
|
</ul>
|
|
|
|
|
|
|
|
@@ -168,7 +169,7 @@
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">six</span>
|
|
|
|
|
|
-<span class="kn">from</span> <span class="nn">grpc._cython</span> <span class="kn">import</span> <span class="n">cygrpc</span> <span class="k">as</span> <span class="n">_cygrpc</span>
|
|
|
+<span class="kn">from</span> <span class="nn">grpc._cython</span> <span class="k">import</span> <span class="n">cygrpc</span> <span class="k">as</span> <span class="n">_cygrpc</span>
|
|
|
|
|
|
|
|
|
<span class="c1">############################## Future Interface ###############################</span>
|
|
@@ -189,7 +190,7 @@
|
|
|
<span class="sd"> or may have already completed.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Future.cancel"><a class="viewcode-back" href="../grpc.html#grpc.Future.cancel">[docs]</a> <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Attempts to cancel the computation.</span>
|
|
|
|
|
@@ -206,7 +207,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Future.cancelled"><a class="viewcode-back" href="../grpc.html#grpc.Future.cancelled">[docs]</a> <span class="k">def</span> <span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Describes whether the computation was cancelled.</span>
|
|
|
|
|
@@ -220,7 +221,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Future.running"><a class="viewcode-back" href="../grpc.html#grpc.Future.running">[docs]</a> <span class="k">def</span> <span class="nf">running</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Describes whether the computation is taking place.</span>
|
|
|
|
|
@@ -233,7 +234,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Future.done"><a class="viewcode-back" href="../grpc.html#grpc.Future.done">[docs]</a> <span class="k">def</span> <span class="nf">done</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Describes whether the computation has taken place.</span>
|
|
|
|
|
@@ -246,8 +247,8 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="Future.result"><a class="viewcode-back" href="../grpc.html#grpc.Future.result">[docs]</a> <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="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Future.result"><a class="viewcode-back" href="../grpc.html#grpc.Future.result">[docs]</a> <span class="k">def</span> <span class="nf">result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the outcome of the computation or raises its exception.</span>
|
|
|
|
|
|
<span class="sd"> This method may return immediately or may block.</span>
|
|
@@ -269,8 +270,8 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="Future.exception"><a class="viewcode-back" href="../grpc.html#grpc.Future.exception">[docs]</a> <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="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Future.exception"><a class="viewcode-back" href="../grpc.html#grpc.Future.exception">[docs]</a> <span class="k">def</span> <span class="nf">exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Return the exception raised by the computation.</span>
|
|
|
|
|
|
<span class="sd"> This method may return immediately or may block.</span>
|
|
@@ -292,8 +293,8 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="Future.traceback"><a class="viewcode-back" href="../grpc.html#grpc.Future.traceback">[docs]</a> <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="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Future.traceback"><a class="viewcode-back" href="../grpc.html#grpc.Future.traceback">[docs]</a> <span class="k">def</span> <span class="nf">traceback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Access the traceback of the exception raised by the computation.</span>
|
|
|
|
|
|
<span class="sd"> This method may return immediately or may block.</span>
|
|
@@ -315,7 +316,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<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="k">def</span> <span class="nf">add_done_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fn</span><span class="p">):</span>
|
|
|
<span class="sd">"""Adds a function to be called at completion of the computation.</span>
|
|
|
|
|
@@ -334,7 +335,7 @@
|
|
|
<span class="c1">################################ gRPC Enums ##################################</span>
|
|
|
|
|
|
|
|
|
-<span class="nd">@enum.unique</span>
|
|
|
+<span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
|
|
|
<div class="viewcode-block" id="ChannelConnectivity"><a class="viewcode-back" href="../grpc.html#grpc.ChannelConnectivity">[docs]</a><span class="k">class</span> <span class="nc">ChannelConnectivity</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
|
|
|
<span class="sd">"""Mirrors grpc_connectivity_state in the gRPC Core.</span>
|
|
|
|
|
@@ -354,7 +355,7 @@
|
|
|
<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">'shutdown'</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
-<span class="nd">@enum.unique</span>
|
|
|
+<span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
|
|
|
<div class="viewcode-block" id="StatusCode"><a class="viewcode-back" href="../grpc.html#grpc.StatusCode">[docs]</a><span class="k">class</span> <span class="nc">StatusCode</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
|
|
|
<span class="sd">"""Mirrors grpc_status_code in the gRPC Core."""</span>
|
|
|
<span class="n">OK</span> <span class="o">=</span> <span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">ok</span><span class="p">,</span> <span class="s1">'ok'</span><span class="p">)</span>
|
|
@@ -394,12 +395,12 @@
|
|
|
<div class="viewcode-block" id="RpcContext"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext">[docs]</a><span class="k">class</span> <span class="nc">RpcContext</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Provides RPC-related information and action."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="RpcContext.is_active"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.is_active">[docs]</a> <span class="k">def</span> <span class="nf">is_active</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Describes whether the RPC is active or has terminated."""</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="RpcContext.time_remaining"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.time_remaining">[docs]</a> <span class="k">def</span> <span class="nf">time_remaining</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Describes the length of allowed time remaining for the RPC.</span>
|
|
|
|
|
@@ -410,7 +411,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="RpcContext.cancel"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.cancel">[docs]</a> <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Cancels the RPC.</span>
|
|
|
|
|
@@ -418,7 +419,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="RpcContext.add_callback"><a class="viewcode-back" href="../grpc.html#grpc.RpcContext.add_callback">[docs]</a> <span class="k">def</span> <span class="nf">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
|
|
|
<span class="sd">"""Registers a callback to be called on RPC termination.</span>
|
|
|
|
|
@@ -439,29 +440,29 @@
|
|
|
<div class="viewcode-block" id="Call"><a class="viewcode-back" href="../grpc.html#grpc.Call">[docs]</a><span class="k">class</span> <span class="nc">Call</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="n">RpcContext</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Invocation-side utility object for an RPC."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Call.initial_metadata"><a class="viewcode-back" href="../grpc.html#grpc.Call.initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the initial metadata from the service-side of the RPC.</span>
|
|
|
|
|
|
<span class="sd"> This method blocks until the value is available.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
-<span class="sd"> The initial metadata as a sequence of pairs of bytes.</span>
|
|
|
+<span class="sd"> The initial :term:`metadata`.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Call.trailing_metadata"><a class="viewcode-back" href="../grpc.html#grpc.Call.trailing_metadata">[docs]</a> <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the trailing metadata from the service-side of the RPC.</span>
|
|
|
|
|
|
<span class="sd"> This method blocks until the value is available.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
-<span class="sd"> The trailing metadata as a sequence of pairs of bytes.</span>
|
|
|
+<span class="sd"> The trailing :term:`metadata`.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Call.code"><a class="viewcode-back" href="../grpc.html#grpc.Call.code">[docs]</a> <span class="k">def</span> <span class="nf">code</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the status code emitted by the service-side of the RPC.</span>
|
|
|
|
|
@@ -472,14 +473,14 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Call.details"><a class="viewcode-back" href="../grpc.html#grpc.Call.details">[docs]</a> <span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the details value emitted by the service-side of the RPC.</span>
|
|
|
|
|
|
<span class="sd"> This method blocks until the value is available.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
-<span class="sd"> The bytes of the details of the RPC.</span>
|
|
|
+<span class="sd"> The details string of the RPC.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
|
|
|
@@ -524,21 +525,20 @@
|
|
|
<div class="viewcode-block" id="AuthMetadataPluginCallback"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPluginCallback">[docs]</a><span class="k">class</span> <span class="nc">AuthMetadataPluginCallback</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Callback object received by a metadata plugin."""</span>
|
|
|
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="AuthMetadataPluginCallback.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPluginCallback.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
|
|
|
<span class="sd">"""Inform the gRPC runtime of the metadata to construct a CallCredentials.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> metadata: An iterable of 2-sequences (e.g. tuples) of metadata key/value</span>
|
|
|
-<span class="sd"> pairs.</span>
|
|
|
+<span class="sd"> metadata: The :term:`metadata` used to construct the CallCredentials.</span>
|
|
|
<span class="sd"> error: An Exception to indicate error or None to indicate success.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="AuthMetadataPlugin"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPlugin">[docs]</a><span class="k">class</span> <span class="nc">AuthMetadataPlugin</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""A specification for custom authentication."""</span>
|
|
|
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="AuthMetadataPlugin.__call__"><a class="viewcode-back" href="../grpc.html#grpc.AuthMetadataPlugin.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
|
|
|
<span class="sd">"""Implements authentication by passing metadata to a callback.</span>
|
|
|
|
|
|
<span class="sd"> Implementations of this method must not block.</span>
|
|
@@ -549,7 +549,7 @@
|
|
|
<span class="sd"> callback: An AuthMetadataPluginCallback to be invoked either synchronously</span>
|
|
|
<span class="sd"> or asynchronously.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="ServerCredentials"><a class="viewcode-back" href="../grpc.html#grpc.ServerCredentials">[docs]</a><span class="k">class</span> <span class="nc">ServerCredentials</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
@@ -569,14 +569,14 @@
|
|
|
<div class="viewcode-block" id="UnaryUnaryMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryMultiCallable</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Affords invoking a unary-unary RPC."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.__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">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request: The request value for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -588,16 +588,16 @@
|
|
|
<span class="sd"> raised RpcError will also be a Call for the RPC affording the RPC's</span>
|
|
|
<span class="sd"> metadata, status code, and details.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="UnaryUnaryMultiCallable.with_call"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.with_call">[docs]</a> <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="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.with_call"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.with_call">[docs]</a> <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request: The request value for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional durating of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -611,14 +611,14 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="UnaryUnaryMultiCallable.future"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.future">[docs]</a> <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="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.future"><a class="viewcode-back" href="../grpc.html#grpc.UnaryUnaryMultiCallable.future">[docs]</a> <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request: The request value for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -634,14 +634,14 @@
|
|
|
<div class="viewcode-block" id="UnaryStreamMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamMultiCallable</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Affords invoking a unary-stream RPC."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryStreamMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.UnaryStreamMultiCallable.__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">request</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request: The request value for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: An optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -650,21 +650,21 @@
|
|
|
<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
<span class="sd"> RpcError indicating termination of the RPC with non-OK status.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="StreamUnaryMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryMultiCallable</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Affords invoking a stream-unary RPC in any call style."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamUnaryMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.__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">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -677,17 +677,17 @@
|
|
|
<span class="sd"> raised RpcError will also be a Call for the RPC affording the RPC's</span>
|
|
|
<span class="sd"> metadata, status code, and details.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="StreamUnaryMultiCallable.with_call"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.with_call">[docs]</a> <span class="k">def</span> <span class="nf">with_call</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -701,15 +701,15 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="StreamUnaryMultiCallable.future"><a class="viewcode-back" href="../grpc.html#grpc.StreamUnaryMultiCallable.future">[docs]</a> <span class="k">def</span> <span class="nf">future</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -725,15 +725,15 @@
|
|
|
<div class="viewcode-block" id="StreamStreamMultiCallable"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamMultiCallable</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Affords invoking a stream-stream RPC in any call style."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
- <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamStreamMultiCallable.__call__"><a class="viewcode-back" href="../grpc.html#grpc.StreamStreamMultiCallable.__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">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Invokes the underlying RPC.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
<span class="sd"> timeout: An optional duration of time in seconds to allow for the RPC.</span>
|
|
|
-<span class="sd"> metadata: An optional sequence of pairs of bytes to be transmitted to the</span>
|
|
|
+<span class="sd"> metadata: Optional :term:`metadata` to be transmitted to the</span>
|
|
|
<span class="sd"> service-side of the RPC.</span>
|
|
|
<span class="sd"> credentials: An optional CallCredentials for the RPC.</span>
|
|
|
|
|
@@ -742,7 +742,7 @@
|
|
|
<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
<span class="sd"> RpcError indicating termination of the RPC with non-OK status.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
|
|
|
|
|
|
|
<span class="c1">############################# Channel Interface ##############################</span>
|
|
@@ -751,8 +751,8 @@
|
|
|
<div class="viewcode-block" id="Channel"><a class="viewcode-back" href="../grpc.html#grpc.Channel">[docs]</a><span class="k">class</span> <span class="nc">Channel</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Affords RPC invocation via generic methods."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
-<div class="viewcode-block" id="Channel.subscribe"><a class="viewcode-back" href="../grpc.html#grpc.Channel.subscribe">[docs]</a> <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="bp">False</span><span class="p">):</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Channel.subscribe"><a class="viewcode-back" href="../grpc.html#grpc.Channel.subscribe">[docs]</a> <span class="k">def</span> <span class="nf">subscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">try_to_connect</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
|
<span class="sd">"""Subscribes to this Channel's connectivity.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -767,7 +767,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Channel.unsubscribe"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unsubscribe">[docs]</a> <span class="k">def</span> <span class="nf">unsubscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
|
|
|
<span class="sd">"""Unsubscribes a callback from this Channel's connectivity.</span>
|
|
|
|
|
@@ -777,9 +777,9 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Channel.unary_unary"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unary_unary">[docs]</a> <span class="k">def</span> <span class="nf">unary_unary</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a UnaryUnaryMultiCallable for a unary-unary method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -790,9 +790,9 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Channel.unary_stream"><a class="viewcode-back" href="../grpc.html#grpc.Channel.unary_stream">[docs]</a> <span class="k">def</span> <span class="nf">unary_stream</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a UnaryStreamMultiCallable for a unary-stream method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -803,9 +803,9 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Channel.stream_unary"><a class="viewcode-back" href="../grpc.html#grpc.Channel.stream_unary">[docs]</a> <span class="k">def</span> <span class="nf">stream_unary</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a StreamUnaryMultiCallable for a stream-unary method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -816,9 +816,9 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Channel.stream_stream"><a class="viewcode-back" href="../grpc.html#grpc.Channel.stream_stream">[docs]</a> <span class="k">def</span> <span class="nf">stream_stream</span><span class="p">(</span>
|
|
|
- <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a StreamStreamMultiCallable for a stream-stream method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -836,16 +836,16 @@
|
|
|
<div class="viewcode-block" id="ServicerContext"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext">[docs]</a><span class="k">class</span> <span class="nc">ServicerContext</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="n">RpcContext</span><span class="p">)):</span>
|
|
|
<span class="sd">"""A context object passed to method implementations."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="ServicerContext.invocation_metadata"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.invocation_metadata">[docs]</a> <span class="k">def</span> <span class="nf">invocation_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accesses the metadata from the invocation-side of the RPC.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
-<span class="sd"> The invocation metadata object as a sequence of pairs of bytes.</span>
|
|
|
+<span class="sd"> The invocation :term:`metadata`.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="ServicerContext.peer"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.peer">[docs]</a> <span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Identifies the peer that invoked the RPC being serviced.</span>
|
|
|
|
|
@@ -854,7 +854,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<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="k">def</span> <span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
|
|
|
<span class="sd">"""Sends the initial metadata value to the invocation-side of the RPC.</span>
|
|
|
|
|
@@ -862,12 +862,11 @@
|
|
|
<span class="sd"> service-side initial metadata to transmit.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> initial_metadata: The initial metadata of the RPC as a sequence of pairs</span>
|
|
|
-<span class="sd"> of bytes.</span>
|
|
|
+<span class="sd"> initial_metadata: The initial :term:`metadata`.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<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="k">def</span> <span class="nf">set_trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accepts the trailing metadata value of the RPC.</span>
|
|
|
|
|
@@ -875,12 +874,11 @@
|
|
|
<span class="sd"> service-side trailing metadata to transmit.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> trailing_metadata: The trailing metadata of the RPC as a sequence of pairs</span>
|
|
|
-<span class="sd"> of bytes.</span>
|
|
|
+<span class="sd"> trailing_metadata: The trailing :term:`metadata`.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="ServicerContext.set_code"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_code">[docs]</a> <span class="k">def</span> <span class="nf">set_code</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accepts the status code of the RPC.</span>
|
|
|
|
|
@@ -893,7 +891,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="ServicerContext.set_details"><a class="viewcode-back" href="../grpc.html#grpc.ServicerContext.set_details">[docs]</a> <span class="k">def</span> <span class="nf">set_details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
|
|
|
<span class="sd">"""Accepts the service-side details of the RPC.</span>
|
|
|
|
|
@@ -901,7 +899,7 @@
|
|
|
<span class="sd"> details to transmit.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> details: The details bytes of the RPC to be transmitted to</span>
|
|
|
+<span class="sd"> details: The details string of the RPC to be transmitted to</span>
|
|
|
<span class="sd"> the invocation side of the RPC.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
|
@@ -949,14 +947,14 @@
|
|
|
<span class="sd">"""Describes an RPC that has just arrived for service.</span>
|
|
|
<span class="sd"> Attributes:</span>
|
|
|
<span class="sd"> method: The method name of the RPC.</span>
|
|
|
-<span class="sd"> invocation_metadata: The metadata from the invocation side of the RPC.</span>
|
|
|
+<span class="sd"> invocation_metadata: The :term:`metadata` from the invocation side of the RPC.</span>
|
|
|
<span class="sd"> """</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="GenericRpcHandler"><a class="viewcode-back" href="../grpc.html#grpc.GenericRpcHandler">[docs]</a><span class="k">class</span> <span class="nc">GenericRpcHandler</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""An implementation of arbitrarily many RPC methods."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="GenericRpcHandler.service"><a class="viewcode-back" href="../grpc.html#grpc.GenericRpcHandler.service">[docs]</a> <span class="k">def</span> <span class="nf">service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler_call_details</span><span class="p">):</span>
|
|
|
<span class="sd">"""Services an RPC (or not).</span>
|
|
|
|
|
@@ -976,7 +974,7 @@
|
|
|
<div class="viewcode-block" id="Server"><a class="viewcode-back" href="../grpc.html#grpc.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
|
|
|
<span class="sd">"""Services RPCs."""</span>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Server.add_generic_rpc_handlers"><a class="viewcode-back" href="../grpc.html#grpc.Server.add_generic_rpc_handlers">[docs]</a> <span class="k">def</span> <span class="nf">add_generic_rpc_handlers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">generic_rpc_handlers</span><span class="p">):</span>
|
|
|
<span class="sd">"""Registers GenericRpcHandlers with this Server.</span>
|
|
|
|
|
@@ -988,7 +986,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<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="k">def</span> <span class="nf">add_insecure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
|
|
|
<span class="sd">"""Reserves a port for insecure RPC service once this Server becomes active.</span>
|
|
|
|
|
@@ -1006,7 +1004,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<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="k">def</span> <span class="nf">add_secure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">server_credentials</span><span class="p">):</span>
|
|
|
<span class="sd">"""Reserves a port for secure RPC service after this Server becomes active.</span>
|
|
|
|
|
@@ -1025,7 +1023,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Server.start"><a class="viewcode-back" href="../grpc.html#grpc.Server.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="sd">"""Starts this Server's service of RPCs.</span>
|
|
|
|
|
@@ -1034,7 +1032,7 @@
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
|
|
|
|
- <span class="nd">@abc.abstractmethod</span>
|
|
|
+ <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
|
<div class="viewcode-block" id="Server.stop"><a class="viewcode-back" href="../grpc.html#grpc.Server.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grace</span><span class="p">):</span>
|
|
|
<span class="sd">"""Stops this Server's service of RPCs.</span>
|
|
|
|
|
@@ -1068,7 +1066,7 @@
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="unary_unary_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.unary_unary_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">unary_unary_rpc_method_handler</span><span class="p">(</span>
|
|
|
- <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an RpcMethodHandler for a unary-unary RPC method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1081,14 +1079,14 @@
|
|
|
<span class="sd"> An RpcMethodHandler for a unary-unary RPC method constructed from the given</span>
|
|
|
<span class="sd"> parameters.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span>
|
|
|
- <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span>
|
|
|
- <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span></div>
|
|
|
+ <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
+ <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="unary_stream_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.unary_stream_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">unary_stream_rpc_method_handler</span><span class="p">(</span>
|
|
|
- <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an RpcMethodHandler for a unary-stream RPC method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1101,14 +1099,14 @@
|
|
|
<span class="sd"> An RpcMethodHandler for a unary-stream RPC method constructed from the</span>
|
|
|
<span class="sd"> given parameters.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span>
|
|
|
- <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span>
|
|
|
- <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span></div>
|
|
|
+ <span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span>
|
|
|
+ <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="stream_unary_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.stream_unary_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">stream_unary_rpc_method_handler</span><span class="p">(</span>
|
|
|
- <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an RpcMethodHandler for a stream-unary RPC method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1121,14 +1119,14 @@
|
|
|
<span class="sd"> An RpcMethodHandler for a stream-unary RPC method constructed from the</span>
|
|
|
<span class="sd"> given parameters.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span>
|
|
|
- <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span>
|
|
|
- <span class="n">behavior</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span></div>
|
|
|
+ <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
+ <span class="n">behavior</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="stream_stream_rpc_method_handler"><a class="viewcode-back" href="../grpc.html#grpc.stream_stream_rpc_method_handler">[docs]</a><span class="k">def</span> <span class="nf">stream_stream_rpc_method_handler</span><span class="p">(</span>
|
|
|
- <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="n">behavior</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">response_serializer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an RpcMethodHandler for a stream-stream RPC method.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1142,9 +1140,9 @@
|
|
|
<span class="sd"> An RpcMethodHandler for a stream-stream RPC method constructed from the</span>
|
|
|
<span class="sd"> given parameters.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">RpcMethodHandler</span><span class="p">(</span>
|
|
|
- <span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="n">request_deserializer</span><span class="p">,</span> <span class="n">response_serializer</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
<span class="n">behavior</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
@@ -1159,12 +1157,12 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A GenericRpcHandler constructed from the given parameters.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">DictionaryGenericHandler</span><span class="p">(</span><span class="n">service</span><span class="p">,</span> <span class="n">method_handlers</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="ssl_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.ssl_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">ssl_channel_credentials</span><span class="p">(</span>
|
|
|
- <span class="n">root_certificates</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">private_key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">certificate_chain</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">certificate_chain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a ChannelCredentials for use with an SSL-enabled Channel.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1178,15 +1176,15 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A ChannelCredentials for use with an SSL-enabled Channel.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="k">if</span> <span class="n">private_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">certificate_chain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
|
|
|
+ <span class="k">if</span> <span class="n">private_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">certificate_chain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
<span class="n">pair</span> <span class="o">=</span> <span class="n">_cygrpc</span><span class="o">.</span><span class="n">SslPemKeyCertPair</span><span class="p">(</span><span class="n">private_key</span><span class="p">,</span> <span class="n">certificate_chain</span><span class="p">)</span>
|
|
|
<span class="k">else</span><span class="p">:</span>
|
|
|
- <span class="n">pair</span> <span class="o">=</span> <span class="bp">None</span>
|
|
|
+ <span class="n">pair</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
<span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
|
|
|
<span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_ssl</span><span class="p">(</span><span class="n">root_certificates</span><span class="p">,</span> <span class="n">pair</span><span class="p">))</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="metadata_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.metadata_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">metadata_call_credentials</span><span class="p">(</span><span class="n">metadata_plugin</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="metadata_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.metadata_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">metadata_call_credentials</span><span class="p">(</span><span class="n">metadata_plugin</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Construct CallCredentials from an AuthMetadataPlugin.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1197,8 +1195,8 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A CallCredentials.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_plugin_wrapping</span>
|
|
|
- <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_plugin_wrapping</span>
|
|
|
+ <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
<span class="k">try</span><span class="p">:</span>
|
|
|
<span class="n">effective_name</span> <span class="o">=</span> <span class="n">metadata_plugin</span><span class="o">.</span><span class="n">__name__</span>
|
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
@@ -1220,47 +1218,51 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A CallCredentials.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_auth</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_auth</span>
|
|
|
<span class="k">return</span> <span class="n">metadata_call_credentials</span><span class="p">(</span>
|
|
|
<span class="n">_auth</span><span class="o">.</span><span class="n">AccessTokenCallCredentials</span><span class="p">(</span><span class="n">access_token</span><span class="p">))</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="composite_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_call_credentials</span><span class="p">(</span><span class="n">call_credentials</span><span class="p">,</span> <span class="n">additional_call_credentials</span><span class="p">):</span>
|
|
|
- <span class="sd">"""Compose two CallCredentials to make a new one.</span>
|
|
|
+<div class="viewcode-block" id="composite_call_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_call_credentials</span><span class="p">(</span><span class="o">*</span><span class="n">call_credentials</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Compose multiple CallCredentials to make a new CallCredentials.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> call_credentials: A CallCredentials object.</span>
|
|
|
-<span class="sd"> additional_call_credentials: Another CallCredentials object to compose on</span>
|
|
|
-<span class="sd"> top of call_credentials.</span>
|
|
|
+<span class="sd"> *call_credentials: At least two CallCredentials objects.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
-<span class="sd"> A new CallCredentials composed of the two given CallCredentials.</span>
|
|
|
+<span class="sd"> A CallCredentials object composed of the given CallCredentials objects.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_credential_composition</span>
|
|
|
+ <span class="n">cygrpc_call_credentials</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
|
|
|
+ <span class="n">single_call_credentials</span><span class="o">.</span><span class="n">_credentials</span>
|
|
|
+ <span class="k">for</span> <span class="n">single_call_credentials</span> <span class="ow">in</span> <span class="n">call_credentials</span><span class="p">)</span>
|
|
|
<span class="k">return</span> <span class="n">CallCredentials</span><span class="p">(</span>
|
|
|
- <span class="n">_cygrpc</span><span class="o">.</span><span class="n">call_credentials_composite</span><span class="p">(</span>
|
|
|
- <span class="n">call_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">,</span>
|
|
|
- <span class="n">additional_call_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
|
|
|
+ <span class="n">_credential_composition</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cygrpc_call_credentials</span><span class="p">))</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="composite_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_channel_credentials</span><span class="p">(</span><span class="n">channel_credentials</span><span class="p">,</span> <span class="n">call_credentials</span><span class="p">):</span>
|
|
|
- <span class="sd">"""Compose a ChannelCredentials and a CallCredentials.</span>
|
|
|
+<div class="viewcode-block" id="composite_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.composite_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">composite_channel_credentials</span><span class="p">(</span><span class="n">channel_credentials</span><span class="p">,</span> <span class="o">*</span><span class="n">call_credentials</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Compose a ChannelCredentials and one or more CallCredentials objects.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
|
<span class="sd"> channel_credentials: A ChannelCredentials.</span>
|
|
|
-<span class="sd"> call_credentials: A CallCredentials.</span>
|
|
|
+<span class="sd"> *call_credentials: One or more CallCredentials objects.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A ChannelCredentials composed of the given ChannelCredentials and</span>
|
|
|
-<span class="sd"> CallCredentials.</span>
|
|
|
+<span class="sd"> CallCredentials objects.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_credential_composition</span>
|
|
|
+ <span class="n">cygrpc_call_credentials</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
|
|
|
+ <span class="n">single_call_credentials</span><span class="o">.</span><span class="n">_credentials</span>
|
|
|
+ <span class="k">for</span> <span class="n">single_call_credentials</span> <span class="ow">in</span> <span class="n">call_credentials</span><span class="p">)</span>
|
|
|
<span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
|
|
|
- <span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_composite</span><span class="p">(</span>
|
|
|
- <span class="n">channel_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">,</span> <span class="n">call_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
|
|
|
+ <span class="n">_credential_composition</span><span class="o">.</span><span class="n">channel</span><span class="p">(</span>
|
|
|
+ <span class="n">channel_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">,</span> <span class="n">cygrpc_call_credentials</span><span class="p">))</span></div>
|
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="ssl_server_credentials"><a class="viewcode-back" href="../grpc.html#grpc.ssl_server_credentials">[docs]</a><span class="k">def</span> <span class="nf">ssl_server_credentials</span><span class="p">(</span>
|
|
|
- <span class="n">private_key_certificate_chain_pairs</span><span class="p">,</span> <span class="n">root_certificates</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
- <span class="n">require_client_auth</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
|
|
|
+ <span class="n">private_key_certificate_chain_pairs</span><span class="p">,</span> <span class="n">root_certificates</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
|
+ <span class="n">require_client_auth</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a ServerCredentials for use with an SSL-enabled Server.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1280,7 +1282,7 @@
|
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">private_key_certificate_chain_pairs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
|
<span class="s1">'At least one private key-certificate chain pair is required!'</span><span class="p">)</span>
|
|
|
- <span class="k">elif</span> <span class="n">require_client_auth</span> <span class="ow">and</span> <span class="n">root_certificates</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
|
|
|
+ <span class="k">elif</span> <span class="n">require_client_auth</span> <span class="ow">and</span> <span class="n">root_certificates</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
|
<span class="s1">'Illegal to require client auth without providing root certificates!'</span><span class="p">)</span>
|
|
|
<span class="k">else</span><span class="p">:</span>
|
|
@@ -1306,11 +1308,11 @@
|
|
|
<span class="sd"> A Future that matures when the given Channel has connectivity</span>
|
|
|
<span class="sd"> ChannelConnectivity.READY.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_utilities</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_utilities</span>
|
|
|
<span class="k">return</span> <span class="n">_utilities</span><span class="o">.</span><span class="n">channel_ready_future</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../grpc.html#grpc.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../grpc.html#grpc.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an insecure Channel to a server.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1321,11 +1323,11 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A Channel to the target through which RPCs may be conducted.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_channel</span>
|
|
|
- <span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span></div>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>
|
|
|
+ <span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../grpc.html#grpc.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">credentials</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../grpc.html#grpc.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">credentials</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates an insecure Channel to a server.</span>
|
|
|
|
|
|
<span class="sd"> Args:</span>
|
|
@@ -1337,29 +1339,27 @@
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A Channel to the target through which RPCs may be conducted.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_channel</span>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_channel</span>
|
|
|
<span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">Channel</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
-<div class="viewcode-block" id="server"><a class="viewcode-back" href="../grpc.html#grpc.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">generic_rpc_handlers</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+<div class="viewcode-block" id="server"><a class="viewcode-back" href="../grpc.html#grpc.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">thread_pool</span><span class="p">,</span> <span class="n">handlers</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="sd">"""Creates a Server with which RPCs can be serviced.</span>
|
|
|
|
|
|
-<span class="sd"> The GenericRpcHandlers passed to this function needn't be the only</span>
|
|
|
-<span class="sd"> GenericRpcHandlers that will be used to serve RPCs; others may be added later</span>
|
|
|
-<span class="sd"> by calling add_generic_rpc_handlers any time before the returned server is</span>
|
|
|
-<span class="sd"> started.</span>
|
|
|
-
|
|
|
<span class="sd"> Args:</span>
|
|
|
-<span class="sd"> generic_rpc_handlers: Some number of GenericRpcHandlers that will be used</span>
|
|
|
-<span class="sd"> to service RPCs after the returned Server is started.</span>
|
|
|
<span class="sd"> thread_pool: A futures.ThreadPoolExecutor to be used by the returned Server</span>
|
|
|
<span class="sd"> to service RPCs.</span>
|
|
|
+<span class="sd"> handlers: An optional sequence of GenericRpcHandlers to be used to service</span>
|
|
|
+<span class="sd"> RPCs after the returned Server is started. These handlers need not be the</span>
|
|
|
+<span class="sd"> only handlers the server will use to service RPCs; other handlers may</span>
|
|
|
+<span class="sd"> later be added by calling add_generic_rpc_handlers any time before the</span>
|
|
|
+<span class="sd"> returned Server is started.</span>
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
<span class="sd"> A Server with which RPCs can be serviced.</span>
|
|
|
<span class="sd"> """</span>
|
|
|
- <span class="kn">from</span> <span class="nn">grpc</span> <span class="kn">import</span> <span class="n">_server</span>
|
|
|
- <span class="k">return</span> <span class="n">_server</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="n">generic_rpc_handlers</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">)</span></div>
|
|
|
+ <span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_server</span>
|
|
|
+ <span class="k">return</span> <span class="n">_server</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="n">thread_pool</span><span class="p">,</span> <span class="p">()</span> <span class="k">if</span> <span class="n">handlers</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">handlers</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
|
<span class="c1">################################### __all__ #################################</span>
|
|
@@ -1439,7 +1439,7 @@
|
|
|
<script type="text/javascript">
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
URL_ROOT:'../',
|
|
|
- VERSION:'0.15.0',
|
|
|
+ VERSION:'1.0.0rc1',
|
|
|
COLLAPSE_INDEX:false,
|
|
|
FILE_SUFFIX:'.html',
|
|
|
HAS_SOURCE: true
|