Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7700bbffda386345cc4426ef413fc643f6368ef4 / . / docs / epy / googleapiclient.http.HttpRequestMock-class.html
blob: 804582119fd45827280995f13ca2ac67937d3469 [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.HttpRequestMock</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;HttpRequestMock
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.HttpRequestMock-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 HttpRequestMock</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock">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">HttpRequestMock</strong>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]64</pre>
65
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]66<hr />
67<p>Mock of HttpRequest.</p>
68 <p>Do not construct directly, instead use RequestMockBuilder.</p>
69
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
93 <td><span class="summary-sig"><a href="googleapiclient.http.HttpRequestMock-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">resp</span>,
95 <span class="summary-sig-arg">content</span>,
96 <span class="summary-sig-arg">postproc</span>)</span><br />
97 Constructor for HttpRequestMock</td>
98 <td align="right" valign="top">
99 <span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock.__init__">source&nbsp;code</a></span>
100
101 </td>
102 </tr>
103 </table>
104
105 </td>
106 </tr>
107<tr>
108 <td width="15%" align="right" valign="top" class="summary">
109 <span class="summary-type">&nbsp;</span>
110 </td><td class="summary">
111 <table width="100%" cellpadding="0" cellspacing="0" border="0">
112 <tr>
113 <td><span class="summary-sig"><a href="googleapiclient.http.HttpRequestMock-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
114 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
115 Execute the request.</td>
116 <td align="right" valign="top">
117 <span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock.execute">source&nbsp;code</a></span>
118
119 </td>
120 </tr>
121 </table>
122
123 </td>
124 </tr>
125 <tr>
126 <td colspan="2" class="summary">
127 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
128 <code>__delattr__</code>,
129 <code>__format__</code>,
130 <code>__getattribute__</code>,
131 <code>__hash__</code>,
132 <code>__new__</code>,
133 <code>__reduce__</code>,
134 <code>__reduce_ex__</code>,
135 <code>__repr__</code>,
136 <code>__setattr__</code>,
137 <code>__sizeof__</code>,
138 <code>__str__</code>,
139 <code>__subclasshook__</code>
140 </p>
141 </td>
142 </tr>
143</table>
144<!-- ==================== PROPERTIES ==================== -->
145<a name="section-Properties"></a>
146<table class="summary" border="1" cellpadding="3"
147 cellspacing="0" width="100%" bgcolor="white">
148<tr bgcolor="#70b0f0" class="table-header">
149 <td colspan="2" class="table-header">
150 <table border="0" cellpadding="0" cellspacing="0" width="100%">
151 <tr valign="top">
152 <td align="left"><span class="table-header">Properties</span></td>
153 <td align="right" valign="top"
154 ><span class="options">[<a href="#section-Properties"
155 class="privatelink" onclick="toggle_private();"
156 >hide private</a>]</span></td>
157 </tr>
158 </table>
159 </td>
160</tr>
161 <tr>
162 <td colspan="2" class="summary">
163 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
164 <code>__class__</code>
165 </p>
166 </td>
167 </tr>
168</table>
169<!-- ==================== METHOD DETAILS ==================== -->
170<a name="section-MethodDetails"></a>
171<table class="details" border="1" cellpadding="3"
172 cellspacing="0" width="100%" bgcolor="white">
173<tr bgcolor="#70b0f0" class="table-header">
174 <td colspan="2" class="table-header">
175 <table border="0" cellpadding="0" cellspacing="0" width="100%">
176 <tr valign="top">
177 <td align="left"><span class="table-header">Method Details</span></td>
178 <td align="right" valign="top"
179 ><span class="options">[<a href="#section-MethodDetails"
180 class="privatelink" onclick="toggle_private();"
181 >hide private</a>]</span></td>
182 </tr>
183 </table>
184 </td>
185</tr>
186</table>
187<a name="__init__"></a>
188<div>
189<table class="details" border="1" cellpadding="3"
190 cellspacing="0" width="100%" bgcolor="white">
191<tr><td>
192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
193 <tr valign="top"><td>
194 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
195 <span class="sig-arg">resp</span>,
196 <span class="sig-arg">content</span>,
197 <span class="sig-arg">postproc</span>)</span>
198 <br /><em class="fname">(Constructor)</em>
199 </h3>
200 </td><td align="right" valign="top"
201 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock.__init__">source&nbsp;code</a></span>&nbsp;
202 </td>
203 </tr></table>
204
205 <pre class="literalblock">
206Constructor for HttpRequestMock
207
208Args:
209 resp: httplib2.Response, the response to emulate coming from the request
210 content: string, the response body
211 postproc: callable, the post processing function usually supplied by
212 the model class. See model.JsonModel.response() as an example.
213
214</pre>
215 <dl class="fields">
216 <dt>Overrides:
217 object.__init__
218 </dt>
219 </dl>
220</td></tr></table>
221</div>
222<a name="execute"></a>
223<div>
224<table class="details" border="1" cellpadding="3"
225 cellspacing="0" width="100%" bgcolor="white">
226<tr><td>
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr valign="top"><td>
229 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
230 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
231 </h3>
232 </td><td align="right" valign="top"
233 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#HttpRequestMock.execute">source&nbsp;code</a></span>&nbsp;
234 </td>
235 </tr></table>
236
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]237 <p>Execute the request.</p>
238 <p>Same behavior as HttpRequest.execute(), but the response is mocked and
239 not really from an HTTP request/response.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 <dl class="fields">
241 </dl>
242</td></tr></table>
243</div>
244<br />
245<!-- ==================== NAVIGATION BAR ==================== -->
246<table class="navbar" border="0" width="100%" cellpadding="0"
247 bgcolor="#a0c0ff" cellspacing="0">
248 <tr valign="middle">
249 <!-- Home link -->
250 <th>&nbsp;&nbsp;&nbsp;<a
251 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
252
253 <!-- Tree link -->
254 <th>&nbsp;&nbsp;&nbsp;<a
255 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
256
257 <!-- Index link -->
258 <th>&nbsp;&nbsp;&nbsp;<a
259 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
260
261 <!-- Help link -->
262 <th>&nbsp;&nbsp;&nbsp;<a
263 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
264
265 <th class="navbar" width="100%"></th>
266 </tr>
267</table>
268<table border="0" cellpadding="0" cellspacing="0" width="100%%">
269 <tr>
270 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]271 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 </td>
273 <td align="right" class="footer">
274 <a target="mainFrame" href="http://epydoc.sourceforge.net"
275 >http://epydoc.sourceforge.net</a>
276 </td>
277 </tr>
278</table>
279
280<script type="text/javascript">
281 <!--
282 // Private objects are initially displayed (because if
283 // javascript is turned off then we want them to be
284 // visible); but by default, we want to hide them. So hide
285 // them unless we have a cookie that says to show them.
286 checkCookie();
287 // -->
288</script>
289</body>
290</html>