imported patch docs
diff --git a/docs/epy/apiclient.http.MediaUpload-class.html b/docs/epy/apiclient.http.MediaUpload-class.html
index d798223..852682f 100644
--- a/docs/epy/apiclient.http.MediaUpload-class.html
+++ b/docs/epy/apiclient.http.MediaUpload-class.html
@@ -55,19 +55,20 @@
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MediaUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload">source code</a></span></p>
<center>
-<center> <map id="uml_class_diagram_for_apiclien_19" name="uml_class_diagram_for_apiclien_19">
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#getbytes" title="apiclient.http.MediaUpload.getbytes" alt="" coords="84,36,236,55"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#size" title="apiclient.http.MediaUpload.size" alt="" coords="84,55,236,73"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#chunksize" title="apiclient.http.MediaUpload.chunksize" alt="" coords="84,73,236,92"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#mimetype" title="apiclient.http.MediaUpload.mimetype" alt="" coords="84,92,236,111"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#resumable" title="apiclient.http.MediaUpload.resumable" alt="" coords="84,111,236,129"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#to_json" title="Create a JSON representation of an instance of MediaUpload." alt="" coords="84,129,236,148"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="84,148,236,167"/>
-<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="83,11,237,168"/>
+<center> <map id="uml_class_diagram_for_apiclien_20" name="uml_class_diagram_for_apiclien_20">
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="173,36,325,55"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="173,55,325,73"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#size" title="Size of upload." alt="" coords="173,73,325,92"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="173,92,325,111"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="173,111,325,129"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#to_json" title="Create a JSON representation of an instance of MediaUpload." alt="" coords="173,129,325,148"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="173,148,325,167"/>
+<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="172,11,327,168"/>
<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="16,197,125,224"/>
<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaUpload for a chunk of bytes." alt="" coords="176,197,323,224"/>
+<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="373,197,501,224"/>
</map>
- <img src="uml_class_diagram_for_apiclien_19.gif" alt='' usemap="#uml_class_diagram_for_apiclien_19" ismap="ismap" class="graph-without-title" />
+ <img src="uml_class_diagram_for_apiclien_20.gif" alt='' usemap="#uml_class_diagram_for_apiclien_20" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
@@ -76,6 +77,13 @@
Base class that defines the interface of MediaUpload subclasses.
+Note that subclasses of MediaUpload may allow you to control the chunksize
+when upload a media object. It is important to keep the size of the chunk as
+large as possible to keep the upload efficient. Other factors may influence
+the size of the chunk you use, particularly if you are working in an
+environment where individual HTTP requests may have a hardcoded time limit,
+such as under certain classes of requests under Google App Engine.
+
</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
@@ -101,41 +109,8 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="getbytes"></a><span class="summary-sig-name">getbytes</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">begin</span>,
- <span class="summary-sig-arg">end</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.getbytes">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 name="size"></a><span class="summary-sig-name">size</span>(<span class="summary-sig-arg">self</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.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 name="chunksize"></a><span class="summary-sig-name">chunksize</span>(<span class="summary-sig-arg">self</span>)</span></td>
+ <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-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#MediaUpload.chunksize">source code</a></span>
@@ -151,7 +126,8 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="mimetype"></a><span class="summary-sig-name">mimetype</span>(<span class="summary-sig-arg">self</span>)</span></td>
+ <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-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#MediaUpload.mimetype">source code</a></span>
@@ -167,7 +143,25 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="resumable"></a><span class="summary-sig-name">resumable</span>(<span class="summary-sig-arg">self</span>)</span></td>
+ <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-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#MediaUpload.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.MediaUpload-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#MediaUpload.resumable">source code</a></span>
@@ -177,6 +171,25 @@
</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.MediaUpload-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">end</span>)</span><br />
+ Get bytes from the media.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.getbytes">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
@@ -312,6 +325,138 @@
</td>
</tr>
</table>
+<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#MediaUpload.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">
+ </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#MediaUpload.mimetype">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Mime type of the body.
+
+Returns:
+ Mime type.
+
+</pre>
+ <dl class="fields">
+ </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#MediaUpload.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">
+ </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#MediaUpload.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">
+ </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">end</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.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 shorter than length if EOF was reached
+ first.
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
<a name="_to_json"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -424,7 +569,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012
+ Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"