Refresh docs
diff --git a/docs/epy/apiclient.http.MediaFileUpload-class.html b/docs/epy/apiclient.http.MediaFileUpload-class.html
index af48840..ba73d1e 100644
--- a/docs/epy/apiclient.http.MediaFileUpload-class.html
+++ b/docs/epy/apiclient.http.MediaFileUpload-class.html
@@ -56,8 +56,9 @@
<h1 class="epydoc">Class MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload">source code</a></span></p>
<center>
<center> <map id="class_hierarchy_for_mediafileu" name="class_hierarchy_for_mediafileu">
-<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,61,123,88"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="16,5,112,32"/>
+<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="15,117,132,144"/>
+<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="5,61,141,88"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="25,5,121,32"/>
</map>
<img src="class_hierarchy_for_mediafileu.gif" alt='' usemap="#class_hierarchy_for_mediafileu" ismap="ismap" class="graph-without-title" />
</center>
@@ -72,11 +73,19 @@
media = MediaFileUpload('cow.png', mimetype='image/png',
chunksize=1024*1024, resumable=True)
- farm.animals()..insert(
+ farm.animals().insert(
id='cow',
name='cow.png',
media_body=media).execute()
+Depending on the platform you are working on, you may pass -1 as the
+chunksize, which indicates that the entire file should be uploaded in a single
+request. If the underlying platform supports streams, such as Python 2.6 or
+later, then this can be very efficient as it avoids multiple connections, and
+also avoids loading the entire file into memory before sending it. Note that
+Google App Engine has a 5MB limit on request size, so you should never set
+your chunksize larger than 5MB, or to -1.
+
</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
@@ -102,101 +111,11 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">filename</span>,
- <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
- <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
+ <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
+ <span class="summary-sig-arg">**kwargs</span>)</span><br />
Constructor.</td>
<td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Chunk size for resumable uploads.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Mime type of the body.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Size of upload.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Whether this upload is resumable.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">begin</span>,
- <span class="summary-sig-arg">length</span>)</span><br />
- Get bytes from the media.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span>
+ <span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
</td>
</tr>
@@ -223,6 +142,15 @@
</tr>
<tr>
<td colspan="2" class="summary">
+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a></code></b>:
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream">has_stream</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#size">size</a></code>,
+ <code><a href="apiclient.http.MediaIoBaseUpload-class.html#stream">stream</a></code>
+ </p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
<code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
</p></div>
@@ -352,15 +280,12 @@
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">filename</span>,
- <span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
- <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
+ <span class="sig-arg">**kwargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span>
+ ><span class="codelink"><a href="oauth2client.util-pysrc.html">source code</a></span>
</td>
</tr></table>
@@ -372,165 +297,25 @@
mimetype: string, Mime-type of the file. If None then a mime-type will be
guessed from the file extension.
chunksize: int, File will be uploaded in chunks of this many bytes. Only
- used if resumable=True.
+ used if resumable=True. Pass in a value of -1 if the file is to be
+ uploaded in a single chunk. Note that Google App Engine has a 5MB limit
+ on request size, so you should never set your chunksize larger than 5MB,
+ or to -1.
resumable: bool, True if this is a resumable upload. False means upload
in a single request.
</pre>
<dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(2)</code></li>
+ </ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
-<a name="chunksize"></a>
-<div>
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
-Chunk size for resumable uploads.
-
-Returns:
- Chunk size in bytes.
-
-</pre>
- <dl class="fields">
- <dt>Overrides:
- <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
- </dt>
- </dl>
-</td></tr></table>
-</div>
-<a name="mimetype"></a>
-<div>
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
-Mime type of the body.
-
-Returns:
- Mime type.
-
-</pre>
- <dl class="fields">
- <dt>Overrides:
- <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
- </dt>
- </dl>
-</td></tr></table>
-</div>
-<a name="size"></a>
-<div>
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
-Size of upload.
-
-Returns:
- Size of the body, or None of the size is unknown.
-
-</pre>
- <dl class="fields">
- <dt>Overrides:
- <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
- </dt>
- </dl>
-</td></tr></table>
-</div>
-<a name="resumable"></a>
-<div>
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
-Whether this upload is resumable.
-
-Returns:
- True if resumable upload or False.
-
-</pre>
- <dl class="fields">
- <dt>Overrides:
- <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
- </dt>
- </dl>
-</td></tr></table>
-</div>
-<a name="getbytes"></a>
-<div>
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">begin</span>,
- <span class="sig-arg">length</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span>
- </td>
- </tr></table>
-
- <pre class="literalblock">
-Get bytes from the media.
-
-Args:
- begin: int, offset from beginning of file.
- length: int, number of bytes to read, starting at begin.
-
-Returns:
- A string of bytes read. May be shorted than length if EOF was reached
- first.
-
-</pre>
- <dl class="fields">
- <dt>Overrides:
- <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
- </dt>
- </dl>
-</td></tr></table>
-</div>
<a name="to_json"></a>
<div>
<table class="details" border="1" cellpadding="3"
@@ -584,7 +369,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:26 2012
+ Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:02 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"