231 lines
17 KiB
HTML
231 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>grpc_reflection.v1alpha.reflection — gRPC Python 1.64.0 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=4f649999" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=8090fdca" />
|
|
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=057799ce"></script>
|
|
<script src="../../../_static/doctools.js?v=888ff710"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></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.64.0</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
<p class="caption" role="heading"><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_asyncio.html">gRPC AsyncIO API</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_admin.html">gRPC Admin</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_csds.html">gRPC CSDS</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="../../../grpc_observability.html">gRPC Python Observability</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 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>document.getElementById('searchbox').style.display = "block"</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">sys</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">grpc</span>
|
|
<span class="kn">from</span> <span class="nn">grpc_reflection.v1alpha</span> <span class="kn">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="kn">import</span> <span class="n">reflection_pb2_grpc</span> <span class="k">as</span> <span class="n">_reflection_pb2_grpc</span>
|
|
<span class="kn">from</span> <span class="nn">grpc_reflection.v1alpha._base</span> <span class="kn">import</span> <span class="n">BaseReflectionServicer</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="s2">"ServerReflection"</span>
|
|
<span class="p">]</span><span class="o">.</span><span class="n">full_name</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">BaseReflectionServicer</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Servicer handling RPCs for service statuses."""</span>
|
|
|
|
<div class="viewcode-block" id="ReflectionServicer.ServerReflectionInfo"><a class="viewcode-back" href="../../../grpc_reflection.html#grpc_reflection.v1alpha.reflection.ReflectionServicer.ServerReflectionInfo">[docs]</a> <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="s2">"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="s2">"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="s2">"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="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="s2">"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="s2">"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>
|
|
<span class="p">)</span></div></div>
|
|
|
|
|
|
<span class="n">_enable_server_reflection_doc</span> <span class="o">=</span> <span class="s2">"""Enables server reflection on a server.</span>
|
|
|
|
<span class="s2">Args:</span>
|
|
<span class="s2"> service_names: Iterable of fully-qualified service names available.</span>
|
|
<span class="s2"> server: grpc.Server to which reflection service will be added.</span>
|
|
<span class="s2"> pool: DescriptorPool object to use (descriptor_pool.Default() if None).</span>
|
|
<span class="s2">"""</span>
|
|
|
|
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">>=</span> <span class="mi">3</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">>=</span> <span class="mi">6</span><span class="p">:</span>
|
|
<span class="c1"># Exposes AsyncReflectionServicer as public API.</span>
|
|
<span class="c1"># pylint: disable=ungrouped-imports</span>
|
|
<span class="kn">from</span> <span class="nn">grpc.experimental</span> <span class="kn">import</span> <span class="n">aio</span> <span class="k">as</span> <span class="n">grpc_aio</span>
|
|
|
|
<span class="c1"># pylint: enable=ungrouped-imports</span>
|
|
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">_async</span> <span class="k">as</span> <span class="n">aio</span>
|
|
|
|
<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="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">grpc_aio</span><span class="o">.</span><span class="n">Server</span><span class="p">):</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">aio</span><span class="o">.</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>
|
|
<span class="k">else</span><span class="p">:</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>
|
|
|
|
<span class="n">enable_server_reflection</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_enable_server_reflection_doc</span>
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s2">"SERVICE_NAME"</span><span class="p">,</span>
|
|
<span class="s2">"ReflectionServicer"</span><span class="p">,</span>
|
|
<span class="s2">"enable_server_reflection"</span><span class="p">,</span>
|
|
<span class="s2">"aio"</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
|
|
<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="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>
|
|
|
|
<span class="n">enable_server_reflection</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="n">_enable_server_reflection_doc</span>
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s2">"SERVICE_NAME"</span><span class="p">,</span>
|
|
<span class="s2">"ReflectionServicer"</span><span class="p">,</span>
|
|
<span class="s2">"enable_server_reflection"</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2020, 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> |