carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938
							
<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>gRPC Testing &#8212; gRPC Python 1.36.1 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Glossary" href="glossary.html" />
    <link rel="prev" title="gRPC Status" href="grpc_status.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.36.1</p>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<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_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 current"><a class="current reference internal" href="#">gRPC Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-grpc_testing">Module Contents</a></li>
</ul>
</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>Previous: <a href="grpc_status.html" title="previous chapter">gRPC Status</a></li>
      <li>Next: <a href="glossary.html" title="next chapter">Glossary</a></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" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>


        </div>
      </div>
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="grpc-testing">
<h1>gRPC Testing<a class="headerlink" href="#grpc-testing" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-grpc_testing">
<span id="module-contents"></span><h2>Module Contents<a class="headerlink" href="#module-grpc_testing" title="Permalink to this headline">¶</a></h2>
<p>Objects for use in testing gRPC Python-using application code.</p>
<dl class="py class">
<dt id="grpc_testing.Channel">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">Channel</span></code><a class="reference internal" href="_modules/grpc_testing.html#Channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Channel" title="Permalink to this definition">¶</a></dt>
<dd><p>A grpc.Channel double with which to test a system that invokes RPCs.</p>
<dl class="py method">
<dt id="grpc_testing.Channel.take_stream_stream">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_stream_stream</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Channel.take_stream_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Channel.take_stream_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws an RPC currently being made by the system under test.</p>
<p>If the given descriptor does not identify any RPC currently being made
by the system under test, this method blocks until the system under
test invokes such an RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a
stream-stream RPC method.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A (invocation_metadata, stream_stream_channel_rpc) tuple of the RPC’s</dt><dd><p>invocation metadata and a StreamStreamChannelRpc with which to
“play server” for the RPC.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Channel.take_stream_unary">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_stream_unary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Channel.take_stream_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Channel.take_stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws an RPC currently being made by the system under test.</p>
<p>If the given descriptor does not identify any RPC currently being made
by the system under test, this method blocks until the system under
test invokes such an RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a
stream-unary RPC method.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A (invocation_metadata, stream_unary_channel_rpc) tuple of the RPC’s</dt><dd><p>invocation metadata and a StreamUnaryChannelRpc with which to “play
server” for the RPC.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Channel.take_unary_stream">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_unary_stream</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Channel.take_unary_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Channel.take_unary_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws an RPC currently being made by the system under test.</p>
<p>If the given descriptor does not identify any RPC currently being made
by the system under test, this method blocks until the system under
test invokes such an RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a
unary-stream RPC method.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A (invocation_metadata, request, unary_stream_channel_rpc) tuple of</dt><dd><p>the RPC’s invocation metadata, its request, and a
UnaryStreamChannelRpc with which to “play server” for the RPC.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Channel.take_unary_unary">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_unary_unary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Channel.take_unary_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Channel.take_unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws an RPC currently being made by the system under test.</p>
<p>If the given descriptor does not identify any RPC currently being made
by the system under test, this method blocks until the system under
test invokes such an RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a
unary-unary RPC method.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A (invocation_metadata, request, unary_unary_channel_rpc) tuple of</dt><dd><p>the RPC’s invocation metadata, its request, and a
UnaryUnaryChannelRpc with which to “play server” for the RPC.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.Server">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">Server</span></code><a class="reference internal" href="_modules/grpc_testing.html#Server"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Server" title="Permalink to this definition">¶</a></dt>
<dd><p>A server with which to test a system that services RPCs.</p>
<dl class="py method">
<dt id="grpc_testing.Server.invoke_stream_stream">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">invoke_stream_stream</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invocation_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Server.invoke_stream_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Server.invoke_stream_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes an RPC to be serviced by the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a stream-stream
RPC method.</p></li>
<li><p><strong>invocation_metadata</strong> – The RPC’s invocation metadata.</p></li>
<li><p><strong>timeout</strong> – A duration of time in seconds for the RPC or None to
indicate that the RPC has no time limit.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A StreamStreamServerRpc with which to “play client” for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Server.invoke_stream_unary">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">invoke_stream_unary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invocation_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Server.invoke_stream_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Server.invoke_stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes an RPC to be serviced by the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a stream-unary
RPC method.</p></li>
<li><p><strong>invocation_metadata</strong> – The RPC’s invocation metadata.</p></li>
<li><p><strong>timeout</strong> – A duration of time in seconds for the RPC or None to
indicate that the RPC has no time limit.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A StreamUnaryServerRpc with which to “play client” for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Server.invoke_unary_stream">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">invoke_unary_stream</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invocation_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Server.invoke_unary_stream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Server.invoke_unary_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes an RPC to be serviced by the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a unary-stream
RPC method.</p></li>
<li><p><strong>invocation_metadata</strong> – The RPC’s invocation metadata.</p></li>
<li><p><strong>request</strong> – The RPC’s request.</p></li>
<li><p><strong>timeout</strong> – A duration of time in seconds for the RPC or None to
indicate that the RPC has no time limit.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A UnaryStreamServerRpc with which to “play client” for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Server.invoke_unary_unary">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">invoke_unary_unary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_descriptor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invocation_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Server.invoke_unary_unary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Server.invoke_unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes an RPC to be serviced by the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>method_descriptor</strong> – A descriptor.MethodDescriptor describing a unary-unary
RPC method.</p></li>
<li><p><strong>invocation_metadata</strong> – The RPC’s invocation metadata.</p></li>
<li><p><strong>request</strong> – The RPC’s request.</p></li>
<li><p><strong>timeout</strong> – A duration of time in seconds for the RPC or None to
indicate that the RPC has no time limit.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A UnaryUnaryServerRpc with which to “play client” for the RPC.</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.StreamStreamChannelRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">StreamStreamChannelRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a stream-stream RPC invoked by a system under test.</p>
<p>Enables users to “play server” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.cancelled">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancelled</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.cancelled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.cancelled" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has cancelled the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.requests_closed">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">requests_closed</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.requests_closed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.requests_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has closed the request stream.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.send_initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_initial_metadata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.send_initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the RPC’s initial metadata to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>initial_metadata</strong> – The RPC’s initial metadata to be “sent” to the
system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.send_response">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_response</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.send_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.send_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends a response to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>response</strong> – A response messages to be “sent” to the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.take_request">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_request</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.take_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.take_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws one of the requests added to the RPC by the system under test.</p>
<p>This method blocks until the system under test has added to the RPC
the request to be returned.</p>
<p>Successive calls to this method return requests in the same order in
which the system under test added them to the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A request message added to the RPC by the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamChannelRpc.terminate">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">terminate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trailing_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamChannelRpc.terminate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamChannelRpc.terminate" title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>trailing_metadata</strong> – The RPC’s trailing metadata.</p></li>
<li><p><strong>code</strong> – The RPC’s status code.</p></li>
<li><p><strong>details</strong> – The RPC’s status details.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.StreamStreamServerRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">StreamStreamServerRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a stream-stream RPC serviced by a system under test.</p>
<p>Enables users to “play client” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.cancel">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">initial_metadata</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the initial metadata emitted by the system under test.</p>
<p>This method blocks until the system under test has added initial
metadata to the RPC (or has provided one or more response messages or
has terminated the RPC, either of which will cause gRPC Python to
synthesize initial metadata for the RPC).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The initial metadata for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.requests_closed">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">requests_closed</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.requests_closed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.requests_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the end of the RPC’s request stream.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.send_request">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_request</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.send_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.send_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends a request to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>request</strong> – A request message for the RPC to be “sent” to the system
under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.take_response">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_response</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.take_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.take_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws one of the responses added to the RPC by the system under test.</p>
<p>Successive calls to this method return responses in the same order in
which the system under test added them to the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A response message added to the RPC by the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamStreamServerRpc.termination">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">termination</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamStreamServerRpc.termination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamStreamServerRpc.termination" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has terminated the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><dl class="simple">
<dt>A (trailing_metadata, code, details) sequence with the RPC’s trailing</dt><dd><p>metadata, code, and details.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.StreamUnaryChannelRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">StreamUnaryChannelRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a stream-unary RPC invoked by a system under test.</p>
<p>Enables users to “play server” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.StreamUnaryChannelRpc.cancelled">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancelled</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc.cancelled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc.cancelled" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has cancelled the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryChannelRpc.requests_closed">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">requests_closed</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc.requests_closed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc.requests_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has closed the request stream.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryChannelRpc.send_initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_initial_metadata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc.send_initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the RPC’s initial metadata to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>initial_metadata</strong> – The RPC’s initial metadata to be “sent” to
the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryChannelRpc.take_request">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_request</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc.take_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc.take_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws one of the requests added to the RPC by the system under test.</p>
<p>This method blocks until the system under test has added to the RPC
the request to be returned.</p>
<p>Successive calls to this method return requests in the same order in
which the system under test added them to the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A request message added to the RPC by the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryChannelRpc.terminate">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">terminate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trailing_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryChannelRpc.terminate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryChannelRpc.terminate" title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>response</strong> – The response for the RPC.</p></li>
<li><p><strong>trailing_metadata</strong> – The RPC’s trailing metadata.</p></li>
<li><p><strong>code</strong> – The RPC’s status code.</p></li>
<li><p><strong>details</strong> – The RPC’s status details.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.StreamUnaryServerRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">StreamUnaryServerRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a stream-unary RPC serviced by a system under test.</p>
<p>Enables users to “play client” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.StreamUnaryServerRpc.cancel">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryServerRpc.initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">initial_metadata</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc.initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the initial metadata emitted by the system under test.</p>
<p>This method blocks until the system under test has added initial
metadata to the RPC (or has provided one or more response messages or
has terminated the RPC, either of which will cause gRPC Python to
synthesize initial metadata for the RPC).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The initial metadata for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryServerRpc.requests_closed">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">requests_closed</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc.requests_closed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc.requests_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the end of the RPC’s request stream.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryServerRpc.send_request">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_request</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc.send_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc.send_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends a request to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>request</strong> – A request message for the RPC to be “sent” to the system
under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.StreamUnaryServerRpc.termination">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">termination</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#StreamUnaryServerRpc.termination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.StreamUnaryServerRpc.termination" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has terminated the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><dl class="simple">
<dt>A (response, trailing_metadata, code, details) sequence with the RPC’s</dt><dd><p>response, trailing metadata, code, and details.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.Time">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">Time</span></code><a class="reference internal" href="_modules/grpc_testing.html#Time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time" title="Permalink to this definition">¶</a></dt>
<dd><p>A simulation of time.</p>
<p>Implementations needn’t be connected with real time as provided by the
Python interpreter, but as long as systems under test use
RpcContext.is_active and RpcContext.time_remaining for querying RPC liveness
implementations may be used to change passage of time in tests.</p>
<dl class="py method">
<dt id="grpc_testing.Time.call_at">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">call_at</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Time.call_at"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time.call_at" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a behavior to be called at a specific time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>behavior</strong> – A behavior to be called with no arguments.</p></li>
<li><p><strong>time</strong> – The test time at which to call the behavior.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A grpc.Future with which the call of the behavior may be cancelled</dt><dd><p>before it is executed.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Time.call_in">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">call_in</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">behavior</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delay</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Time.call_in"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time.call_in" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a behavior to be called after some time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>behavior</strong> – A behavior to be called with no arguments.</p></li>
<li><p><strong>delay</strong> – A duration of time in seconds after which to call the behavior.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><dl class="simple">
<dt>A grpc.Future with which the call of the behavior may be cancelled</dt><dd><p>before it is executed.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Time.sleep_for">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">sleep_for</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">duration</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Time.sleep_for"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time.sleep_for" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks for some length of test time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>duration</strong> – A duration of test time in seconds for which to block.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Time.sleep_until">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">sleep_until</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Time.sleep_until"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time.sleep_until" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until some test time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>time</strong> – The test time until which to block.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.Time.time">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">time</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#Time.time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.Time.time" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the current test time.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The current test time (over which this object has authority).</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.UnaryStreamChannelRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">UnaryStreamChannelRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamChannelRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamChannelRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a unary-stream RPC invoked by a system under test.</p>
<p>Enables users to “play server” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.UnaryStreamChannelRpc.cancelled">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancelled</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamChannelRpc.cancelled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamChannelRpc.cancelled" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has cancelled the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamChannelRpc.send_initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_initial_metadata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamChannelRpc.send_initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamChannelRpc.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the RPC’s initial metadata to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>initial_metadata</strong> – The RPC’s initial metadata to be “sent” to
the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamChannelRpc.send_response">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_response</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamChannelRpc.send_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamChannelRpc.send_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends a response to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>response</strong> – A response message to be “sent” to the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamChannelRpc.terminate">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">terminate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trailing_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamChannelRpc.terminate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamChannelRpc.terminate" title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>trailing_metadata</strong> – The RPC’s trailing metadata.</p></li>
<li><p><strong>code</strong> – The RPC’s status code.</p></li>
<li><p><strong>details</strong> – The RPC’s status details.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.UnaryStreamServerRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">UnaryStreamServerRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamServerRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamServerRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a unary-stream RPC serviced by a system under test.</p>
<p>Enables users to “play client” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.UnaryStreamServerRpc.cancel">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamServerRpc.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamServerRpc.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamServerRpc.initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">initial_metadata</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamServerRpc.initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamServerRpc.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the initial metadata emitted by the system under test.</p>
<p>This method blocks until the system under test has added initial
metadata to the RPC (or has provided one or more response messages or
has terminated the RPC, either of which will cause gRPC Python to
synthesize initial metadata for the RPC).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The initial metadata for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamServerRpc.take_response">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_response</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamServerRpc.take_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamServerRpc.take_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Draws one of the responses added to the RPC by the system under test.</p>
<p>Successive calls to this method return responses in the same order in
which the system under test added them to the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A response message added to the RPC by the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryStreamServerRpc.termination">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">termination</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryStreamServerRpc.termination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryStreamServerRpc.termination" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has terminated the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><dl class="simple">
<dt>A (trailing_metadata, code, details) sequence with the RPC’s trailing</dt><dd><p>metadata, code, and details.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.UnaryUnaryChannelRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">UnaryUnaryChannelRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryChannelRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryChannelRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a unary-unary RPC invoked by a system under test.</p>
<p>Enables users to “play server” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.UnaryUnaryChannelRpc.cancelled">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancelled</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryChannelRpc.cancelled"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryChannelRpc.cancelled" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has cancelled the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryUnaryChannelRpc.send_initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_initial_metadata</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initial_metadata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryChannelRpc.send_initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryChannelRpc.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the RPC’s initial metadata to the system under test.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>initial_metadata</strong> – The RPC’s initial metadata to be “sent” to
the system under test.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryUnaryChannelRpc.terminate">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">terminate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trailing_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryChannelRpc.terminate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryChannelRpc.terminate" title="Permalink to this definition">¶</a></dt>
<dd><p>Terminates the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>response</strong> – The response for the RPC.</p></li>
<li><p><strong>trailing_metadata</strong> – The RPC’s trailing metadata.</p></li>
<li><p><strong>code</strong> – The RPC’s status code.</p></li>
<li><p><strong>details</strong> – The RPC’s status details.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="grpc_testing.UnaryUnaryServerRpc">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">UnaryUnaryServerRpc</span></code><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryServerRpc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryServerRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Fixture for a unary-unary RPC serviced by a system under test.</p>
<p>Enables users to “play client” for the RPC.</p>
<dl class="py method">
<dt id="grpc_testing.UnaryUnaryServerRpc.cancel">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryServerRpc.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryServerRpc.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the RPC.</p>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryUnaryServerRpc.initial_metadata">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">initial_metadata</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryServerRpc.initial_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryServerRpc.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the initial metadata emitted by the system under test.</p>
<p>This method blocks until the system under test has added initial
metadata to the RPC (or has provided one or more response messages or
has terminated the RPC, either of which will cause gRPC Python to
synthesize initial metadata for the RPC).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The initial metadata for the RPC.</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="grpc_testing.UnaryUnaryServerRpc.termination">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">termination</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#UnaryUnaryServerRpc.termination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.UnaryUnaryServerRpc.termination" title="Permalink to this definition">¶</a></dt>
<dd><p>Blocks until the system under test has terminated the RPC.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><dl class="simple">
<dt>A (response, trailing_metadata, code, details) sequence with the RPC’s</dt><dd><p>response, trailing metadata, code, and details.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt id="grpc_testing.channel">
<code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">channel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#channel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Channel for use in tests of a gRPC Python-using system.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>service_descriptors</strong> – An iterable of descriptor.ServiceDescriptors
describing the RPCs that will be made on the returned Channel by the
system under test.</p></li>
<li><p><strong>time</strong> – A Time to be used for tests.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Channel for use in tests.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="grpc_testing.server_from_dictionary">
<code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">server_from_dictionary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">descriptors_to_servicers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#server_from_dictionary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.server_from_dictionary" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Server for use in tests of a gRPC Python-using system.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>descriptors_to_servicers</strong> – A dictionary from descriptor.ServiceDescriptors
defining RPC services to servicer objects (usually instances of classes
that implement “Servicer” interfaces defined in generated “_pb2_grpc”
modules) implementing those services.</p></li>
<li><p><strong>time</strong> – A Time to be used for tests.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A Server for use in tests.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="grpc_testing.strict_fake_time">
<code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">strict_fake_time</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">now</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#strict_fake_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.strict_fake_time" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Time that can be manipulated by test code.</p>
<p>The returned instance maintains an internal representation of time
independent of real time. This internal representation only advances
when user code calls the instance’s sleep_for and sleep_until methods.</p>
<p>The returned instance will be “strict” with respect to callbacks
submitted to it: it will ensure that all callbacks registered to
be called at time t have been called before it describes the time
as having advanced beyond t.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A Time that simulates the passage of time.</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="grpc_testing.strict_real_time">
<code class="sig-prename descclassname"><span class="pre">grpc_testing.</span></code><code class="sig-name descname"><span class="pre">strict_real_time</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_testing.html#strict_real_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_testing.strict_real_time" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Time backed by the Python interpreter’s time.</p>
<p>The returned instance will be “strict” with respect to callbacks
submitted to it: it will ensure that all callbacks registered to
be called at time t have been called before it describes the time
as having advanced beyond t.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A Time backed by the “system” (Python interpreter’s) time.</p>
</dd>
</dl>
</dd></dl>

</div>
</div>


          </div>
          
        </div>
      </div>
    <div class="clearer"></div>
  </div>
    <div class="footer">
      &copy;2020, The gRPC Authors.
      
      |
      <a href="_sources/grpc_testing.rst.txt"
          rel="nofollow">Page source</a>
    </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>