Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e8946f80a759d13a28e71149a08ca8980b6a5a0b / . / docs / epy / googleapiclient.http.HttpMockSequence-class.html
blob: 9eaf4d1e7c41b3acb74f62c6f451d3a3c2295c03 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>googleapiclient.http.HttpMockSequence</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
41 <a href="googleapiclient.http-module.html">Module&nbsp;http</a> ::
42 Class&nbsp;HttpMockSequence
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="googleapiclient.http.HttpMockSequence-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57</table>
58<!-- ==================== CLASS DESCRIPTION ==================== -->
59<h1 class="epydoc">Class HttpMockSequence</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMockSequence">source&nbsp;code</a></span></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]60<pre class="base-tree">
61object --+
62 |
63 <strong class="uidshort">HttpMockSequence</strong>
64</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]65
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]66<hr />
67<pre class="literalblock">
68Mock of httplib2.Http
69
70Mocks a sequence of calls to request returning different responses for each
71call. Create an instance initialized with the desired response headers
72and content and then use as if an httplib2.Http instance.
73
74 http = HttpMockSequence([
75 ({'status': '401'}, ''),
76 ({'status': '200'}, '{&quot;access_token&quot;:&quot;1/3w&quot;,&quot;expires_in&quot;:3600}'),
77 ({'status': '200'}, 'echo_request_headers'),
78 ])
79 resp, content = http.request(&quot;http://examples.com&quot;)
80
81There are special values you can pass in for content to trigger
82behavours that are helpful in testing.
83
84'echo_request_headers' means return the request headers in the response body
85'echo_request_headers_as_json' means return the request headers in
86 the response body
87'echo_request_body' means return the request body in the response body
88'echo_request_uri' means return the request uri in the response body
89
90</pre>
91
92<!-- ==================== INSTANCE METHODS ==================== -->
93<a name="section-InstanceMethods"></a>
94<table class="summary" border="1" cellpadding="3"
95 cellspacing="0" width="100%" bgcolor="white">
96<tr bgcolor="#70b0f0" class="table-header">
97 <td colspan="2" class="table-header">
98 <table border="0" cellpadding="0" cellspacing="0" width="100%">
99 <tr valign="top">
100 <td align="left"><span class="table-header">Instance Methods</span></td>
101 <td align="right" valign="top"
102 ><span class="options">[<a href="#section-InstanceMethods"
103 class="privatelink" onclick="toggle_private();"
104 >hide private</a>]</span></td>
105 </tr>
106 </table>
107 </td>
108</tr>
109<tr>
110 <td width="15%" align="right" valign="top" class="summary">
111 <span class="summary-type">&nbsp;</span>
112 </td><td class="summary">
113 <table width="100%" cellpadding="0" cellspacing="0" border="0">
114 <tr>
115 <td><span class="summary-sig"><a href="googleapiclient.http.HttpMockSequence-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
116 <span class="summary-sig-arg">iterable</span>)</span><br />
117 Args:...</td>
118 <td align="right" valign="top">
119 <span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMockSequence.__init__">source&nbsp;code</a></span>
120
121 </td>
122 </tr>
123 </table>
124
125 </td>
126 </tr>
127<tr>
128 <td width="15%" align="right" valign="top" class="summary">
129 <span class="summary-type">&nbsp;</span>
130 </td><td class="summary">
131 <table width="100%" cellpadding="0" cellspacing="0" border="0">
132 <tr>
133 <td><span class="summary-sig"><a name="request"></a><span class="summary-sig-name">request</span>(<span class="summary-sig-arg">self</span>,
134 <span class="summary-sig-arg">uri</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>,
137 <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
138 <span class="summary-sig-arg">redirections</span>=<span class="summary-sig-default">1</span>,
139 <span class="summary-sig-arg">connection_type</span>=<span class="summary-sig-default">None</span>)</span></td>
140 <td align="right" valign="top">
141 <span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMockSequence.request">source&nbsp;code</a></span>
142
143 </td>
144 </tr>
145 </table>
146
147 </td>
148 </tr>
149 <tr>
150 <td colspan="2" class="summary">
151 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
152 <code>__delattr__</code>,
153 <code>__format__</code>,
154 <code>__getattribute__</code>,
155 <code>__hash__</code>,
156 <code>__new__</code>,
157 <code>__reduce__</code>,
158 <code>__reduce_ex__</code>,
159 <code>__repr__</code>,
160 <code>__setattr__</code>,
161 <code>__sizeof__</code>,
162 <code>__str__</code>,
163 <code>__subclasshook__</code>
164 </p>
165 </td>
166 </tr>
167</table>
168<!-- ==================== PROPERTIES ==================== -->
169<a name="section-Properties"></a>
170<table class="summary" border="1" cellpadding="3"
171 cellspacing="0" width="100%" bgcolor="white">
172<tr bgcolor="#70b0f0" class="table-header">
173 <td colspan="2" class="table-header">
174 <table border="0" cellpadding="0" cellspacing="0" width="100%">
175 <tr valign="top">
176 <td align="left"><span class="table-header">Properties</span></td>
177 <td align="right" valign="top"
178 ><span class="options">[<a href="#section-Properties"
179 class="privatelink" onclick="toggle_private();"
180 >hide private</a>]</span></td>
181 </tr>
182 </table>
183 </td>
184</tr>
185 <tr>
186 <td colspan="2" class="summary">
187 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
188 <code>__class__</code>
189 </p>
190 </td>
191 </tr>
192</table>
193<!-- ==================== METHOD DETAILS ==================== -->
194<a name="section-MethodDetails"></a>
195<table class="details" border="1" cellpadding="3"
196 cellspacing="0" width="100%" bgcolor="white">
197<tr bgcolor="#70b0f0" class="table-header">
198 <td colspan="2" class="table-header">
199 <table border="0" cellpadding="0" cellspacing="0" width="100%">
200 <tr valign="top">
201 <td align="left"><span class="table-header">Method Details</span></td>
202 <td align="right" valign="top"
203 ><span class="options">[<a href="#section-MethodDetails"
204 class="privatelink" onclick="toggle_private();"
205 >hide private</a>]</span></td>
206 </tr>
207 </table>
208 </td>
209</tr>
210</table>
211<a name="__init__"></a>
212<div>
213<table class="details" border="1" cellpadding="3"
214 cellspacing="0" width="100%" bgcolor="white">
215<tr><td>
216 <table width="100%" cellpadding="0" cellspacing="0" border="0">
217 <tr valign="top"><td>
218 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
219 <span class="sig-arg">iterable</span>)</span>
220 <br /><em class="fname">(Constructor)</em>
221 </h3>
222 </td><td align="right" valign="top"
223 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpMockSequence.__init__">source&nbsp;code</a></span>&nbsp;
224 </td>
225 </tr></table>
226
227 <pre class="literalblock">
228
229Args:
230 iterable: iterable, a sequence of pairs of (headers, body)
231
232</pre>
233 <dl class="fields">
234 <dt>Overrides:
235 object.__init__
236 </dt>
237 </dl>
238</td></tr></table>
239</div>
240<br />
241<!-- ==================== NAVIGATION BAR ==================== -->
242<table class="navbar" border="0" width="100%" cellpadding="0"
243 bgcolor="#a0c0ff" cellspacing="0">
244 <tr valign="middle">
245 <!-- Home link -->
246 <th>&nbsp;&nbsp;&nbsp;<a
247 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
248
249 <!-- Tree link -->
250 <th>&nbsp;&nbsp;&nbsp;<a
251 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
252
253 <!-- Index link -->
254 <th>&nbsp;&nbsp;&nbsp;<a
255 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
256
257 <!-- Help link -->
258 <th>&nbsp;&nbsp;&nbsp;<a
259 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
260
261 <th class="navbar" width="100%"></th>
262 </tr>
263</table>
264<table border="0" cellpadding="0" cellspacing="0" width="100%%">
265 <tr>
266 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]267 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 </td>
269 <td align="right" class="footer">
270 <a target="mainFrame" href="http://epydoc.sourceforge.net"
271 >http://epydoc.sourceforge.net</a>
272 </td>
273 </tr>
274</table>
275
276<script type="text/javascript">
277 <!--
278 // Private objects are initially displayed (because if
279 // javascript is turned off then we want them to be
280 // visible); but by default, we want to hide them. So hide
281 // them unless we have a cookie that says to show them.
282 checkCookie();
283 // -->
284</script>
285</body>
286</html>