Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / apiclient.http.RequestMockBuilder-class.html
blob: ae4d4b320b890cb54a671b4ca9c0ac20603bfe0e [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.RequestMockBuilder</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;RequestMockBuilder
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.RequestMockBuilder-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 RequestMockBuilder</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_apiclien_22" name="uml_class_diagram_for_apiclien_22">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]59<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html#__init__" title="Constructor for RequestMockBuilder" alt="" coords="17,36,671,55"/>
60<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html#__call__" title="Implements the callable interface that discovery.build() expects of requestBuilder, which is to build an object compatible with HttpRequest.execute()." alt="" coords="17,55,671,73"/>
61<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html" title="A simple mock of HttpRequest" alt="" coords="16,11,672,75"/>
62</map>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]63 <img src="uml_class_diagram_for_apiclien_22.gif" alt='' usemap="#uml_class_diagram_for_apiclien_22" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68A simple mock of HttpRequest
69
70Pass in a dictionary to the constructor that maps request methodIds to
71tuples of (httplib2.Response, content, opt_expected_body) that should be
72returned when that method is called. None may also be passed in for the
73httplib2.Response, in which case a 200 OK response will be generated.
74If an opt_expected_body (str or dict) is provided, it will be compared to
75the body and UnexpectedBodyError will be raised on inequality.
76
77Example:
78 response = '{&quot;data&quot;: {&quot;id&quot;: &quot;tag:google.c...'
79 requestBuilder = RequestMockBuilder(
80 {
81 'plus.activities.get': (None, response),
82 }
83 )
84 apiclient.discovery.build(&quot;plus&quot;, &quot;v1&quot;, requestBuilder=requestBuilder)
85
86Methods that you do not supply a response for will return a
87200 OK with an empty string as the response content or raise an excpetion
88if check_unexpected is set to True. The methodId is taken from the rpcName
89in the discovery document.
90
91For more details see the project wiki.
92
93</pre>
94
95<!-- ==================== INSTANCE METHODS ==================== -->
96<a name="section-InstanceMethods"></a>
97<table class="summary" border="1" cellpadding="3"
98 cellspacing="0" width="100%" bgcolor="white">
99<tr bgcolor="#70b0f0" class="table-header">
100 <td colspan="2" class="table-header">
101 <table border="0" cellpadding="0" cellspacing="0" width="100%">
102 <tr valign="top">
103 <td align="left"><span class="table-header">Instance Methods</span></td>
104 <td align="right" valign="top"
105 ><span class="options">[<a href="#section-InstanceMethods"
106 class="privatelink" onclick="toggle_private();"
107 >hide private</a>]</span></td>
108 </tr>
109 </table>
110 </td>
111</tr>
112<tr>
113 <td width="15%" align="right" valign="top" class="summary">
114 <span class="summary-type">&nbsp;</span>
115 </td><td class="summary">
116 <table width="100%" cellpadding="0" cellspacing="0" border="0">
117 <tr>
118 <td><span class="summary-sig"><a href="apiclient.http.RequestMockBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
119 <span class="summary-sig-arg">responses</span>,
120 <span class="summary-sig-arg">check_unexpected</span>=<span class="summary-sig-default">False</span>)</span><br />
121 Constructor for RequestMockBuilder</td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__init__">source&nbsp;code</a></span>
124
125 </td>
126 </tr>
127 </table>
128
129 </td>
130 </tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <td><span class="summary-sig"><a href="apiclient.http.RequestMockBuilder-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
138 <span class="summary-sig-arg">http</span>,
139 <span class="summary-sig-arg">postproc</span>,
140 <span class="summary-sig-arg">uri</span>,
141 <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>,
142 <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>,
143 <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
144 <span class="summary-sig-arg">methodId</span>=<span class="summary-sig-default">None</span>,
145 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">None</span>)</span><br />
146 Implements the callable interface that discovery.build() expects
147of requestBuilder, which is to build an object compatible with
148HttpRequest.execute().</td>
149 <td align="right" valign="top">
150 <span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__call__">source&nbsp;code</a></span>
151
152 </td>
153 </tr>
154 </table>
155
156 </td>
157 </tr>
158 <tr>
159 <td colspan="2" class="summary">
160 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
161 <code>__delattr__</code>,
162 <code>__format__</code>,
163 <code>__getattribute__</code>,
164 <code>__hash__</code>,
165 <code>__new__</code>,
166 <code>__reduce__</code>,
167 <code>__reduce_ex__</code>,
168 <code>__repr__</code>,
169 <code>__setattr__</code>,
170 <code>__sizeof__</code>,
171 <code>__str__</code>,
172 <code>__subclasshook__</code>
173 </p>
174 </td>
175 </tr>
176</table>
177<!-- ==================== PROPERTIES ==================== -->
178<a name="section-Properties"></a>
179<table class="summary" border="1" cellpadding="3"
180 cellspacing="0" width="100%" bgcolor="white">
181<tr bgcolor="#70b0f0" class="table-header">
182 <td colspan="2" class="table-header">
183 <table border="0" cellpadding="0" cellspacing="0" width="100%">
184 <tr valign="top">
185 <td align="left"><span class="table-header">Properties</span></td>
186 <td align="right" valign="top"
187 ><span class="options">[<a href="#section-Properties"
188 class="privatelink" onclick="toggle_private();"
189 >hide private</a>]</span></td>
190 </tr>
191 </table>
192 </td>
193</tr>
194 <tr>
195 <td colspan="2" class="summary">
196 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
197 <code>__class__</code>
198 </p>
199 </td>
200 </tr>
201</table>
202<!-- ==================== METHOD DETAILS ==================== -->
203<a name="section-MethodDetails"></a>
204<table class="details" border="1" cellpadding="3"
205 cellspacing="0" width="100%" bgcolor="white">
206<tr bgcolor="#70b0f0" class="table-header">
207 <td colspan="2" class="table-header">
208 <table border="0" cellpadding="0" cellspacing="0" width="100%">
209 <tr valign="top">
210 <td align="left"><span class="table-header">Method Details</span></td>
211 <td align="right" valign="top"
212 ><span class="options">[<a href="#section-MethodDetails"
213 class="privatelink" onclick="toggle_private();"
214 >hide private</a>]</span></td>
215 </tr>
216 </table>
217 </td>
218</tr>
219</table>
220<a name="__init__"></a>
221<div>
222<table class="details" border="1" cellpadding="3"
223 cellspacing="0" width="100%" bgcolor="white">
224<tr><td>
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr valign="top"><td>
227 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
228 <span class="sig-arg">responses</span>,
229 <span class="sig-arg">check_unexpected</span>=<span class="sig-default">False</span>)</span>
230 <br /><em class="fname">(Constructor)</em>
231 </h3>
232 </td><td align="right" valign="top"
233 ><span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__init__">source&nbsp;code</a></span>&nbsp;
234 </td>
235 </tr></table>
236
237 <pre class="literalblock">
238Constructor for RequestMockBuilder
239
240The constructed object should be a callable object
241that can replace the class HttpResponse.
242
243responses - A dictionary that maps methodIds into tuples
244 of (httplib2.Response, content). The methodId
245 comes from the 'rpcName' field in the discovery
246 document.
247check_unexpected - A boolean setting whether or not UnexpectedMethodError
248 should be raised on unsupplied method.
249
250</pre>
251 <dl class="fields">
252 <dt>Overrides:
253 object.__init__
254 </dt>
255 </dl>
256</td></tr></table>
257</div>
258<a name="__call__"></a>
259<div>
260<table class="details" border="1" cellpadding="3"
261 cellspacing="0" width="100%" bgcolor="white">
262<tr><td>
263 <table width="100%" cellpadding="0" cellspacing="0" border="0">
264 <tr valign="top"><td>
265 <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
266 <span class="sig-arg">http</span>,
267 <span class="sig-arg">postproc</span>,
268 <span class="sig-arg">uri</span>,
269 <span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
270 <span class="sig-arg">body</span>=<span class="sig-default">None</span>,
271 <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
272 <span class="sig-arg">methodId</span>=<span class="sig-default">None</span>,
273 <span class="sig-arg">resumable</span>=<span class="sig-default">None</span>)</span>
274 <br /><em class="fname">(Call operator)</em>
275 </h3>
276 </td><td align="right" valign="top"
277 ><span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__call__">source&nbsp;code</a></span>&nbsp;
278 </td>
279 </tr></table>
280
281 <pre class="literalblock">
282Implements the callable interface that discovery.build() expects
283of requestBuilder, which is to build an object compatible with
284HttpRequest.execute(). See that method for the description of the
285parameters and the expected response.
286
287</pre>
288 <dl class="fields">
289 </dl>
290</td></tr></table>
291</div>
292<br />
293<!-- ==================== NAVIGATION BAR ==================== -->
294<table class="navbar" border="0" width="100%" cellpadding="0"
295 bgcolor="#a0c0ff" cellspacing="0">
296 <tr valign="middle">
297
298 <!-- Tree link -->
299 <th>&nbsp;&nbsp;&nbsp;<a
300 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
301
302 <!-- Index link -->
303 <th>&nbsp;&nbsp;&nbsp;<a
304 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
305
306 <!-- Help link -->
307 <th>&nbsp;&nbsp;&nbsp;<a
308 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
309
310 <th class="navbar" width="100%"></th>
311 </tr>
312</table>
313<table border="0" cellpadding="0" cellspacing="0" width="100%%">
314 <tr>
315 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]316 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]317 </td>
318 <td align="right" class="footer">
319 <a target="mainFrame" href="http://epydoc.sourceforge.net"
320 >http://epydoc.sourceforge.net</a>
321 </td>
322 </tr>
323</table>
324
325<script type="text/javascript">
326 <!--
327 // Private objects are initially displayed (because if
328 // javascript is turned off then we want them to be
329 // visible); but by default, we want to hide them. So hide
330 // them unless we have a cookie that says to show them.
331 checkCookie();
332 // -->
333</script>
334</body>
335</html>