Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / epy / apiclient.http._StreamSlice-class.html
blob: c8ff37255291ff11b9feb0b3219000be724c18b9 [file] [log] [blame]
Joe Gregorio1b425aa2012-08-24 12:04:34 -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._StreamSlice</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;_StreamSlice
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._StreamSlice-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 _StreamSlice</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_apiclien_32" name="uml_class_diagram_for_apiclien_32">
59<area shape="rect" id="node79" href="apiclient.http._StreamSlice-class.html#__init__" title="Constructor." alt="" coords="17,39,253,57"/>
60<area shape="rect" id="node79" href="apiclient.http._StreamSlice-class.html#read" title="Read n bytes." alt="" coords="17,57,253,76"/>
61<area shape="rect" id="node1" href="apiclient.http._StreamSlice-class.html" title="Truncated stream." alt="" coords="5,6,264,82"/>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]62</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]63 <img src="uml_class_diagram_for_apiclien_32.gif" alt='' usemap="#uml_class_diagram_for_apiclien_32" ismap="ismap" class="graph-without-title" />
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68Truncated stream.
69
70Takes a stream and presents a stream that is a slice of the original stream.
71This is used when uploading media in chunks. In later versions of Python a
72stream can be passed to httplib in place of the string of data to send. The
73problem is that httplib just blindly reads to the end of the stream. This
74wrapper presents a virtual stream that only reads to the end of the chunk.
75
76</pre>
77
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81 cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83 <td colspan="2" class="table-header">
84 <table border="0" cellpadding="0" cellspacing="0" width="100%">
85 <tr valign="top">
86 <td align="left"><span class="table-header">Instance Methods</span></td>
87 <td align="right" valign="top"
88 ><span class="options">[<a href="#section-InstanceMethods"
89 class="privatelink" onclick="toggle_private();"
90 >hide private</a>]</span></td>
91 </tr>
92 </table>
93 </td>
94</tr>
95<tr>
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <table width="100%" cellpadding="0" cellspacing="0" border="0">
100 <tr>
101 <td><span class="summary-sig"><a href="apiclient.http._StreamSlice-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
102 <span class="summary-sig-arg">stream</span>,
103 <span class="summary-sig-arg">begin</span>,
104 <span class="summary-sig-arg">chunksize</span>)</span><br />
105 Constructor.</td>
106 <td align="right" valign="top">
107 <span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.__init__">source&nbsp;code</a></span>
108
109 </td>
110 </tr>
111 </table>
112
113 </td>
114 </tr>
115<tr>
116 <td width="15%" align="right" valign="top" class="summary">
117 <span class="summary-type">&nbsp;</span>
118 </td><td class="summary">
119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
120 <tr>
121 <td><span class="summary-sig"><a href="apiclient.http._StreamSlice-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>,
122 <span class="summary-sig-arg">n</span>=<span class="summary-sig-default">-1</span>)</span><br />
123 Read n bytes.</td>
124 <td align="right" valign="top">
125 <span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.read">source&nbsp;code</a></span>
126
127 </td>
128 </tr>
129 </table>
130
131 </td>
132 </tr>
133 <tr>
134 <td colspan="2" class="summary">
135 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
136 <code>__delattr__</code>,
137 <code>__format__</code>,
138 <code>__getattribute__</code>,
139 <code>__hash__</code>,
140 <code>__new__</code>,
141 <code>__reduce__</code>,
142 <code>__reduce_ex__</code>,
143 <code>__repr__</code>,
144 <code>__setattr__</code>,
145 <code>__sizeof__</code>,
146 <code>__str__</code>,
147 <code>__subclasshook__</code>
148 </p>
149 </td>
150 </tr>
151</table>
152<!-- ==================== PROPERTIES ==================== -->
153<a name="section-Properties"></a>
154<table class="summary" border="1" cellpadding="3"
155 cellspacing="0" width="100%" bgcolor="white">
156<tr bgcolor="#70b0f0" class="table-header">
157 <td colspan="2" class="table-header">
158 <table border="0" cellpadding="0" cellspacing="0" width="100%">
159 <tr valign="top">
160 <td align="left"><span class="table-header">Properties</span></td>
161 <td align="right" valign="top"
162 ><span class="options">[<a href="#section-Properties"
163 class="privatelink" onclick="toggle_private();"
164 >hide private</a>]</span></td>
165 </tr>
166 </table>
167 </td>
168</tr>
169 <tr>
170 <td colspan="2" class="summary">
171 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
172 <code>__class__</code>
173 </p>
174 </td>
175 </tr>
176</table>
177<!-- ==================== METHOD DETAILS ==================== -->
178<a name="section-MethodDetails"></a>
179<table class="details" 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">Method Details</span></td>
186 <td align="right" valign="top"
187 ><span class="options">[<a href="#section-MethodDetails"
188 class="privatelink" onclick="toggle_private();"
189 >hide private</a>]</span></td>
190 </tr>
191 </table>
192 </td>
193</tr>
194</table>
195<a name="__init__"></a>
196<div>
197<table class="details" border="1" cellpadding="3"
198 cellspacing="0" width="100%" bgcolor="white">
199<tr><td>
200 <table width="100%" cellpadding="0" cellspacing="0" border="0">
201 <tr valign="top"><td>
202 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
203 <span class="sig-arg">stream</span>,
204 <span class="sig-arg">begin</span>,
205 <span class="sig-arg">chunksize</span>)</span>
206 <br /><em class="fname">(Constructor)</em>
207 </h3>
208 </td><td align="right" valign="top"
209 ><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.__init__">source&nbsp;code</a></span>&nbsp;
210 </td>
211 </tr></table>
212
213 <pre class="literalblock">
214Constructor.
215
216Args:
217 stream: (io.Base, file object), the stream to wrap.
218 begin: int, the seek position the chunk begins at.
219 chunksize: int, the size of the chunk.
220
221</pre>
222 <dl class="fields">
223 <dt>Overrides:
224 object.__init__
225 </dt>
226 </dl>
227</td></tr></table>
228</div>
229<a name="read"></a>
230<div>
231<table class="details" border="1" cellpadding="3"
232 cellspacing="0" width="100%" bgcolor="white">
233<tr><td>
234 <table width="100%" cellpadding="0" cellspacing="0" border="0">
235 <tr valign="top"><td>
236 <h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>,
237 <span class="sig-arg">n</span>=<span class="sig-default">-1</span>)</span>
238 </h3>
239 </td><td align="right" valign="top"
240 ><span class="codelink"><a href="apiclient.http-pysrc.html#_StreamSlice.read">source&nbsp;code</a></span>&nbsp;
241 </td>
242 </tr></table>
243
244 <pre class="literalblock">
245Read n bytes.
246
247Args:
248 n, int, the number of bytes to read.
249
250Returns:
251 A string of length 'n', or less if EOF is reached.
252
253</pre>
254 <dl class="fields">
255 </dl>
256</td></tr></table>
257</div>
258<br />
259<!-- ==================== NAVIGATION BAR ==================== -->
260<table class="navbar" border="0" width="100%" cellpadding="0"
261 bgcolor="#a0c0ff" cellspacing="0">
262 <tr valign="middle">
263
264 <!-- Tree link -->
265 <th>&nbsp;&nbsp;&nbsp;<a
266 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
267
268 <!-- Index link -->
269 <th>&nbsp;&nbsp;&nbsp;<a
270 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
271
272 <!-- Help link -->
273 <th>&nbsp;&nbsp;&nbsp;<a
274 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
275
276 <th class="navbar" width="100%"></th>
277 </tr>
278</table>
279<table border="0" cellpadding="0" cellspacing="0" width="100%%">
280 <tr>
281 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]282 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]283 </td>
284 <td align="right" class="footer">
285 <a target="mainFrame" href="http://epydoc.sourceforge.net"
286 >http://epydoc.sourceforge.net</a>
287 </td>
288 </tr>
289</table>
290
291<script type="text/javascript">
292 <!--
293 // Private objects are initially displayed (because if
294 // javascript is turned off then we want them to be
295 // visible); but by default, we want to hide them. So hide
296 // them unless we have a cookie that says to show them.
297 checkCookie();
298 // -->
299</script>
300</body>
301</html>