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.MediaIoBaseDownload</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> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </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 googleapiclient</a> :: 41 <a href="googleapiclient.http-module.html">Module http</a> :: 42 Class MediaIoBaseDownload 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 private</a>]</span></td></tr> 50 <tr><td align="right"><span class="options" 51 >[<a href="frames.html" target="_top">frames</a 52 >] | <a href="googleapiclient.http.MediaIoBaseDownload-class.html" 53 target="_top">no frames</a>]</span></td></tr> 54 </table> 55 </td> 56 </tr> 57</table> 58<!-- ==================== CLASS DESCRIPTION ==================== --> 59<h1 class="epydoc">Class MediaIoBaseDownload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload">source code</a></span></p> 60<pre class="base-tree"> 61object --+ 62 | 63 <strong class="uidshort">MediaIoBaseDownload</strong> 64</pre> 65 66<hr /> 67<pre class="literalblock"> 68"Download media resources. 69 70Note that the Python file object is compatible with io.Base and can be used 71with this class also. 72 73 74Example: 75 request = farms.animals().get_media(id='cow') 76 fh = io.FileIO('cow.png', mode='wb') 77 downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024) 78 79 done = False 80 while done is False: 81 status, done = downloader.next_chunk() 82 if status: 83 print "Download %d%%." % int(status.progress() * 100) 84 print "Download Complete!" 85 86</pre> 87 88<!-- ==================== INSTANCE METHODS ==================== --> 89<a name="section-InstanceMethods"></a> 90<table class="summary" border="1" cellpadding="3" 91 cellspacing="0" width="100%" bgcolor="white"> 92<tr bgcolor="#70b0f0" class="table-header"> 93 <td colspan="2" class="table-header"> 94 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 95 <tr valign="top"> 96 <td align="left"><span class="table-header">Instance Methods</span></td> 97 <td align="right" valign="top" 98 ><span class="options">[<a href="#section-InstanceMethods" 99 class="privatelink" onclick="toggle_private();" 100 >hide private</a>]</span></td> 101 </tr> 102 </table> 103 </td> 104</tr> 105<tr> 106 <td width="15%" align="right" valign="top" class="summary"> 107 <span class="summary-type"> </span> 108 </td><td class="summary"> 109 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 110 <tr> 111 <td><span class="summary-sig"><a href="googleapiclient.http.MediaIoBaseDownload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>, 112 <span class="summary-sig-arg">**kwargs</span>)</span><br /> 113 Constructor.</td> 114 <td align="right" valign="top"> 115 <span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload.__init__">source code</a></span> 116 117 </td> 118 </tr> 119 </table> 120 121 </td> 122 </tr> 123<tr> 124 <td width="15%" align="right" valign="top" class="summary"> 125 <span class="summary-type"> </span> 126 </td><td class="summary"> 127 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 128 <tr> 129 <td><span class="summary-sig"><a href="googleapiclient.http.MediaIoBaseDownload-class.html#next_chunk" class="summary-sig-name">next_chunk</a>(<span class="summary-sig-arg">*args</span>, 130 <span class="summary-sig-arg">**kwargs</span>)</span><br /> 131 Get the next chunk of the download.</td> 132 <td align="right" valign="top"> 133 <span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload.next_chunk">source code</a></span> 134 135 </td> 136 </tr> 137 </table> 138 139 </td> 140 </tr> 141 <tr> 142 <td colspan="2" class="summary"> 143 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 144 <code>__delattr__</code>, 145 <code>__format__</code>, 146 <code>__getattribute__</code>, 147 <code>__hash__</code>, 148 <code>__new__</code>, 149 <code>__reduce__</code>, 150 <code>__reduce_ex__</code>, 151 <code>__repr__</code>, 152 <code>__setattr__</code>, 153 <code>__sizeof__</code>, 154 <code>__str__</code>, 155 <code>__subclasshook__</code> 156 </p> 157 </td> 158 </tr> 159</table> 160<!-- ==================== PROPERTIES ==================== --> 161<a name="section-Properties"></a> 162<table class="summary" border="1" cellpadding="3" 163 cellspacing="0" width="100%" bgcolor="white"> 164<tr bgcolor="#70b0f0" class="table-header"> 165 <td colspan="2" class="table-header"> 166 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 167 <tr valign="top"> 168 <td align="left"><span class="table-header">Properties</span></td> 169 <td align="right" valign="top" 170 ><span class="options">[<a href="#section-Properties" 171 class="privatelink" onclick="toggle_private();" 172 >hide private</a>]</span></td> 173 </tr> 174 </table> 175 </td> 176</tr> 177 <tr> 178 <td colspan="2" class="summary"> 179 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 180 <code>__class__</code> 181 </p> 182 </td> 183 </tr> 184</table> 185<!-- ==================== METHOD DETAILS ==================== --> 186<a name="section-MethodDetails"></a> 187<table class="details" border="1" cellpadding="3" 188 cellspacing="0" width="100%" bgcolor="white"> 189<tr bgcolor="#70b0f0" class="table-header"> 190 <td colspan="2" class="table-header"> 191 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 192 <tr valign="top"> 193 <td align="left"><span class="table-header">Method Details</span></td> 194 <td align="right" valign="top" 195 ><span class="options">[<a href="#section-MethodDetails" 196 class="privatelink" onclick="toggle_private();" 197 >hide private</a>]</span></td> 198 </tr> 199 </table> 200 </td> 201</tr> 202</table> 203<a name="__init__"></a> 204<div> 205<table class="details" border="1" cellpadding="3" 206 cellspacing="0" width="100%" bgcolor="white"> 207<tr><td> 208 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 209 <tr valign="top"><td> 210 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>, 211 <span class="sig-arg">**kwargs</span>)</span> 212 <br /><em class="fname">(Constructor)</em> 213 </h3> 214 </td><td align="right" valign="top" 215 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload.__init__">source code</a></span> 216 </td> 217 </tr></table> 218 219 <pre class="literalblock"> 220Constructor. 221 222Args: 223 fd: io.Base or file object, The stream in which to write the downloaded 224 bytes. 225 request: googleapiclient.http.HttpRequest, the media request to perform in 226 chunks. 227 chunksize: int, File will be downloaded in chunks of this many bytes. 228 229</pre> 230 <dl class="fields"> 231 <dt>Decorators:</dt> 232 <dd><ul class="nomargin-top"> 233 <li><code>@util.positional(3)</code></li> 234 </ul></dd> 235 <dt>Overrides: 236 object.__init__ 237 </dt> 238 </dl> 239</td></tr></table> 240</div> 241<a name="next_chunk"></a> 242<div> 243<table class="details" border="1" cellpadding="3" 244 cellspacing="0" width="100%" bgcolor="white"> 245<tr><td> 246 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 247 <tr valign="top"><td> 248 <h3 class="epydoc"><span class="sig"><span class="sig-name">next_chunk</span>(<span class="sig-arg">*args</span>, 249 <span class="sig-arg">**kwargs</span>)</span> 250 </h3> 251 </td><td align="right" valign="top" 252 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaIoBaseDownload.next_chunk">source code</a></span> 253 </td> 254 </tr></table> 255 256 <pre class="literalblock"> 257Get the next chunk of the download. 258 259Args: 260 num_retries: Integer, number of times to retry with randomized 261 exponential backoff. If all retries fail, the raised HttpError 262 represents the last request. If zero (default), we attempt the 263 request only once. 264 265Returns: 266 (status, done): (MediaDownloadProgress, boolean) 267 The value of 'done' will be True when the media has been fully 268 downloaded or the total size of the media is unknown. 269 270Raises: 271 googleapiclient.errors.HttpError if the response was not a 2xx. 272 httplib2.HttpLib2Error if a transport error has occurred. 273 274</pre> 275 <dl class="fields"> 276 <dt>Decorators:</dt> 277 <dd><ul class="nomargin-top"> 278 <li><code>@util.positional(1)</code></li> 279 </ul></dd> 280 </dl> 281</td></tr></table> 282</div> 283<br /> 284<!-- ==================== NAVIGATION BAR ==================== --> 285<table class="navbar" border="0" width="100%" cellpadding="0" 286 bgcolor="#a0c0ff" cellspacing="0"> 287 <tr valign="middle"> 288 <!-- Home link --> 289 <th> <a 290 href="googleapiclient-module.html">Home</a> </th> 291 292 <!-- Tree link --> 293 <th> <a 294 href="module-tree.html">Trees</a> </th> 295 296 <!-- Index link --> 297 <th> <a 298 href="identifier-index.html">Indices</a> </th> 299 300 <!-- Help link --> 301 <th> <a 302 href="help.html">Help</a> </th> 303 304 <th class="navbar" width="100%"></th> 305 </tr> 306</table> 307<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 308 <tr> 309 <td align="left" class="footer"> 310 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 311 </td> 312 <td align="right" class="footer"> 313 <a target="mainFrame" href="http://epydoc.sourceforge.net" 314 >http://epydoc.sourceforge.net</a> 315 </td> 316 </tr> 317</table> 318 319<script type="text/javascript"> 320 <!-- 321 // Private objects are initially displayed (because if 322 // javascript is turned off then we want them to be 323 // visible); but by default, we want to hide them. So hide 324 // them unless we have a cookie that says to show them. 325 checkCookie(); 326 // --> 327</script> 328</body> 329</html> 330
