272 lines
24 KiB
HTML
272 lines
24 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>grpc_reflection.v1alpha.reflection — gRPC Python 1.22.0 documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../../_static/language_data.js"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
|
|
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
</head><body>
|
|
<div class="document">
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
|
|
|
|
|
|
|
<p class="blurb">1.22.0</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_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>
|
|
|
|
<div class="relations">
|
|
<h3>Related Topics</h3>
|
|
<ul>
|
|
<li><a href="../../../index.html">Documentation overview</a><ul>
|
|
<li><a href="../../index.html">Module code</a><ul>
|
|
</ul></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3>Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for grpc_reflection.v1alpha.reflection</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># Copyright 2016 gRPC authors.</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
|
<span class="c1"># you may not use this file except in compliance with the License.</span>
|
|
<span class="c1"># You may obtain a copy of the License at</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
|
|
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
|
|
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
|
<span class="c1"># See the License for the specific language governing permissions and</span>
|
|
<span class="c1"># limitations under the License.</span>
|
|
<span class="sd">"""Reference implementation for reflection in gRPC Python."""</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">grpc</span>
|
|
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="k">import</span> <span class="n">descriptor_pb2</span>
|
|
<span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="k">import</span> <span class="n">descriptor_pool</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">grpc_reflection.v1alpha</span> <span class="k">import</span> <span class="n">reflection_pb2</span> <span class="k">as</span> <span class="n">_reflection_pb2</span>
|
|
<span class="kn">from</span> <span class="nn">grpc_reflection.v1alpha</span> <span class="k">import</span> <span class="n">reflection_pb2_grpc</span> <span class="k">as</span> <span class="n">_reflection_pb2_grpc</span>
|
|
|
|
<span class="n">_POOL</span> <span class="o">=</span> <span class="n">descriptor_pool</span><span class="o">.</span><span class="n">Default</span><span class="p">()</span>
|
|
<span class="n">SERVICE_NAME</span> <span class="o">=</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">DESCRIPTOR</span><span class="o">.</span><span class="n">services_by_name</span><span class="p">[</span>
|
|
<span class="s1">'ServerReflection'</span><span class="p">]</span><span class="o">.</span><span class="n">full_name</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">_not_found_error</span><span class="p">():</span>
|
|
<span class="k">return</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServerReflectionResponse</span><span class="p">(</span>
|
|
<span class="n">error_response</span><span class="o">=</span><span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ErrorResponse</span><span class="p">(</span>
|
|
<span class="n">error_code</span><span class="o">=</span><span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">NOT_FOUND</span><span class="o">.</span><span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
|
|
<span class="n">error_message</span><span class="o">=</span><span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">NOT_FOUND</span><span class="o">.</span><span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">encode</span><span class="p">(),</span>
|
|
<span class="p">))</span>
|
|
|
|
|
|
<span class="k">def</span> <span class="nf">_file_descriptor_response</span><span class="p">(</span><span class="n">descriptor</span><span class="p">):</span>
|
|
<span class="n">proto</span> <span class="o">=</span> <span class="n">descriptor_pb2</span><span class="o">.</span><span class="n">FileDescriptorProto</span><span class="p">()</span>
|
|
<span class="n">descriptor</span><span class="o">.</span><span class="n">CopyToProto</span><span class="p">(</span><span class="n">proto</span><span class="p">)</span>
|
|
<span class="n">serialized_proto</span> <span class="o">=</span> <span class="n">proto</span><span class="o">.</span><span class="n">SerializeToString</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServerReflectionResponse</span><span class="p">(</span>
|
|
<span class="n">file_descriptor_response</span><span class="o">=</span><span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">FileDescriptorResponse</span><span class="p">(</span>
|
|
<span class="n">file_descriptor_proto</span><span class="o">=</span><span class="p">(</span><span class="n">serialized_proto</span><span class="p">,)),)</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ReflectionServicer"><a class="viewcode-back" href="../../../grpc_reflection.html#grpc_reflection.v1alpha.reflection.ReflectionServicer">[docs]</a><span class="k">class</span> <span class="nc">ReflectionServicer</span><span class="p">(</span><span class="n">_reflection_pb2_grpc</span><span class="o">.</span><span class="n">ServerReflectionServicer</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="n">service_names</span><span class="p">,</span> <span class="n">pool</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""Constructor.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> service_names: Iterable of fully-qualified service names available.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_service_names</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">service_names</span><span class="p">))</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_pool</span> <span class="o">=</span> <span class="n">_POOL</span> <span class="k">if</span> <span class="n">pool</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">pool</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_file_by_filename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindFileByName</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_not_found_error</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_file_descriptor_response</span><span class="p">(</span><span class="n">descriptor</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_file_containing_symbol</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fully_qualified_name</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindFileContainingSymbol</span><span class="p">(</span>
|
|
<span class="n">fully_qualified_name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_not_found_error</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_file_descriptor_response</span><span class="p">(</span><span class="n">descriptor</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_file_containing_extension</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">containing_type</span><span class="p">,</span> <span class="n">extension_number</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">message_descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindMessageTypeByName</span><span class="p">(</span>
|
|
<span class="n">containing_type</span><span class="p">)</span>
|
|
<span class="n">extension_descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindExtensionByNumber</span><span class="p">(</span>
|
|
<span class="n">message_descriptor</span><span class="p">,</span> <span class="n">extension_number</span><span class="p">)</span>
|
|
<span class="n">descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindFileContainingSymbol</span><span class="p">(</span>
|
|
<span class="n">extension_descriptor</span><span class="o">.</span><span class="n">full_name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_not_found_error</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_file_descriptor_response</span><span class="p">(</span><span class="n">descriptor</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_all_extension_numbers_of_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">containing_type</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">message_descriptor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindMessageTypeByName</span><span class="p">(</span>
|
|
<span class="n">containing_type</span><span class="p">)</span>
|
|
<span class="n">extension_numbers</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
|
|
<span class="nb">sorted</span><span class="p">(</span>
|
|
<span class="n">extension</span><span class="o">.</span><span class="n">number</span>
|
|
<span class="k">for</span> <span class="n">extension</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">FindAllExtensions</span><span class="p">(</span>
|
|
<span class="n">message_descriptor</span><span class="p">)))</span>
|
|
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_not_found_error</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServerReflectionResponse</span><span class="p">(</span>
|
|
<span class="n">all_extension_numbers_response</span><span class="o">=</span><span class="n">_reflection_pb2</span><span class="o">.</span>
|
|
<span class="n">ExtensionNumberResponse</span><span class="p">(</span>
|
|
<span class="n">base_type_name</span><span class="o">=</span><span class="n">message_descriptor</span><span class="o">.</span><span class="n">full_name</span><span class="p">,</span>
|
|
<span class="n">extension_number</span><span class="o">=</span><span class="n">extension_numbers</span><span class="p">))</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_list_services</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServerReflectionResponse</span><span class="p">(</span>
|
|
<span class="n">list_services_response</span><span class="o">=</span><span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ListServiceResponse</span><span class="p">(</span>
|
|
<span class="n">service</span><span class="o">=</span><span class="p">[</span>
|
|
<span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServiceResponse</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">service_name</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">service_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_service_names</span>
|
|
<span class="p">]))</span>
|
|
|
|
<span class="k">def</span> <span class="nf">ServerReflectionInfo</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">context</span><span class="p">):</span>
|
|
<span class="c1"># pylint: disable=unused-argument</span>
|
|
<span class="k">for</span> <span class="n">request</span> <span class="ow">in</span> <span class="n">request_iterator</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s1">'file_by_filename'</span><span class="p">):</span>
|
|
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_file_by_filename</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">file_by_filename</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">request</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s1">'file_containing_symbol'</span><span class="p">):</span>
|
|
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_file_containing_symbol</span><span class="p">(</span>
|
|
<span class="n">request</span><span class="o">.</span><span class="n">file_containing_symbol</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">request</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s1">'file_containing_extension'</span><span class="p">):</span>
|
|
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_file_containing_extension</span><span class="p">(</span>
|
|
<span class="n">request</span><span class="o">.</span><span class="n">file_containing_extension</span><span class="o">.</span><span class="n">containing_type</span><span class="p">,</span>
|
|
<span class="n">request</span><span class="o">.</span><span class="n">file_containing_extension</span><span class="o">.</span><span class="n">extension_number</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">request</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s1">'all_extension_numbers_of_type'</span><span class="p">):</span>
|
|
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_all_extension_numbers_of_type</span><span class="p">(</span>
|
|
<span class="n">request</span><span class="o">.</span><span class="n">all_extension_numbers_of_type</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">request</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s1">'list_services'</span><span class="p">):</span>
|
|
<span class="k">yield</span> <span class="bp">self</span><span class="o">.</span><span class="n">_list_services</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">yield</span> <span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ServerReflectionResponse</span><span class="p">(</span>
|
|
<span class="n">error_response</span><span class="o">=</span><span class="n">_reflection_pb2</span><span class="o">.</span><span class="n">ErrorResponse</span><span class="p">(</span>
|
|
<span class="n">error_code</span><span class="o">=</span><span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">INVALID_ARGUMENT</span><span class="o">.</span><span class="n">value</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
|
|
<span class="n">error_message</span><span class="o">=</span><span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="o">.</span><span class="n">INVALID_ARGUMENT</span><span class="o">.</span><span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
|
<span class="o">.</span><span class="n">encode</span><span class="p">(),</span>
|
|
<span class="p">))</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="enable_server_reflection"><a class="viewcode-back" href="../../../grpc_reflection.html#grpc_reflection.v1alpha.reflection.enable_server_reflection">[docs]</a><span class="k">def</span> <span class="nf">enable_server_reflection</span><span class="p">(</span><span class="n">service_names</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">pool</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="sd">"""Enables server reflection on a server.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> service_names: Iterable of fully-qualified service names available.</span>
|
|
<span class="sd"> server: grpc.Server to which reflection service will be added.</span>
|
|
<span class="sd"> pool: DescriptorPool object to use (descriptor_pool.Default() if None).</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">_reflection_pb2_grpc</span><span class="o">.</span><span class="n">add_ServerReflectionServicer_to_server</span><span class="p">(</span>
|
|
<span class="n">ReflectionServicer</span><span class="p">(</span><span class="n">service_names</span><span class="p">,</span> <span class="n">pool</span><span class="o">=</span><span class="n">pool</span><span class="p">),</span> <span class="n">server</span><span class="p">)</span></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2018, The gRPC Authors.
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-60127042-1']);
|
|
_gaq.push(['_setDomainName', 'none']);
|
|
_gaq.push(['_setAllowLinker', true]);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
|
|
</script>
|
|
|
|
</body>
|
|
</html> |