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