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