blob: 73578cf89c1bc550c0b74f501e5349f7dc61d160 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html lang="en" data-content_root="../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>grpc_testing &#8212; gRPC Python Docs v1.78.1</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=ed1a634b" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=ef80e3d6"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://www.googletagmanager.com/gtag/js?id=UA-60127042-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-60127042-1');
</script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-60127042-1');
</script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/grpc_testing';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.78.1" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../index.html">
<p class="title logo__title">gRPC Python Docs v1.78.1</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">Module code</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">grpc_testing</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<h1>Source code for grpc_testing</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2017 gRPC authors.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</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 &quot;AS IS&quot; 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">&quot;&quot;&quot;Objects for use in testing gRPC Python-using application code.&quot;&quot;&quot;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">google.protobuf</span><span class="w"> </span><span class="kn">import</span> <span class="n">descriptor</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">grpc</span>
<div class="viewcode-block" id="UnaryUnaryChannelRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryChannelRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UnaryUnaryChannelRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a unary-unary RPC invoked by a system under test.</span>
<span class="sd"> Enables users to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="UnaryUnaryChannelRpc.send_initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryChannelRpc.send_initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends the RPC&#39;s initial metadata to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> initial_metadata: The RPC&#39;s initial metadata to be &quot;sent&quot; to</span>
<span class="sd"> the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryUnaryChannelRpc.cancelled">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryChannelRpc.cancelled">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has cancelled the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryUnaryChannelRpc.terminate">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryChannelRpc.terminate">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">terminate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Terminates the RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> response: The response for the RPC.</span>
<span class="sd"> trailing_metadata: The RPC&#39;s trailing metadata.</span>
<span class="sd"> code: The RPC&#39;s status code.</span>
<span class="sd"> details: The RPC&#39;s status details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="UnaryStreamChannelRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamChannelRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UnaryStreamChannelRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a unary-stream RPC invoked by a system under test.</span>
<span class="sd"> Enables users to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="UnaryStreamChannelRpc.send_initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamChannelRpc.send_initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends the RPC&#39;s initial metadata to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> initial_metadata: The RPC&#39;s initial metadata to be &quot;sent&quot; to</span>
<span class="sd"> the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamChannelRpc.send_response">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamChannelRpc.send_response">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends a response to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> response: A response message to be &quot;sent&quot; to the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamChannelRpc.cancelled">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamChannelRpc.cancelled">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has cancelled the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamChannelRpc.terminate">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamChannelRpc.terminate">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">terminate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Terminates the RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> trailing_metadata: The RPC&#39;s trailing metadata.</span>
<span class="sd"> code: The RPC&#39;s status code.</span>
<span class="sd"> details: The RPC&#39;s status details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="StreamUnaryChannelRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StreamUnaryChannelRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a stream-unary RPC invoked by a system under test.</span>
<span class="sd"> Enables users to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="StreamUnaryChannelRpc.send_initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc.send_initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends the RPC&#39;s initial metadata to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> initial_metadata: The RPC&#39;s initial metadata to be &quot;sent&quot; to</span>
<span class="sd"> the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryChannelRpc.take_request">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc.take_request">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws one of the requests added to the RPC by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added to the RPC</span>
<span class="sd"> the request to be returned.</span>
<span class="sd"> Successive calls to this method return requests in the same order in</span>
<span class="sd"> which the system under test added them to the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A request message added to the RPC by the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryChannelRpc.requests_closed">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc.requests_closed">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">requests_closed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has closed the request stream.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryChannelRpc.cancelled">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc.cancelled">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has cancelled the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryChannelRpc.terminate">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryChannelRpc.terminate">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">terminate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Terminates the RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> response: The response for the RPC.</span>
<span class="sd"> trailing_metadata: The RPC&#39;s trailing metadata.</span>
<span class="sd"> code: The RPC&#39;s status code.</span>
<span class="sd"> details: The RPC&#39;s status details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="StreamStreamChannelRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StreamStreamChannelRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a stream-stream RPC invoked by a system under test.</span>
<span class="sd"> Enables users to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="StreamStreamChannelRpc.send_initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.send_initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends the RPC&#39;s initial metadata to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> initial_metadata: The RPC&#39;s initial metadata to be &quot;sent&quot; to the</span>
<span class="sd"> system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamChannelRpc.take_request">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.take_request">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws one of the requests added to the RPC by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added to the RPC</span>
<span class="sd"> the request to be returned.</span>
<span class="sd"> Successive calls to this method return requests in the same order in</span>
<span class="sd"> which the system under test added them to the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A request message added to the RPC by the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamChannelRpc.send_response">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.send_response">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends a response to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> response: A response messages to be &quot;sent&quot; to the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamChannelRpc.requests_closed">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.requests_closed">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">requests_closed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has closed the request stream.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamChannelRpc.cancelled">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.cancelled">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has cancelled the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamChannelRpc.terminate">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamChannelRpc.terminate">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">terminate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Terminates the RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> trailing_metadata: The RPC&#39;s trailing metadata.</span>
<span class="sd"> code: The RPC&#39;s status code.</span>
<span class="sd"> details: The RPC&#39;s status details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="Channel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Channel">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Channel</span><span class="p">(</span><span class="n">grpc</span><span class="o">.</span><span class="n">Channel</span><span class="p">,</span> <span class="n">metaclass</span><span class="o">=</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A grpc.Channel double with which to test a system that invokes RPCs.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Channel.take_unary_unary">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Channel.take_unary_unary">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws an RPC currently being made by the system under test.</span>
<span class="sd"> If the given descriptor does not identify any RPC currently being made</span>
<span class="sd"> by the system under test, this method blocks until the system under</span>
<span class="sd"> test invokes such an RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a</span>
<span class="sd"> unary-unary RPC method.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (invocation_metadata, request, unary_unary_channel_rpc) tuple of</span>
<span class="sd"> the RPC&#39;s invocation metadata, its request, and a</span>
<span class="sd"> UnaryUnaryChannelRpc with which to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Channel.take_unary_stream">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Channel.take_unary_stream">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws an RPC currently being made by the system under test.</span>
<span class="sd"> If the given descriptor does not identify any RPC currently being made</span>
<span class="sd"> by the system under test, this method blocks until the system under</span>
<span class="sd"> test invokes such an RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a</span>
<span class="sd"> unary-stream RPC method.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (invocation_metadata, request, unary_stream_channel_rpc) tuple of</span>
<span class="sd"> the RPC&#39;s invocation metadata, its request, and a</span>
<span class="sd"> UnaryStreamChannelRpc with which to &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Channel.take_stream_unary">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Channel.take_stream_unary">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws an RPC currently being made by the system under test.</span>
<span class="sd"> If the given descriptor does not identify any RPC currently being made</span>
<span class="sd"> by the system under test, this method blocks until the system under</span>
<span class="sd"> test invokes such an RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a</span>
<span class="sd"> stream-unary RPC method.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (invocation_metadata, stream_unary_channel_rpc) tuple of the RPC&#39;s</span>
<span class="sd"> invocation metadata and a StreamUnaryChannelRpc with which to &quot;play</span>
<span class="sd"> server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Channel.take_stream_stream">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Channel.take_stream_stream">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws an RPC currently being made by the system under test.</span>
<span class="sd"> If the given descriptor does not identify any RPC currently being made</span>
<span class="sd"> by the system under test, this method blocks until the system under</span>
<span class="sd"> test invokes such an RPC.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a</span>
<span class="sd"> stream-stream RPC method.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (invocation_metadata, stream_stream_channel_rpc) tuple of the RPC&#39;s</span>
<span class="sd"> invocation metadata and a StreamStreamChannelRpc with which to</span>
<span class="sd"> &quot;play server&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="UnaryUnaryServerRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryServerRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UnaryUnaryServerRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a unary-unary RPC serviced by a system under test.</span>
<span class="sd"> Enables users to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="UnaryUnaryServerRpc.initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryServerRpc.initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Accesses the initial metadata emitted by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added initial</span>
<span class="sd"> metadata to the RPC (or has provided one or more response messages or</span>
<span class="sd"> has terminated the RPC, either of which will cause gRPC Python to</span>
<span class="sd"> synthesize initial metadata for the RPC).</span>
<span class="sd"> Returns:</span>
<span class="sd"> The initial metadata for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryUnaryServerRpc.cancel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryServerRpc.cancel">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Cancels the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryUnaryServerRpc.termination">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryUnaryServerRpc.termination">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">termination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has terminated the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (response, trailing_metadata, code, details) sequence with the RPC&#39;s</span>
<span class="sd"> response, trailing metadata, code, and details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="UnaryStreamServerRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamServerRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UnaryStreamServerRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a unary-stream RPC serviced by a system under test.</span>
<span class="sd"> Enables users to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="UnaryStreamServerRpc.initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamServerRpc.initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Accesses the initial metadata emitted by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added initial</span>
<span class="sd"> metadata to the RPC (or has provided one or more response messages or</span>
<span class="sd"> has terminated the RPC, either of which will cause gRPC Python to</span>
<span class="sd"> synthesize initial metadata for the RPC).</span>
<span class="sd"> Returns:</span>
<span class="sd"> The initial metadata for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamServerRpc.take_response">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamServerRpc.take_response">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws one of the responses added to the RPC by the system under test.</span>
<span class="sd"> Successive calls to this method return responses in the same order in</span>
<span class="sd"> which the system under test added them to the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A response message added to the RPC by the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamServerRpc.cancel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamServerRpc.cancel">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Cancels the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="UnaryStreamServerRpc.termination">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.UnaryStreamServerRpc.termination">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">termination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has terminated the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (trailing_metadata, code, details) sequence with the RPC&#39;s trailing</span>
<span class="sd"> metadata, code, and details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="StreamUnaryServerRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StreamUnaryServerRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a stream-unary RPC serviced by a system under test.</span>
<span class="sd"> Enables users to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="StreamUnaryServerRpc.initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc.initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Accesses the initial metadata emitted by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added initial</span>
<span class="sd"> metadata to the RPC (or has provided one or more response messages or</span>
<span class="sd"> has terminated the RPC, either of which will cause gRPC Python to</span>
<span class="sd"> synthesize initial metadata for the RPC).</span>
<span class="sd"> Returns:</span>
<span class="sd"> The initial metadata for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryServerRpc.send_request">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc.send_request">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends a request to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> request: A request message for the RPC to be &quot;sent&quot; to the system</span>
<span class="sd"> under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryServerRpc.requests_closed">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc.requests_closed">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">requests_closed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Indicates the end of the RPC&#39;s request stream.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryServerRpc.cancel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc.cancel">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Cancels the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamUnaryServerRpc.termination">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamUnaryServerRpc.termination">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">termination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has terminated the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (response, trailing_metadata, code, details) sequence with the RPC&#39;s</span>
<span class="sd"> response, trailing metadata, code, and details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="StreamStreamServerRpc">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">StreamStreamServerRpc</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fixture for a stream-stream RPC serviced by a system under test.</span>
<span class="sd"> Enables users to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="StreamStreamServerRpc.initial_metadata">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.initial_metadata">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Accesses the initial metadata emitted by the system under test.</span>
<span class="sd"> This method blocks until the system under test has added initial</span>
<span class="sd"> metadata to the RPC (or has provided one or more response messages or</span>
<span class="sd"> has terminated the RPC, either of which will cause gRPC Python to</span>
<span class="sd"> synthesize initial metadata for the RPC).</span>
<span class="sd"> Returns:</span>
<span class="sd"> The initial metadata for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamServerRpc.send_request">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.send_request">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">send_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sends a request to the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> request: A request message for the RPC to be &quot;sent&quot; to the system</span>
<span class="sd"> under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamServerRpc.requests_closed">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.requests_closed">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">requests_closed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Indicates the end of the RPC&#39;s request stream.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamServerRpc.take_response">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.take_response">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">take_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Draws one of the responses added to the RPC by the system under test.</span>
<span class="sd"> Successive calls to this method return responses in the same order in</span>
<span class="sd"> which the system under test added them to the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A response message added to the RPC by the system under test.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamServerRpc.cancel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.cancel">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Cancels the RPC.&quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="StreamStreamServerRpc.termination">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.StreamStreamServerRpc.termination">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">termination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until the system under test has terminated the RPC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A (trailing_metadata, code, details) sequence with the RPC&#39;s trailing</span>
<span class="sd"> metadata, code, and details.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="Server">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Server">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Server</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A server with which to test a system that services RPCs.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Server.invoke_unary_unary">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Server.invoke_unary_unary">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">invoke_unary_unary</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">,</span> <span class="n">invocation_metadata</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Invokes an RPC to be serviced by the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a unary-unary</span>
<span class="sd"> RPC method.</span>
<span class="sd"> invocation_metadata: The RPC&#39;s invocation metadata.</span>
<span class="sd"> request: The RPC&#39;s request.</span>
<span class="sd"> timeout: A duration of time in seconds for the RPC or None to</span>
<span class="sd"> indicate that the RPC has no time limit.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A UnaryUnaryServerRpc with which to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Server.invoke_unary_stream">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Server.invoke_unary_stream">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">invoke_unary_stream</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">,</span> <span class="n">invocation_metadata</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Invokes an RPC to be serviced by the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a unary-stream</span>
<span class="sd"> RPC method.</span>
<span class="sd"> invocation_metadata: The RPC&#39;s invocation metadata.</span>
<span class="sd"> request: The RPC&#39;s request.</span>
<span class="sd"> timeout: A duration of time in seconds for the RPC or None to</span>
<span class="sd"> indicate that the RPC has no time limit.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A UnaryStreamServerRpc with which to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Server.invoke_stream_unary">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Server.invoke_stream_unary">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">invoke_stream_unary</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">,</span> <span class="n">invocation_metadata</span><span class="p">,</span> <span class="n">timeout</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Invokes an RPC to be serviced by the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a stream-unary</span>
<span class="sd"> RPC method.</span>
<span class="sd"> invocation_metadata: The RPC&#39;s invocation metadata.</span>
<span class="sd"> timeout: A duration of time in seconds for the RPC or None to</span>
<span class="sd"> indicate that the RPC has no time limit.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A StreamUnaryServerRpc with which to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Server.invoke_stream_stream">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Server.invoke_stream_stream">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">invoke_stream_stream</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">method_descriptor</span><span class="p">,</span> <span class="n">invocation_metadata</span><span class="p">,</span> <span class="n">timeout</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Invokes an RPC to be serviced by the system under test.</span>
<span class="sd"> Args:</span>
<span class="sd"> method_descriptor: A descriptor.MethodDescriptor describing a stream-stream</span>
<span class="sd"> RPC method.</span>
<span class="sd"> invocation_metadata: The RPC&#39;s invocation metadata.</span>
<span class="sd"> timeout: A duration of time in seconds for the RPC or None to</span>
<span class="sd"> indicate that the RPC has no time limit.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A StreamStreamServerRpc with which to &quot;play client&quot; for the RPC.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="Time">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Time</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A simulation of time.</span>
<span class="sd"> Implementations needn&#39;t be connected with real time as provided by the</span>
<span class="sd"> Python interpreter, but as long as systems under test use</span>
<span class="sd"> RpcContext.is_active and RpcContext.time_remaining for querying RPC liveness</span>
<span class="sd"> implementations may be used to change passage of time in tests.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="Time.time">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time.time">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">time</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Accesses the current test time.</span>
<span class="sd"> Returns:</span>
<span class="sd"> The current test time (over which this object has authority).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Time.call_in">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time.call_in">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">call_in</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span> <span class="n">delay</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds a behavior to be called after some time.</span>
<span class="sd"> Args:</span>
<span class="sd"> behavior: A behavior to be called with no arguments.</span>
<span class="sd"> delay: A duration of time in seconds after which to call the behavior.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A grpc.Future with which the call of the behavior may be cancelled</span>
<span class="sd"> before it is executed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Time.call_at">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time.call_at">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">call_at</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">behavior</span><span class="p">,</span> <span class="n">time</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds a behavior to be called at a specific time.</span>
<span class="sd"> Args:</span>
<span class="sd"> behavior: A behavior to be called with no arguments.</span>
<span class="sd"> time: The test time at which to call the behavior.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A grpc.Future with which the call of the behavior may be cancelled</span>
<span class="sd"> before it is executed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Time.sleep_for">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time.sleep_for">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sleep_for</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">duration</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks for some length of test time.</span>
<span class="sd"> Args:</span>
<span class="sd"> duration: A duration of test time in seconds for which to block.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Time.sleep_until">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.Time.sleep_until">[docs]</a>
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sleep_until</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Blocks until some test time.</span>
<span class="sd"> Args:</span>
<span class="sd"> time: The test time until which to block.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
</div>
<div class="viewcode-block" id="strict_real_time">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.strict_real_time">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">strict_real_time</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a Time backed by the Python interpreter&#39;s time.</span>
<span class="sd"> The returned instance will be &quot;strict&quot; with respect to callbacks</span>
<span class="sd"> submitted to it: it will ensure that all callbacks registered to</span>
<span class="sd"> be called at time t have been called before it describes the time</span>
<span class="sd"> as having advanced beyond t.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Time backed by the &quot;system&quot; (Python interpreter&#39;s) time.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">grpc_testing</span><span class="w"> </span><span class="kn">import</span> <span class="n">_time</span>
<span class="k">return</span> <span class="n">_time</span><span class="o">.</span><span class="n">StrictRealTime</span><span class="p">()</span></div>
<div class="viewcode-block" id="strict_fake_time">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.strict_fake_time">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">strict_fake_time</span><span class="p">(</span><span class="n">now</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a Time that can be manipulated by test code.</span>
<span class="sd"> The returned instance maintains an internal representation of time</span>
<span class="sd"> independent of real time. This internal representation only advances</span>
<span class="sd"> when user code calls the instance&#39;s sleep_for and sleep_until methods.</span>
<span class="sd"> The returned instance will be &quot;strict&quot; with respect to callbacks</span>
<span class="sd"> submitted to it: it will ensure that all callbacks registered to</span>
<span class="sd"> be called at time t have been called before it describes the time</span>
<span class="sd"> as having advanced beyond t.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Time that simulates the passage of time.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">grpc_testing</span><span class="w"> </span><span class="kn">import</span> <span class="n">_time</span>
<span class="k">return</span> <span class="n">_time</span><span class="o">.</span><span class="n">StrictFakeTime</span><span class="p">(</span><span class="n">now</span><span class="p">)</span></div>
<div class="viewcode-block" id="channel">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.channel">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">channel</span><span class="p">(</span><span class="n">service_descriptors</span><span class="p">,</span> <span class="n">time</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a Channel for use in tests of a gRPC Python-using system.</span>
<span class="sd"> Args:</span>
<span class="sd"> service_descriptors: An iterable of descriptor.ServiceDescriptors</span>
<span class="sd"> describing the RPCs that will be made on the returned Channel by the</span>
<span class="sd"> system under test.</span>
<span class="sd"> time: A Time to be used for tests.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Channel for use in tests.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">grpc_testing</span><span class="w"> </span><span class="kn">import</span> <span class="n">_channel</span>
<span class="k">return</span> <span class="n">_channel</span><span class="o">.</span><span class="n">testing_channel</span><span class="p">(</span><span class="n">service_descriptors</span><span class="p">,</span> <span class="n">time</span><span class="p">)</span></div>
<div class="viewcode-block" id="server_from_dictionary">
<a class="viewcode-back" href="../grpc_testing.html#grpc_testing.server_from_dictionary">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">server_from_dictionary</span><span class="p">(</span><span class="n">descriptors_to_servicers</span><span class="p">,</span> <span class="n">time</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a Server for use in tests of a gRPC Python-using system.</span>
<span class="sd"> Args:</span>
<span class="sd"> descriptors_to_servicers: A dictionary from descriptor.ServiceDescriptors</span>
<span class="sd"> defining RPC services to servicer objects (usually instances of classes</span>
<span class="sd"> that implement &quot;Servicer&quot; interfaces defined in generated &quot;_pb2_grpc&quot;</span>
<span class="sd"> modules) implementing those services.</span>
<span class="sd"> time: A Time to be used for tests.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A Server for use in tests.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">grpc_testing</span><span class="w"> </span><span class="kn">import</span> <span class="n">_server</span>
<span class="k">return</span> <span class="n">_server</span><span class="o">.</span><span class="n">server_from_dictionary</span><span class="p">(</span><span class="n">descriptors_to_servicers</span><span class="p">,</span> <span class="n">time</span><span class="p">)</span></div>
</pre></div>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
</div>
</footer>
</div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2025, The gRPC Authors.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>