|
@@ -6,7 +6,7 @@
|
|
|
<head>
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
- <title>grpc_health.v1.health — gRPC Python 1.19.0 documentation</title>
|
|
|
+ <title>grpc_health.v1.health — gRPC Python 1.20.0 documentation</title>
|
|
|
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
@@ -31,7 +31,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
-<p class="blurb">1.19.0</p>
|
|
|
+<p class="blurb">1.20.0</p>
|
|
|
|
|
|
|
|
|
|
|
@@ -45,6 +45,7 @@
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
|
|
</ul>
|
|
@@ -102,6 +103,7 @@
|
|
|
<span class="c1"># limitations under the License.</span>
|
|
|
<span class="sd">"""Reference implementation for health checking in gRPC Python."""</span>
|
|
|
|
|
|
+<span class="kn">import</span> <span class="nn">collections</span>
|
|
|
<span class="kn">import</span> <span class="nn">threading</span>
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">grpc</span>
|
|
@@ -116,7 +118,7 @@
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_condition</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Condition</span><span class="p">()</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">deque</span><span class="p">()</span>
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_open</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
@@ -127,7 +129,7 @@
|
|
|
<span class="k">while</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_open</span><span class="p">:</span>
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_condition</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span><span class="p">:</span>
|
|
|
- <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
|
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_responses</span><span class="o">.</span><span class="n">popleft</span><span class="p">()</span>
|
|
|
<span class="k">else</span><span class="p">:</span>
|
|
|
<span class="k">raise</span> <span class="ne">StopIteration</span><span class="p">()</span>
|
|
|
|
|
@@ -148,20 +150,37 @@
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_condition</span><span class="o">.</span><span class="n">notify</span><span class="p">()</span>
|
|
|
|
|
|
|
|
|
+<span class="k">def</span> <span class="nf">_watcher_to_send_response_callback_adapter</span><span class="p">(</span><span class="n">watcher</span><span class="p">):</span>
|
|
|
+
|
|
|
+ <span class="k">def</span> <span class="nf">send_response_callback</span><span class="p">(</span><span class="n">response</span><span class="p">):</span>
|
|
|
+ <span class="k">if</span> <span class="n">response</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
+ <span class="n">watcher</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
+ <span class="k">else</span><span class="p">:</span>
|
|
|
+ <span class="n">watcher</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
|
|
|
+
|
|
|
+ <span class="k">return</span> <span class="n">send_response_callback</span>
|
|
|
+
|
|
|
+
|
|
|
<div class="viewcode-block" id="HealthServicer"><a class="viewcode-back" href="../../../grpc_health_checking.html#grpc_health.v1.health.HealthServicer">[docs]</a><span class="k">class</span> <span class="nc">HealthServicer</span><span class="p">(</span><span class="n">_health_pb2_grpc</span><span class="o">.</span><span class="n">HealthServicer</span><span class="p">):</span>
|
|
|
<span class="sd">"""Servicer handling RPCs for service statuses."""</span>
|
|
|
|
|
|
- <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
|
+ <span class="n">experimental_non_blocking</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
|
+ <span class="n">experimental_thread_pool</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">RLock</span><span class="p">()</span>
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_server_status</span> <span class="o">=</span> <span class="p">{}</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span> <span class="o">=</span> <span class="p">{}</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span> <span class="o">=</span> <span class="p">{}</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">Watch</span><span class="o">.</span><span class="vm">__func__</span><span class="o">.</span><span class="n">experimental_non_blocking</span> <span class="o">=</span> <span class="n">experimental_non_blocking</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">Watch</span><span class="o">.</span><span class="vm">__func__</span><span class="o">.</span><span class="n">experimental_thread_pool</span> <span class="o">=</span> <span class="n">experimental_thread_pool</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_gracefully_shutting_down</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
|
|
- <span class="k">def</span> <span class="nf">_on_close_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">watcher</span><span class="p">,</span> <span class="n">service</span><span class="p">):</span>
|
|
|
+ <span class="k">def</span> <span class="nf">_on_close_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">send_response_callback</span><span class="p">,</span> <span class="n">service</span><span class="p">):</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">callback</span><span class="p">():</span>
|
|
|
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">[</span><span class="n">service</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">watcher</span><span class="p">)</span>
|
|
|
- <span class="n">watcher</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">[</span><span class="n">service</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span>
|
|
|
+ <span class="n">send_response_callback</span><span class="p">)</span>
|
|
|
+ <span class="n">send_response_callback</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">return</span> <span class="n">callback</span>
|
|
|
|
|
@@ -174,19 +193,29 @@
|
|
|
<span class="k">else</span><span class="p">:</span>
|
|
|
<span class="k">return</span> <span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">)</span>
|
|
|
|
|
|
- <span class="k">def</span> <span class="nf">Watch</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">context</span><span class="p">):</span>
|
|
|
+ <span class="c1"># pylint: disable=arguments-differ</span>
|
|
|
+ <span class="k">def</span> <span class="nf">Watch</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">context</span><span class="p">,</span> <span class="n">send_response_callback</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
|
+ <span class="n">blocking_watcher</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
+ <span class="k">if</span> <span class="n">send_response_callback</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
+ <span class="c1"># The server does not support the experimental_non_blocking</span>
|
|
|
+ <span class="c1"># parameter. For backwards compatibility, return a blocking response</span>
|
|
|
+ <span class="c1"># generator.</span>
|
|
|
+ <span class="n">blocking_watcher</span> <span class="o">=</span> <span class="n">_Watcher</span><span class="p">()</span>
|
|
|
+ <span class="n">send_response_callback</span> <span class="o">=</span> <span class="n">_watcher_to_send_response_callback_adapter</span><span class="p">(</span>
|
|
|
+ <span class="n">blocking_watcher</span><span class="p">)</span>
|
|
|
<span class="n">service</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">service</span>
|
|
|
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
|
|
|
<span class="n">status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server_status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">service</span><span class="p">)</span>
|
|
|
<span class="k">if</span> <span class="n">status</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
|
<span class="n">status</span> <span class="o">=</span> <span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="o">.</span><span class="n">SERVICE_UNKNOWN</span> <span class="c1"># pylint: disable=no-member</span>
|
|
|
- <span class="n">watcher</span> <span class="o">=</span> <span class="n">_Watcher</span><span class="p">()</span>
|
|
|
- <span class="n">watcher</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">))</span>
|
|
|
- <span class="k">if</span> <span class="n">service</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">:</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">[</span><span class="n">service</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">[</span><span class="n">service</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">watcher</span><span class="p">)</span>
|
|
|
- <span class="n">context</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_on_close_callback</span><span class="p">(</span><span class="n">watcher</span><span class="p">,</span> <span class="n">service</span><span class="p">))</span>
|
|
|
- <span class="k">return</span> <span class="n">watcher</span>
|
|
|
+ <span class="n">send_response_callback</span><span class="p">(</span>
|
|
|
+ <span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">))</span>
|
|
|
+ <span class="k">if</span> <span class="n">service</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">:</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">[</span><span class="n">service</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">[</span><span class="n">service</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">send_response_callback</span><span class="p">)</span>
|
|
|
+ <span class="n">context</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_on_close_callback</span><span class="p">(</span><span class="n">send_response_callback</span><span class="p">,</span> <span class="n">service</span><span class="p">))</span>
|
|
|
+ <span class="k">return</span> <span class="n">blocking_watcher</span>
|
|
|
|
|
|
<div class="viewcode-block" id="HealthServicer.set"><a class="viewcode-back" href="../../../grpc_health_checking.html#grpc_health.v1.health.HealthServicer.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">status</span><span class="p">):</span>
|
|
|
<span class="sd">"""Sets the status of a service.</span>
|
|
@@ -197,10 +226,33 @@
|
|
|
<span class="sd"> the service</span>
|
|
|
<span class="sd"> """</span>
|
|
|
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
|
|
|
- <span class="bp">self</span><span class="o">.</span><span class="n">_server_status</span><span class="p">[</span><span class="n">service</span><span class="p">]</span> <span class="o">=</span> <span class="n">status</span>
|
|
|
- <span class="k">if</span> <span class="n">service</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">:</span>
|
|
|
- <span class="k">for</span> <span class="n">watcher</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_watchers</span><span class="p">[</span><span class="n">service</span><span class="p">]:</span>
|
|
|
- <span class="n">watcher</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">))</span></div></div>
|
|
|
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gracefully_shutting_down</span><span class="p">:</span>
|
|
|
+ <span class="k">return</span>
|
|
|
+ <span class="k">else</span><span class="p">:</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_server_status</span><span class="p">[</span><span class="n">service</span><span class="p">]</span> <span class="o">=</span> <span class="n">status</span>
|
|
|
+ <span class="k">if</span> <span class="n">service</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">:</span>
|
|
|
+ <span class="k">for</span> <span class="n">send_response_callback</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_send_response_callbacks</span><span class="p">[</span>
|
|
|
+ <span class="n">service</span><span class="p">]:</span>
|
|
|
+ <span class="n">send_response_callback</span><span class="p">(</span>
|
|
|
+ <span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">))</span></div>
|
|
|
+
|
|
|
+<div class="viewcode-block" id="HealthServicer.enter_graceful_shutdown"><a class="viewcode-back" href="../../../grpc_health_checking.html#grpc_health.v1.health.HealthServicer.enter_graceful_shutdown">[docs]</a> <span class="k">def</span> <span class="nf">enter_graceful_shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Permanently sets the status of all services to NOT_SERVING.</span>
|
|
|
+
|
|
|
+<span class="sd"> This should be invoked when the server is entering a graceful shutdown</span>
|
|
|
+<span class="sd"> period. After this method is invoked, future attempts to set the status</span>
|
|
|
+<span class="sd"> of a service will be ignored.</span>
|
|
|
+
|
|
|
+<span class="sd"> This is an EXPERIMENTAL API.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
|
|
|
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gracefully_shutting_down</span><span class="p">:</span>
|
|
|
+ <span class="k">return</span>
|
|
|
+ <span class="k">else</span><span class="p">:</span>
|
|
|
+ <span class="k">for</span> <span class="n">service</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server_status</span><span class="p">:</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">service</span><span class="p">,</span>
|
|
|
+ <span class="n">_health_pb2</span><span class="o">.</span><span class="n">HealthCheckResponse</span><span class="o">.</span><span class="n">NOT_SERVING</span><span class="p">)</span> <span class="c1"># pylint: disable=no-member</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">_gracefully_shutting_down</span> <span class="o">=</span> <span class="kc">True</span></div></div>
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|