| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -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</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> <a |
| 20 | href="module-tree.html">Trees</a> </th> |
| 21 | |
| 22 | <!-- Index link --> |
| 23 | <th> <a |
| 24 | href="identifier-index.html">Indices</a> </th> |
| 25 | |
| 26 | <!-- Help link --> |
| 27 | <th> <a |
| 28 | href="help.html">Help</a> </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 apiclient</a> :: |
| 38 | Module http |
| 39 | </span> |
| 40 | </td> |
| 41 | <td> |
| 42 | <table cellpadding="0" cellspacing="0"> |
| 43 | <!-- hide/show private --> |
| 44 | <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| 45 | onclick="toggle_private();">hide private</a>]</span></td></tr> |
| 46 | <tr><td align="right"><span class="options" |
| 47 | >[<a href="frames.html" target="_top">frames</a |
| 48 | >] | <a href="apiclient.http-pysrc.html" |
| 49 | target="_top">no frames</a>]</span></td></tr> |
| 50 | </table> |
| 51 | </td> |
| 52 | </tr> |
| 53 | </table> |
| 54 | <h1 class="epydoc">Source Code for <a href="apiclient.http-module.html">Module apiclient.http</a></h1> |
| 55 | <pre class="py-src"> |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 56 | <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2012 Google Inc.</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 57 | <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| 58 | <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt> |
| 59 | <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt> |
| 60 | <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt> |
| 61 | <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| 62 | <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># http://www.apache.org/licenses/LICENSE-2.0</tt> </tt> |
| 63 | <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| 64 | <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt> |
| 65 | <a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt> |
| 66 | <a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt> |
| 67 | <a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt> |
| 68 | <a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt> |
| 69 | <a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt> |
| 70 | <a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">"""Classes to encapsulate a single HTTP request.</tt> </tt> |
| 71 | <a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 72 | <a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">The classes implement a command pattern, with every</tt> </tt> |
| 73 | <a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">object supporting an execute() method that does the</tt> </tt> |
| 74 | <a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">actuall HTTP request.</tt> </tt> |
| 75 | <a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt> |
| 76 | <a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt> |
| 77 | <a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'jcgregorio@google.com (Joe Gregorio)'</tt> </tt> |
| 78 | <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt> |
| 79 | <a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">StringIO</tt> </tt> |
| 80 | <a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">base64</tt> </tt> |
| 81 | <a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">copy</tt> </tt> |
| 82 | <a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">gzip</tt> </tt> |
| 83 | <a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">httplib2</tt> </tt> |
| 84 | <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module apiclient.mimeparse=apiclient.mimeparse-module.html"><a title="apiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-0', 'mimeparse', 'link-0');">mimeparse</a></tt> </tt> |
| 85 | <a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">mimetypes</tt> </tt> |
| 86 | <a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt> |
| 87 | <a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt> |
| 88 | <a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urlparse</tt> </tt> |
| 89 | <a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">uuid</tt> </tt> |
| 90 | <a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> </tt> |
| 91 | <a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">email</tt><tt class="py-op">.</tt><tt class="py-name">generator</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Generator</tt> </tt> |
| 92 | <a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">email</tt><tt class="py-op">.</tt><tt class="py-name">mime</tt><tt class="py-op">.</tt><tt class="py-name">multipart</tt> <tt class="py-keyword">import</tt> <tt class="py-name">MIMEMultipart</tt> </tt> |
| 93 | <a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">email</tt><tt class="py-op">.</tt><tt class="py-name">mime</tt><tt class="py-op">.</tt><tt class="py-name">nonmultipart</tt> <tt class="py-keyword">import</tt> <tt class="py-name">MIMENonMultipart</tt> </tt> |
| 94 | <a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">email</tt><tt class="py-op">.</tt><tt class="py-name">parser</tt> <tt class="py-keyword">import</tt> <tt class="py-name">FeedParser</tt> </tt> |
| 95 | <a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Module apiclient.errors=apiclient.errors-module.html"><a title="apiclient.errors" class="py-name" href="#" onclick="return doclink('link-1', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Class apiclient.errors.BatchError=apiclient.errors.BatchError-class.html"><a title="apiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-2', 'BatchError', 'link-2');">BatchError</a></tt> </tt> |
| 96 | <a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="apiclient.errors" class="py-name" href="#" onclick="return doclink('link-3', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-4" class="py-name" targets="Class apiclient.errors.HttpError=apiclient.errors.HttpError-class.html"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-4', 'HttpError', 'link-4');">HttpError</a></tt> </tt> |
| 97 | <a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="apiclient.errors" class="py-name" href="#" onclick="return doclink('link-5', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-6" class="py-name" targets="Class apiclient.errors.ResumableUploadError=apiclient.errors.ResumableUploadError-class.html"><a title="apiclient.errors.ResumableUploadError" class="py-name" href="#" onclick="return doclink('link-6', 'ResumableUploadError', 'link-6');">ResumableUploadError</a></tt> </tt> |
| 98 | <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-7" class="py-name"><a title="apiclient.errors" class="py-name" href="#" onclick="return doclink('link-7', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Class apiclient.errors.UnexpectedBodyError=apiclient.errors.UnexpectedBodyError-class.html"><a title="apiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-8', 'UnexpectedBodyError', 'link-8');">UnexpectedBodyError</a></tt> </tt> |
| 99 | <a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-9" class="py-name"><a title="apiclient.errors" class="py-name" href="#" onclick="return doclink('link-9', 'errors', 'link-1');">errors</a></tt> <tt class="py-keyword">import</tt> <tt id="link-10" class="py-name" targets="Class apiclient.errors.UnexpectedMethodError=apiclient.errors.UnexpectedMethodError-class.html"><a title="apiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-10', 'UnexpectedMethodError', 'link-10');">UnexpectedMethodError</a></tt> </tt> |
| 100 | <a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-11" class="py-name" targets="Module apiclient.model=apiclient.model-module.html"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-11', 'model', 'link-11');">model</a></tt> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Class apiclient.model.JsonModel=apiclient.model.JsonModel-class.html"><a title="apiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-12', 'JsonModel', 'link-12');">JsonModel</a></tt> </tt> |
| 101 | <a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-13" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-13', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-14', 'anyjson', 'link-14');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt> |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 102 | <a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 103 | <a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 104 | <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt id="link-15" class="py-name" targets="Variable apiclient.http.DEFAULT_CHUNK_SIZE=apiclient.http-module.html#DEFAULT_CHUNK_SIZE"><a title="apiclient.http.DEFAULT_CHUNK_SIZE" class="py-name" href="#" onclick="return doclink('link-15', 'DEFAULT_CHUNK_SIZE', 'link-15');">DEFAULT_CHUNK_SIZE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">512</tt><tt class="py-op">*</tt><tt class="py-number">1024</tt> </tt> |
| 105 | <a name="MediaUploadProgress"></a><div id="MediaUploadProgress-def"><a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 106 | <a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 107 | <a name="L52"></a><tt class="py-lineno"> 52</tt> <a class="py-toggle" href="#" id="MediaUploadProgress-toggle" onclick="return toggle('MediaUploadProgress');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaUploadProgress-class.html">MediaUploadProgress</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 108 | </div><div id="MediaUploadProgress-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaUploadProgress-expanded"><a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-docstring">"""Status of a resumable upload."""</tt> </tt> |
| 109 | <a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt> |
| 110 | <a name="MediaUploadProgress.__init__"></a><div id="MediaUploadProgress.__init__-def"><a name="L55"></a><tt class="py-lineno"> 55</tt> <a class="py-toggle" href="#" id="MediaUploadProgress.__init__-toggle" onclick="return toggle('MediaUploadProgress.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUploadProgress-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resumable_progress</tt><tt class="py-op">,</tt> <tt class="py-param">total_size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 111 | </div><div id="MediaUploadProgress.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUploadProgress.__init__-expanded"><a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt> |
| 112 | <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 113 | <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 114 | <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> resumable_progress: int, bytes sent so far.</tt> </tt> |
| 115 | <a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> total_size: int, total bytes in complete upload, or None if the total</tt> </tt> |
| 116 | <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> upload size isn't known ahead of time.</tt> </tt> |
| 117 | <a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 118 | <a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">=</tt> <tt class="py-name">resumable_progress</tt> </tt> |
| 119 | <a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt> <tt class="py-op">=</tt> <tt class="py-name">total_size</tt> </tt> |
| 120 | </div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt> |
| 121 | <a name="MediaUploadProgress.progress"></a><div id="MediaUploadProgress.progress-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="MediaUploadProgress.progress-toggle" onclick="return toggle('MediaUploadProgress.progress');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUploadProgress-class.html#progress">progress</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 122 | </div><div id="MediaUploadProgress.progress-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUploadProgress.progress-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-docstring">"""Percent of upload completed, as a float.</tt> </tt> |
| 123 | <a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 124 | <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 125 | <a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> the percentage complete as a float, returning 0.0 if the total size of</tt> </tt> |
| 126 | <a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> the upload is unknown.</tt> </tt> |
| 127 | <a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 128 | <a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 129 | <a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt><tt class="py-op">)</tt> </tt> |
| 130 | <a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 131 | <a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0.0</tt> </tt> |
| 132 | </div></div><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 133 | <a name="MediaDownloadProgress"></a><div id="MediaDownloadProgress-def"><a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> </tt> |
| 134 | <a name="L79"></a><tt class="py-lineno"> 79</tt> <a class="py-toggle" href="#" id="MediaDownloadProgress-toggle" onclick="return toggle('MediaDownloadProgress');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaDownloadProgress-class.html">MediaDownloadProgress</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 135 | </div><div id="MediaDownloadProgress-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaDownloadProgress-expanded"><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-docstring">"""Status of a resumable download."""</tt> </tt> |
| 136 | <a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt> |
| 137 | <a name="MediaDownloadProgress.__init__"></a><div id="MediaDownloadProgress.__init__-def"><a name="L82"></a><tt class="py-lineno"> 82</tt> <a class="py-toggle" href="#" id="MediaDownloadProgress.__init__-toggle" onclick="return toggle('MediaDownloadProgress.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaDownloadProgress-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resumable_progress</tt><tt class="py-op">,</tt> <tt class="py-param">total_size</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 138 | </div><div id="MediaDownloadProgress.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaDownloadProgress.__init__-expanded"><a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt> |
| 139 | <a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 140 | <a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 141 | <a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> resumable_progress: int, bytes received so far.</tt> </tt> |
| 142 | <a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> total_size: int, total bytes in complete download.</tt> </tt> |
| 143 | <a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 144 | <a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">=</tt> <tt class="py-name">resumable_progress</tt> </tt> |
| 145 | <a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt> <tt class="py-op">=</tt> <tt class="py-name">total_size</tt> </tt> |
| 146 | </div><a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt> |
| 147 | <a name="MediaDownloadProgress.progress"></a><div id="MediaDownloadProgress.progress-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="MediaDownloadProgress.progress-toggle" onclick="return toggle('MediaDownloadProgress.progress');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaDownloadProgress-class.html#progress">progress</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 148 | </div><div id="MediaDownloadProgress.progress-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaDownloadProgress.progress-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-docstring">"""Percent of download completed, as a float.</tt> </tt> |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 149 | <a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 150 | <a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 151 | <a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> the percentage complete as a float, returning 0.0 if the total size of</tt> </tt> |
| 152 | <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> the download is unknown.</tt> </tt> |
| 153 | <a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 154 | <a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 155 | <a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt><tt class="py-op">)</tt> <tt class="py-op">/</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size</tt><tt class="py-op">)</tt> </tt> |
| 156 | <a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 157 | <a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-number">0.0</tt> </tt> |
| 158 | </div></div><a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> </tt> |
| 159 | <a name="MediaUpload"></a><div id="MediaUpload-def"><a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> </tt> |
| 160 | <a name="L105"></a><tt class="py-lineno"> 105</tt> <a class="py-toggle" href="#" id="MediaUpload-toggle" onclick="return toggle('MediaUpload');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html">MediaUpload</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 161 | </div><div id="MediaUpload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaUpload-expanded"><a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-docstring">"""Describes a media object to upload.</tt> </tt> |
| 162 | <a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 163 | <a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-docstring"> Base class that defines the interface of MediaUpload subclasses.</tt> </tt> |
| 164 | <a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 165 | <a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-docstring"> Note that subclasses of MediaUpload may allow you to control the chunksize</tt> </tt> |
| 166 | <a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-docstring"> when upload a media object. It is important to keep the size of the chunk as</tt> </tt> |
| 167 | <a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-docstring"> large as possible to keep the upload efficient. Other factors may influence</tt> </tt> |
| 168 | <a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-docstring"> the size of the chunk you use, particularly if you are working in an</tt> </tt> |
| 169 | <a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-docstring"> environment where individual HTTP requests may have a hardcoded time limit,</tt> </tt> |
| 170 | <a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-docstring"> such as under certain classes of requests under Google App Engine.</tt> </tt> |
| 171 | <a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 172 | <a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> </tt> |
| 173 | <a name="MediaUpload.chunksize"></a><div id="MediaUpload.chunksize-def"><a name="L118"></a><tt class="py-lineno"> 118</tt> <a class="py-toggle" href="#" id="MediaUpload.chunksize-toggle" onclick="return toggle('MediaUpload.chunksize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#chunksize">chunksize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 174 | </div><div id="MediaUpload.chunksize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.chunksize-expanded"><a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-docstring">"""Chunk size for resumable uploads.</tt> </tt> |
| 175 | <a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 176 | <a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 177 | <a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> Chunk size in bytes.</tt> </tt> |
| 178 | <a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 179 | <a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 180 | </div><a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> </tt> |
| 181 | <a name="MediaUpload.mimetype"></a><div id="MediaUpload.mimetype-def"><a name="L126"></a><tt class="py-lineno"> 126</tt> <a class="py-toggle" href="#" id="MediaUpload.mimetype-toggle" onclick="return toggle('MediaUpload.mimetype');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#mimetype">mimetype</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 182 | </div><div id="MediaUpload.mimetype-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.mimetype-expanded"><a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> <tt class="py-docstring">"""Mime type of the body.</tt> </tt> |
| 183 | <a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 184 | <a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 185 | <a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-docstring"> Mime type.</tt> </tt> |
| 186 | <a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 187 | <a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'application/octet-stream'</tt> </tt> |
| 188 | </div><a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> </tt> |
| 189 | <a name="MediaUpload.size"></a><div id="MediaUpload.size-def"><a name="L134"></a><tt class="py-lineno"> 134</tt> <a class="py-toggle" href="#" id="MediaUpload.size-toggle" onclick="return toggle('MediaUpload.size');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#size">size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 190 | </div><div id="MediaUpload.size-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.size-expanded"><a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-docstring">"""Size of upload.</tt> </tt> |
| 191 | <a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 192 | <a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 193 | <a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-docstring"> Size of the body, or None of the size is unknown.</tt> </tt> |
| 194 | <a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 195 | <a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> |
| 196 | </div><a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> </tt> |
| 197 | <a name="MediaUpload.resumable"></a><div id="MediaUpload.resumable-def"><a name="L142"></a><tt class="py-lineno"> 142</tt> <a class="py-toggle" href="#" id="MediaUpload.resumable-toggle" onclick="return toggle('MediaUpload.resumable');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#resumable">resumable</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 198 | </div><div id="MediaUpload.resumable-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.resumable-expanded"><a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt class="py-docstring">"""Whether this upload is resumable.</tt> </tt> |
| 199 | <a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 200 | <a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 201 | <a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-docstring"> True if resumable upload or False.</tt> </tt> |
| 202 | <a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 203 | <a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt> |
| 204 | </div><a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> </tt> |
| 205 | <a name="MediaUpload.getbytes"></a><div id="MediaUpload.getbytes-def"><a name="L150"></a><tt class="py-lineno"> 150</tt> <a class="py-toggle" href="#" id="MediaUpload.getbytes-toggle" onclick="return toggle('MediaUpload.getbytes');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#getbytes">getbytes</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">begin</tt><tt class="py-op">,</tt> <tt class="py-param">end</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 206 | </div><div id="MediaUpload.getbytes-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.getbytes-expanded"><a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-docstring">"""Get bytes from the media.</tt> </tt> |
| 207 | <a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 208 | <a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 209 | <a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-docstring"> begin: int, offset from beginning of file.</tt> </tt> |
| 210 | <a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-docstring"> length: int, number of bytes to read, starting at begin.</tt> </tt> |
| 211 | <a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 212 | <a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 213 | <a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> A string of bytes read. May be shorter than length if EOF was reached</tt> </tt> |
| 214 | <a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> first.</tt> </tt> |
| 215 | <a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 216 | <a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 217 | </div><a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> </tt> |
| 218 | <a name="MediaUpload._to_json"></a><div id="MediaUpload._to_json-def"><a name="L163"></a><tt class="py-lineno"> 163</tt> <a class="py-toggle" href="#" id="MediaUpload._to_json-toggle" onclick="return toggle('MediaUpload._to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#_to_json">_to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">strip</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 219 | </div><div id="MediaUpload._to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload._to_json-expanded"><a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt class="py-docstring">"""Utility function for creating a JSON representation of a MediaUpload.</tt> </tt> |
| 220 | <a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 221 | <a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 222 | <a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> strip: array, An array of names of members to not include in the JSON.</tt> </tt> |
| 223 | <a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 224 | <a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 225 | <a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 226 | <a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 227 | <a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 228 | <a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| 229 | <a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt> |
| 230 | <a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">strip</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 231 | <a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">member</tt> <tt class="py-keyword">in</tt> <tt class="py-name">strip</tt><tt class="py-op">:</tt> </tt> |
| 232 | <a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-name">member</tt><tt class="py-op">]</tt> </tt> |
| 233 | <a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_class'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">t</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt> |
| 234 | <a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_module'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">t</tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt> </tt> |
| 235 | <a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt> |
| 236 | </div><a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> </tt> |
| 237 | <a name="MediaUpload.to_json"></a><div id="MediaUpload.to_json-def"><a name="L182"></a><tt class="py-lineno"> 182</tt> <a class="py-toggle" href="#" id="MediaUpload.to_json-toggle" onclick="return toggle('MediaUpload.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#to_json">to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 238 | </div><div id="MediaUpload.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.to_json-expanded"><a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a JSON representation of an instance of MediaUpload.</tt> </tt> |
| 239 | <a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 240 | <a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 241 | <a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 242 | <a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 243 | <a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 244 | <a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method apiclient.http.MediaUpload._to_json()=apiclient.http.MediaUpload-class.html#_to_json,Method oauth2client.client.Credentials._to_json()=oauth2client.client.Credentials-class.html#_to_json"><a title="apiclient.http.MediaUpload._to_json |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 245 | oauth2client.client.Credentials._to_json" class="py-name" href="#" onclick="return doclink('link-16', '_to_json', 'link-16');">_to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 246 | </div><a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> </tt> |
| 247 | <a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 248 | <a name="MediaUpload.new_from_json"></a><div id="MediaUpload.new_from_json-def"><a name="L192"></a><tt class="py-lineno"> 192</tt> <a class="py-toggle" href="#" id="MediaUpload.new_from_json-toggle" onclick="return toggle('MediaUpload.new_from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 249 | </div><div id="MediaUpload.new_from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaUpload.new_from_json-expanded"><a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <tt class="py-docstring">"""Utility class method to instantiate a MediaUpload subclass from a JSON</tt> </tt> |
| 250 | <a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> representation produced by to_json().</tt> </tt> |
| 251 | <a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 252 | <a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 253 | <a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-docstring"> s: string, JSON from to_json().</tt> </tt> |
| 254 | <a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 255 | <a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 256 | <a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> An instance of the subclass of MediaUpload that was serialized with</tt> </tt> |
| 257 | <a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> to_json().</tt> </tt> |
| 258 | <a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 259 | <a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Function oauth2client.clientsecrets.loads()=oauth2client.clientsecrets-module.html#loads"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-17', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 260 | <a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt class="py-comment"># Find and call the right classmethod from_json() to restore the object.</tt> </tt> |
| 261 | <a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'_module'</tt><tt class="py-op">]</tt> </tt> |
| 262 | <a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">__import__</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">,</tt> <tt class="py-name">fromlist</tt><tt class="py-op">=</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 263 | <a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-name">kls</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">,</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'_class'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 264 | <a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Static Method apiclient.http.HttpRequest.from_json()=apiclient.http.HttpRequest-class.html#from_json,Static Method apiclient.http.MediaFileUpload.from_json()=apiclient.http.MediaFileUpload-class.html#from_json,Static Method apiclient.http.MediaInMemoryUpload.from_json()=apiclient.http.MediaInMemoryUpload-class.html#from_json,Class Method oauth2client.appengine.AppAssertionCredentials.from_json()=oauth2client.appengine.AppAssertionCredentials-class.html#from_json,Class Method oauth2client.client.AccessTokenCredentials.from_json()=oauth2client.client.AccessTokenCredentials-class.html#from_json,Class Method oauth2client.client.Credentials.from_json()=oauth2client.client.Credentials-class.html#from_json,Class Method oauth2client.client.OAuth2Credentials.from_json()=oauth2client.client.OAuth2Credentials-class.html#from_json,Class Method oauth2client.client.SignedJwtAssertionCredentials.from_json()=oauth2client.client.SignedJwtAssertionCredentials-class.html#from_json"><a title="apiclient.http.HttpRequest.from_json |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 265 | apiclient.http.MediaFileUpload.from_json |
| 266 | apiclient.http.MediaInMemoryUpload.from_json |
| 267 | oauth2client.appengine.AppAssertionCredentials.from_json |
| 268 | oauth2client.client.AccessTokenCredentials.from_json |
| 269 | oauth2client.client.Credentials.from_json |
| 270 | oauth2client.client.OAuth2Credentials.from_json |
| 271 | oauth2client.client.SignedJwtAssertionCredentials.from_json" class="py-name" href="#" onclick="return doclink('link-18', 'from_json', 'link-18');">from_json</a></tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">kls</tt><tt class="py-op">,</tt> <tt class="py-string">'from_json'</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 272 | <a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-19" class="py-name"><a title="apiclient.http.HttpRequest.from_json |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 273 | apiclient.http.MediaFileUpload.from_json |
| 274 | apiclient.http.MediaInMemoryUpload.from_json |
| 275 | oauth2client.appengine.AppAssertionCredentials.from_json |
| 276 | oauth2client.client.AccessTokenCredentials.from_json |
| 277 | oauth2client.client.Credentials.from_json |
| 278 | oauth2client.client.OAuth2Credentials.from_json |
| 279 | oauth2client.client.SignedJwtAssertionCredentials.from_json" class="py-name" href="#" onclick="return doclink('link-19', 'from_json', 'link-18');">from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 280 | </div></div><a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> </tt> |
| 281 | <a name="MediaFileUpload"></a><div id="MediaFileUpload-def"><a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> </tt> |
| 282 | <a name="L212"></a><tt class="py-lineno"> 212</tt> <a class="py-toggle" href="#" id="MediaFileUpload-toggle" onclick="return toggle('MediaFileUpload');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html">MediaFileUpload</a><tt class="py-op">(</tt><tt class="py-base-class">MediaUpload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 283 | </div><div id="MediaFileUpload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaFileUpload-expanded"><a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-docstring">"""A MediaUpload for a file.</tt> </tt> |
| 284 | <a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 285 | <a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"><tt class="py-docstring"> Construct a MediaFileUpload and pass as the media_body parameter of the</tt> </tt> |
| 286 | <a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"><tt class="py-docstring"> method. For example, if we had a service that allowed uploading images:</tt> </tt> |
| 287 | <a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 288 | <a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 289 | <a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"><tt class="py-docstring"> media = MediaFileUpload('cow.png', mimetype='image/png',</tt> </tt> |
| 290 | <a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"><tt class="py-docstring"> chunksize=1024*1024, resumable=True)</tt> </tt> |
| 291 | <a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"><tt class="py-docstring"> farm.animals()..insert(</tt> </tt> |
| 292 | <a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"><tt class="py-docstring"> id='cow',</tt> </tt> |
| 293 | <a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"><tt class="py-docstring"> name='cow.png',</tt> </tt> |
| 294 | <a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"><tt class="py-docstring"> media_body=media).execute()</tt> </tt> |
| 295 | <a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 296 | <a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> </tt> |
| 297 | <a name="MediaFileUpload.__init__"></a><div id="MediaFileUpload.__init__-def"><a name="L227"></a><tt class="py-lineno"> 227</tt> <a class="py-toggle" href="#" id="MediaFileUpload.__init__-toggle" onclick="return toggle('MediaFileUpload.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">mimetype</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">chunksize</tt><tt class="py-op">=</tt><tt id="link-20" class="py-name"><a title="apiclient.http.DEFAULT_CHUNK_SIZE" class="py-name" href="#" onclick="return doclink('link-20', 'DEFAULT_CHUNK_SIZE', 'link-15');">DEFAULT_CHUNK_SIZE</a></tt><tt class="py-op">,</tt> <tt class="py-param">resumable</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 298 | </div><div id="MediaFileUpload.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.__init__-expanded"><a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt> |
| 299 | <a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 300 | <a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 301 | <a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, Name of the file.</tt> </tt> |
| 302 | <a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> mimetype: string, Mime-type of the file. If None then a mime-type will be</tt> </tt> |
| 303 | <a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> guessed from the file extension.</tt> </tt> |
| 304 | <a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> chunksize: int, File will be uploaded in chunks of this many bytes. Only</tt> </tt> |
| 305 | <a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> used if resumable=True.</tt> </tt> |
| 306 | <a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> resumable: bool, True if this is a resumable upload. False means upload</tt> </tt> |
| 307 | <a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> in a single request.</tt> </tt> |
| 308 | <a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 309 | <a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> <tt class="py-op">=</tt> <tt id="link-21" class="py-name" targets="Method oauth2client.locked_file.LockedFile.filename()=oauth2client.locked_file.LockedFile-class.html#filename,Method oauth2client.locked_file._Opener.filename()=oauth2client.locked_file._Opener-class.html#filename"><a title="oauth2client.locked_file.LockedFile.filename |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 310 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-21', 'filename', 'link-21');">filename</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 311 | <a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">getsize</tt><tt class="py-op">(</tt><tt id="link-22" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 312 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-22', 'filename', 'link-21');">filename</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 313 | <a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fd</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 314 | <a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-23" class="py-name" targets="Method apiclient.http.MediaFileUpload.mimetype()=apiclient.http.MediaFileUpload-class.html#mimetype,Method apiclient.http.MediaInMemoryUpload.mimetype()=apiclient.http.MediaInMemoryUpload-class.html#mimetype,Method apiclient.http.MediaIoBaseUpload.mimetype()=apiclient.http.MediaIoBaseUpload-class.html#mimetype,Method apiclient.http.MediaUpload.mimetype()=apiclient.http.MediaUpload-class.html#mimetype"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 315 | apiclient.http.MediaInMemoryUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 316 | apiclient.http.MediaIoBaseUpload.mimetype |
| 317 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-23', 'mimetype', 'link-23');">mimetype</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 318 | <a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-24" class="py-name"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 319 | apiclient.http.MediaInMemoryUpload.mimetype |
| 320 | apiclient.http.MediaIoBaseUpload.mimetype |
| 321 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-24', 'mimetype', 'link-23');">mimetype</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">mimetypes</tt><tt class="py-op">.</tt><tt class="py-name">guess_type</tt><tt class="py-op">(</tt><tt id="link-25" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename |
| 322 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-25', 'filename', 'link-21');">filename</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 323 | <a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> <tt class="py-op">=</tt> <tt id="link-26" class="py-name"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 324 | apiclient.http.MediaInMemoryUpload.mimetype |
| 325 | apiclient.http.MediaIoBaseUpload.mimetype |
| 326 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-26', 'mimetype', 'link-23');">mimetype</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 327 | <a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> <tt class="py-op">=</tt> <tt id="link-27" class="py-name" targets="Method apiclient.http.MediaFileUpload.chunksize()=apiclient.http.MediaFileUpload-class.html#chunksize,Method apiclient.http.MediaInMemoryUpload.chunksize()=apiclient.http.MediaInMemoryUpload-class.html#chunksize,Method apiclient.http.MediaIoBaseUpload.chunksize()=apiclient.http.MediaIoBaseUpload-class.html#chunksize,Method apiclient.http.MediaUpload.chunksize()=apiclient.http.MediaUpload-class.html#chunksize"><a title="apiclient.http.MediaFileUpload.chunksize |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 328 | apiclient.http.MediaInMemoryUpload.chunksize |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 329 | apiclient.http.MediaIoBaseUpload.chunksize |
| 330 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-27', 'chunksize', 'link-27');">chunksize</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 331 | <a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> <tt class="py-op">=</tt> <tt id="link-28" class="py-name" targets="Method apiclient.http.MediaFileUpload.resumable()=apiclient.http.MediaFileUpload-class.html#resumable,Method apiclient.http.MediaInMemoryUpload.resumable()=apiclient.http.MediaInMemoryUpload-class.html#resumable,Method apiclient.http.MediaIoBaseUpload.resumable()=apiclient.http.MediaIoBaseUpload-class.html#resumable,Method apiclient.http.MediaUpload.resumable()=apiclient.http.MediaUpload-class.html#resumable"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 332 | apiclient.http.MediaInMemoryUpload.resumable |
| 333 | apiclient.http.MediaIoBaseUpload.resumable |
| 334 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-28', 'resumable', 'link-28');">resumable</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 335 | </div><a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> </tt> |
| 336 | <a name="MediaFileUpload.chunksize"></a><div id="MediaFileUpload.chunksize-def"><a name="L248"></a><tt class="py-lineno"> 248</tt> <a class="py-toggle" href="#" id="MediaFileUpload.chunksize-toggle" onclick="return toggle('MediaFileUpload.chunksize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#chunksize">chunksize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 337 | </div><div id="MediaFileUpload.chunksize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.chunksize-expanded"><a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-docstring">"""Chunk size for resumable uploads.</tt> </tt> |
| 338 | <a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 339 | <a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 340 | <a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"> Chunk size in bytes.</tt> </tt> |
| 341 | <a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 342 | <a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> </tt> |
| 343 | </div><a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> </tt> |
| 344 | <a name="MediaFileUpload.mimetype"></a><div id="MediaFileUpload.mimetype-def"><a name="L256"></a><tt class="py-lineno"> 256</tt> <a class="py-toggle" href="#" id="MediaFileUpload.mimetype-toggle" onclick="return toggle('MediaFileUpload.mimetype');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#mimetype">mimetype</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 345 | </div><div id="MediaFileUpload.mimetype-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.mimetype-expanded"><a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-docstring">"""Mime type of the body.</tt> </tt> |
| 346 | <a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 347 | <a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 348 | <a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-docstring"> Mime type.</tt> </tt> |
| 349 | <a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 350 | <a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> </tt> |
| 351 | </div><a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> </tt> |
| 352 | <a name="MediaFileUpload.size"></a><div id="MediaFileUpload.size-def"><a name="L264"></a><tt class="py-lineno"> 264</tt> <a class="py-toggle" href="#" id="MediaFileUpload.size-toggle" onclick="return toggle('MediaFileUpload.size');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#size">size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 353 | </div><div id="MediaFileUpload.size-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.size-expanded"><a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-docstring">"""Size of upload.</tt> </tt> |
| 354 | <a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 355 | <a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 356 | <a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-docstring"> Size of the body, or None of the size is unknown.</tt> </tt> |
| 357 | <a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 358 | <a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> </tt> |
| 359 | </div><a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> </tt> |
| 360 | <a name="MediaFileUpload.resumable"></a><div id="MediaFileUpload.resumable-def"><a name="L272"></a><tt class="py-lineno"> 272</tt> <a class="py-toggle" href="#" id="MediaFileUpload.resumable-toggle" onclick="return toggle('MediaFileUpload.resumable');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#resumable">resumable</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 361 | </div><div id="MediaFileUpload.resumable-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.resumable-expanded"><a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"> <tt class="py-docstring">"""Whether this upload is resumable.</tt> </tt> |
| 362 | <a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 363 | <a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 364 | <a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"><tt class="py-docstring"> True if resumable upload or False.</tt> </tt> |
| 365 | <a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 366 | <a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> </tt> |
| 367 | </div><a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> </tt> |
| 368 | <a name="MediaFileUpload.getbytes"></a><div id="MediaFileUpload.getbytes-def"><a name="L280"></a><tt class="py-lineno"> 280</tt> <a class="py-toggle" href="#" id="MediaFileUpload.getbytes-toggle" onclick="return toggle('MediaFileUpload.getbytes');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#getbytes">getbytes</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">begin</tt><tt class="py-op">,</tt> <tt class="py-param">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 369 | </div><div id="MediaFileUpload.getbytes-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.getbytes-expanded"><a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt class="py-docstring">"""Get bytes from the media.</tt> </tt> |
| 370 | <a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 371 | <a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 372 | <a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt class="py-docstring"> begin: int, offset from beginning of file.</tt> </tt> |
| 373 | <a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"><tt class="py-docstring"> length: int, number of bytes to read, starting at begin.</tt> </tt> |
| 374 | <a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 375 | <a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 376 | <a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"><tt class="py-docstring"> A string of bytes read. May be shorted than length if EOF was reached</tt> </tt> |
| 377 | <a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"><tt class="py-docstring"> first.</tt> </tt> |
| 378 | <a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 379 | <a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fd</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 380 | <a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fd</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-string">'rb'</tt><tt class="py-op">)</tt> </tt> |
| 381 | <a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fd</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-name">begin</tt><tt class="py-op">)</tt> </tt> |
| 382 | <a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fd</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-name">length</tt><tt class="py-op">)</tt> </tt> |
| 383 | </div><a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> </tt> |
| 384 | <a name="MediaFileUpload.to_json"></a><div id="MediaFileUpload.to_json-def"><a name="L296"></a><tt class="py-lineno"> 296</tt> <a class="py-toggle" href="#" id="MediaFileUpload.to_json-toggle" onclick="return toggle('MediaFileUpload.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#to_json">to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 385 | </div><div id="MediaFileUpload.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.to_json-expanded"><a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"> <tt class="py-docstring">"""Creating a JSON representation of an instance of MediaFileUpload.</tt> </tt> |
| 386 | <a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 387 | <a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 388 | <a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 389 | <a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 390 | <a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 391 | <a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="apiclient.http.MediaUpload._to_json |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 392 | oauth2client.client.Credentials._to_json" class="py-name" href="#" onclick="return doclink('link-29', '_to_json', 'link-16');">_to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'_fd'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 393 | </div><a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> </tt> |
| 394 | <a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt> |
| 395 | <a name="MediaFileUpload.from_json"></a><div id="MediaFileUpload.from_json-def"><a name="L306"></a><tt class="py-lineno"> 306</tt> <a class="py-toggle" href="#" id="MediaFileUpload.from_json-toggle" onclick="return toggle('MediaFileUpload.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaFileUpload-class.html#from_json">from_json</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 396 | </div><div id="MediaFileUpload.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaFileUpload.from_json-expanded"><a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-30', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 397 | <a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-31" class="py-name" targets="Class apiclient.http.MediaFileUpload=apiclient.http.MediaFileUpload-class.html"><a title="apiclient.http.MediaFileUpload" class="py-name" href="#" onclick="return doclink('link-31', 'MediaFileUpload', 'link-31');">MediaFileUpload</a></tt><tt class="py-op">(</tt> </tt> |
| 398 | <a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_filename'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_mimetype'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_chunksize'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_resumable'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 399 | </div></div><a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> </tt> |
| 400 | <a name="MediaIoBaseUpload"></a><div id="MediaIoBaseUpload-def"><a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> </tt> |
| 401 | <a name="L312"></a><tt class="py-lineno"> 312</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload-toggle" onclick="return toggle('MediaIoBaseUpload');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a><tt class="py-op">(</tt><tt class="py-base-class">MediaUpload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 402 | </div><div id="MediaIoBaseUpload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaIoBaseUpload-expanded"><a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-docstring">"""A MediaUpload for a io.Base objects.</tt> </tt> |
| 403 | <a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 404 | <a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"><tt class="py-docstring"> Note that the Python file object is compatible with io.Base and can be used</tt> </tt> |
| 405 | <a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"><tt class="py-docstring"> with this class also.</tt> </tt> |
| 406 | <a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 407 | <a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"><tt class="py-docstring"> fh = io.BytesIO('...Some data to upload...')</tt> </tt> |
| 408 | <a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"><tt class="py-docstring"> media = MediaIoBaseUpload(fh, mimetype='image/png',</tt> </tt> |
| 409 | <a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"><tt class="py-docstring"> chunksize=1024*1024, resumable=True)</tt> </tt> |
| 410 | <a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"><tt class="py-docstring"> farm.animals().insert(</tt> </tt> |
| 411 | <a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"><tt class="py-docstring"> id='cow',</tt> </tt> |
| 412 | <a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"><tt class="py-docstring"> name='cow.png',</tt> </tt> |
| 413 | <a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"><tt class="py-docstring"> media_body=media).execute()</tt> </tt> |
| 414 | <a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 415 | <a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> </tt> |
| 416 | <a name="MediaIoBaseUpload.__init__"></a><div id="MediaIoBaseUpload.__init__-def"><a name="L327"></a><tt class="py-lineno"> 327</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.__init__-toggle" onclick="return toggle('MediaIoBaseUpload.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fh</tt><tt class="py-op">,</tt> <tt class="py-param">mimetype</tt><tt class="py-op">,</tt> <tt class="py-param">chunksize</tt><tt class="py-op">=</tt><tt id="link-32" class="py-name"><a title="apiclient.http.DEFAULT_CHUNK_SIZE" class="py-name" href="#" onclick="return doclink('link-32', 'DEFAULT_CHUNK_SIZE', 'link-15');">DEFAULT_CHUNK_SIZE</a></tt><tt class="py-op">,</tt> </tt> |
| 417 | <a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> <tt class="py-param">resumable</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 418 | </div><div id="MediaIoBaseUpload.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.__init__-expanded"><a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt> |
| 419 | <a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 420 | <a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 421 | <a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"><tt class="py-docstring"> fh: io.Base or file object, The source of the bytes to upload. MUST be</tt> </tt> |
| 422 | <a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"><tt class="py-docstring"> opened in blocking mode, do not use streams opened in non-blocking mode.</tt> </tt> |
| 423 | <a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-docstring"> mimetype: string, Mime-type of the file. If None then a mime-type will be</tt> </tt> |
| 424 | <a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"><tt class="py-docstring"> guessed from the file extension.</tt> </tt> |
| 425 | <a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"><tt class="py-docstring"> chunksize: int, File will be uploaded in chunks of this many bytes. Only</tt> </tt> |
| 426 | <a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"><tt class="py-docstring"> used if resumable=True.</tt> </tt> |
| 427 | <a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"><tt class="py-docstring"> resumable: bool, True if this is a resumable upload. False means upload</tt> </tt> |
| 428 | <a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-docstring"> in a single request.</tt> </tt> |
| 429 | <a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 430 | <a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">fh</tt> </tt> |
| 431 | <a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 432 | apiclient.http.MediaInMemoryUpload.mimetype |
| 433 | apiclient.http.MediaIoBaseUpload.mimetype |
| 434 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-33', 'mimetype', 'link-23');">mimetype</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 435 | <a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> <tt class="py-op">=</tt> <tt id="link-34" class="py-name"><a title="apiclient.http.MediaFileUpload.chunksize |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 436 | apiclient.http.MediaInMemoryUpload.chunksize |
| 437 | apiclient.http.MediaIoBaseUpload.chunksize |
| 438 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-34', 'chunksize', 'link-27');">chunksize</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 439 | <a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> <tt class="py-op">=</tt> <tt id="link-35" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 440 | apiclient.http.MediaInMemoryUpload.resumable |
| 441 | apiclient.http.MediaIoBaseUpload.resumable |
| 442 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-35', 'resumable', 'link-28');">resumable</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 443 | <a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 444 | <a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 445 | <a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">,</tt> <tt class="py-string">'fileno'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 446 | <a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-name">fileno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 447 | <a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> </tt> |
| 448 | <a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-comment"># Pipes and such show up as 0 length files.</tt> </tt> |
| 449 | <a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> <tt id="link-36" class="py-name" targets="Method apiclient.http.MediaFileUpload.size()=apiclient.http.MediaFileUpload-class.html#size,Method apiclient.http.MediaInMemoryUpload.size()=apiclient.http.MediaInMemoryUpload-class.html#size,Method apiclient.http.MediaIoBaseUpload.size()=apiclient.http.MediaIoBaseUpload-class.html#size,Method apiclient.http.MediaUpload.size()=apiclient.http.MediaUpload-class.html#size"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 450 | apiclient.http.MediaInMemoryUpload.size |
| 451 | apiclient.http.MediaIoBaseUpload.size |
| 452 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-36', 'size', 'link-36');">size</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">fstat</tt><tt class="py-op">(</tt><tt class="py-name">fileno</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">st_size</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 453 | <a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-37" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 454 | apiclient.http.MediaInMemoryUpload.size |
| 455 | apiclient.http.MediaIoBaseUpload.size |
| 456 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-37', 'size', 'link-36');">size</a></tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 457 | <a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">fstat</tt><tt class="py-op">(</tt><tt class="py-name">fileno</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">st_size</tt> </tt> |
| 458 | <a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">:</tt> </tt> |
| 459 | <a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 460 | </div><a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> </tt> |
| 461 | <a name="MediaIoBaseUpload.chunksize"></a><div id="MediaIoBaseUpload.chunksize-def"><a name="L357"></a><tt class="py-lineno"> 357</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.chunksize-toggle" onclick="return toggle('MediaIoBaseUpload.chunksize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 462 | </div><div id="MediaIoBaseUpload.chunksize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.chunksize-expanded"><a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-docstring">"""Chunk size for resumable uploads.</tt> </tt> |
| 463 | <a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 464 | <a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 465 | <a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"><tt class="py-docstring"> Chunk size in bytes.</tt> </tt> |
| 466 | <a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 467 | <a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> </tt> |
| 468 | </div><a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> </tt> |
| 469 | <a name="MediaIoBaseUpload.mimetype"></a><div id="MediaIoBaseUpload.mimetype-def"><a name="L365"></a><tt class="py-lineno"> 365</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.mimetype-toggle" onclick="return toggle('MediaIoBaseUpload.mimetype');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 470 | </div><div id="MediaIoBaseUpload.mimetype-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.mimetype-expanded"><a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt class="py-docstring">"""Mime type of the body.</tt> </tt> |
| 471 | <a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 472 | <a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 473 | <a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"> Mime type.</tt> </tt> |
| 474 | <a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 475 | <a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> </tt> |
| 476 | </div><a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> </tt> |
| 477 | <a name="MediaIoBaseUpload.size"></a><div id="MediaIoBaseUpload.size-def"><a name="L373"></a><tt class="py-lineno"> 373</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.size-toggle" onclick="return toggle('MediaIoBaseUpload.size');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#size">size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 478 | </div><div id="MediaIoBaseUpload.size-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.size-expanded"><a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> <tt class="py-docstring">"""Size of upload.</tt> </tt> |
| 479 | <a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 480 | <a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 481 | <a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> Size of the body, or None of the size is unknown.</tt> </tt> |
| 482 | <a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 483 | <a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> </tt> |
| 484 | </div><a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> </tt> |
| 485 | <a name="MediaIoBaseUpload.resumable"></a><div id="MediaIoBaseUpload.resumable-def"><a name="L381"></a><tt class="py-lineno"> 381</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.resumable-toggle" onclick="return toggle('MediaIoBaseUpload.resumable');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 486 | </div><div id="MediaIoBaseUpload.resumable-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.resumable-expanded"><a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> <tt class="py-docstring">"""Whether this upload is resumable.</tt> </tt> |
| 487 | <a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 488 | <a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 489 | <a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> True if resumable upload or False.</tt> </tt> |
| 490 | <a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 491 | <a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> </tt> |
| 492 | </div><a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> </tt> |
| 493 | <a name="MediaIoBaseUpload.getbytes"></a><div id="MediaIoBaseUpload.getbytes-def"><a name="L389"></a><tt class="py-lineno"> 389</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.getbytes-toggle" onclick="return toggle('MediaIoBaseUpload.getbytes');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">begin</tt><tt class="py-op">,</tt> <tt class="py-param">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 494 | </div><div id="MediaIoBaseUpload.getbytes-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.getbytes-expanded"><a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-docstring">"""Get bytes from the media.</tt> </tt> |
| 495 | <a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 496 | <a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 497 | <a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"><tt class="py-docstring"> begin: int, offset from beginning of file.</tt> </tt> |
| 498 | <a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"><tt class="py-docstring"> length: int, number of bytes to read, starting at begin.</tt> </tt> |
| 499 | <a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 500 | <a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 501 | <a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"><tt class="py-docstring"> A string of bytes read. May be shorted than length if EOF was reached</tt> </tt> |
| 502 | <a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"><tt class="py-docstring"> first.</tt> </tt> |
| 503 | <a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 504 | <a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-name">begin</tt><tt class="py-op">)</tt> </tt> |
| 505 | <a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-name">length</tt><tt class="py-op">)</tt> </tt> |
| 506 | </div><a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> </tt> |
| 507 | <a name="MediaIoBaseUpload.to_json"></a><div id="MediaIoBaseUpload.to_json-def"><a name="L403"></a><tt class="py-lineno"> 403</tt> <a class="py-toggle" href="#" id="MediaIoBaseUpload.to_json-toggle" onclick="return toggle('MediaIoBaseUpload.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseUpload-class.html#to_json">to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 508 | </div><div id="MediaIoBaseUpload.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseUpload.to_json-expanded"><a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-docstring">"""This upload type is not serializable."""</tt> </tt> |
| 509 | <a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-string">'MediaIoBaseUpload is not serializable.'</tt><tt class="py-op">)</tt> </tt> |
| 510 | </div></div><a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> </tt> |
| 511 | <a name="MediaInMemoryUpload"></a><div id="MediaInMemoryUpload-def"><a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> </tt> |
| 512 | <a name="L408"></a><tt class="py-lineno"> 408</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload-toggle" onclick="return toggle('MediaInMemoryUpload');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html">MediaInMemoryUpload</a><tt class="py-op">(</tt><tt class="py-base-class">MediaUpload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 513 | </div><div id="MediaInMemoryUpload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaInMemoryUpload-expanded"><a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-docstring">"""MediaUpload for a chunk of bytes.</tt> </tt> |
| 514 | <a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 515 | <a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"><tt class="py-docstring"> Construct a MediaFileUpload and pass as the media_body parameter of the</tt> </tt> |
| 516 | <a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"><tt class="py-docstring"> method.</tt> </tt> |
| 517 | <a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 518 | <a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> </tt> |
| 519 | <a name="MediaInMemoryUpload.__init__"></a><div id="MediaInMemoryUpload.__init__-def"><a name="L415"></a><tt class="py-lineno"> 415</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.__init__-toggle" onclick="return toggle('MediaInMemoryUpload.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">,</tt> <tt class="py-param">mimetype</tt><tt class="py-op">=</tt><tt class="py-string">'application/octet-stream'</tt><tt class="py-op">,</tt> </tt> |
| 520 | <a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-param">chunksize</tt><tt class="py-op">=</tt><tt id="link-38" class="py-name"><a title="apiclient.http.DEFAULT_CHUNK_SIZE" class="py-name" href="#" onclick="return doclink('link-38', 'DEFAULT_CHUNK_SIZE', 'link-15');">DEFAULT_CHUNK_SIZE</a></tt><tt class="py-op">,</tt> <tt class="py-param">resumable</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 521 | </div><div id="MediaInMemoryUpload.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.__init__-expanded"><a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new MediaBytesUpload.</tt> </tt> |
| 522 | <a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 523 | <a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 524 | <a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-docstring"> body: string, Bytes of body content.</tt> </tt> |
| 525 | <a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"><tt class="py-docstring"> mimetype: string, Mime-type of the file or default of</tt> </tt> |
| 526 | <a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-docstring"> 'application/octet-stream'.</tt> </tt> |
| 527 | <a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> chunksize: int, File will be uploaded in chunks of this many bytes. Only</tt> </tt> |
| 528 | <a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> used if resumable=True.</tt> </tt> |
| 529 | <a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> resumable: bool, True if this is a resumable upload. False means upload</tt> </tt> |
| 530 | <a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"> in a single request.</tt> </tt> |
| 531 | <a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 532 | <a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_body</tt> <tt class="py-op">=</tt> <tt class="py-name">body</tt> </tt> |
| 533 | <a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> <tt class="py-op">=</tt> <tt id="link-39" class="py-name"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 534 | apiclient.http.MediaInMemoryUpload.mimetype |
| 535 | apiclient.http.MediaIoBaseUpload.mimetype |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 536 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-39', 'mimetype', 'link-23');">mimetype</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 537 | <a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> <tt class="py-op">=</tt> <tt id="link-40" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 538 | apiclient.http.MediaInMemoryUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 539 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 540 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-40', 'resumable', 'link-28');">resumable</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 541 | <a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> <tt class="py-op">=</tt> <tt id="link-41" class="py-name"><a title="apiclient.http.MediaFileUpload.chunksize |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 542 | apiclient.http.MediaInMemoryUpload.chunksize |
| 543 | apiclient.http.MediaIoBaseUpload.chunksize |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 544 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-41', 'chunksize', 'link-27');">chunksize</a></tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 545 | </div><a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> </tt> |
| 546 | <a name="MediaInMemoryUpload.chunksize"></a><div id="MediaInMemoryUpload.chunksize-def"><a name="L433"></a><tt class="py-lineno"> 433</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.chunksize-toggle" onclick="return toggle('MediaInMemoryUpload.chunksize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#chunksize">chunksize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 547 | </div><div id="MediaInMemoryUpload.chunksize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.chunksize-expanded"><a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-docstring">"""Chunk size for resumable uploads.</tt> </tt> |
| 548 | <a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 549 | <a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 550 | <a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-docstring"> Chunk size in bytes.</tt> </tt> |
| 551 | <a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 552 | <a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_chunksize</tt> </tt> |
| 553 | </div><a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> </tt> |
| 554 | <a name="MediaInMemoryUpload.mimetype"></a><div id="MediaInMemoryUpload.mimetype-def"><a name="L441"></a><tt class="py-lineno"> 441</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.mimetype-toggle" onclick="return toggle('MediaInMemoryUpload.mimetype');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#mimetype">mimetype</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 555 | </div><div id="MediaInMemoryUpload.mimetype-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.mimetype-expanded"><a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-docstring">"""Mime type of the body.</tt> </tt> |
| 556 | <a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 557 | <a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 558 | <a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"><tt class="py-docstring"> Mime type.</tt> </tt> |
| 559 | <a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 560 | <a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mimetype</tt> </tt> |
| 561 | </div><a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> </tt> |
| 562 | <a name="MediaInMemoryUpload.size"></a><div id="MediaInMemoryUpload.size-def"><a name="L449"></a><tt class="py-lineno"> 449</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.size-toggle" onclick="return toggle('MediaInMemoryUpload.size');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#size">size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 563 | </div><div id="MediaInMemoryUpload.size-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.size-expanded"><a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-docstring">"""Size of upload.</tt> </tt> |
| 564 | <a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 565 | <a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 566 | <a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"><tt class="py-docstring"> Size of the body, or None of the size is unknown.</tt> </tt> |
| 567 | <a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 568 | <a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_body</tt><tt class="py-op">)</tt> </tt> |
| 569 | </div><a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> </tt> |
| 570 | <a name="MediaInMemoryUpload.resumable"></a><div id="MediaInMemoryUpload.resumable-def"><a name="L457"></a><tt class="py-lineno"> 457</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.resumable-toggle" onclick="return toggle('MediaInMemoryUpload.resumable');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#resumable">resumable</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 571 | </div><div id="MediaInMemoryUpload.resumable-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.resumable-expanded"><a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-docstring">"""Whether this upload is resumable.</tt> </tt> |
| 572 | <a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 573 | <a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 574 | <a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> True if resumable upload or False.</tt> </tt> |
| 575 | <a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 576 | <a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_resumable</tt> </tt> |
| 577 | </div><a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> </tt> |
| 578 | <a name="MediaInMemoryUpload.getbytes"></a><div id="MediaInMemoryUpload.getbytes-def"><a name="L465"></a><tt class="py-lineno"> 465</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.getbytes-toggle" onclick="return toggle('MediaInMemoryUpload.getbytes');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#getbytes">getbytes</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">begin</tt><tt class="py-op">,</tt> <tt class="py-param">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 579 | </div><div id="MediaInMemoryUpload.getbytes-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.getbytes-expanded"><a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-docstring">"""Get bytes from the media.</tt> </tt> |
| 580 | <a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 581 | <a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 582 | <a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"><tt class="py-docstring"> begin: int, offset from beginning of file.</tt> </tt> |
| 583 | <a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-docstring"> length: int, number of bytes to read, starting at begin.</tt> </tt> |
| 584 | <a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 585 | <a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 586 | <a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"><tt class="py-docstring"> A string of bytes read. May be shorter than length if EOF was reached</tt> </tt> |
| 587 | <a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"><tt class="py-docstring"> first.</tt> </tt> |
| 588 | <a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 589 | <a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_body</tt><tt class="py-op">[</tt><tt class="py-name">begin</tt><tt class="py-op">:</tt><tt class="py-name">begin</tt> <tt class="py-op">+</tt> <tt class="py-name">length</tt><tt class="py-op">]</tt> </tt> |
| 590 | </div><a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> </tt> |
| 591 | <a name="MediaInMemoryUpload.to_json"></a><div id="MediaInMemoryUpload.to_json-def"><a name="L478"></a><tt class="py-lineno"> 478</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.to_json-toggle" onclick="return toggle('MediaInMemoryUpload.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#to_json">to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 592 | </div><div id="MediaInMemoryUpload.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.to_json-expanded"><a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a JSON representation of a MediaInMemoryUpload.</tt> </tt> |
| 593 | <a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 594 | <a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 595 | <a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 596 | <a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 597 | <a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 598 | <a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| 599 | <a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt> |
| 600 | <a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_body'</tt><tt class="py-op">]</tt> </tt> |
| 601 | <a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_class'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">t</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt> |
| 602 | <a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_module'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">t</tt><tt class="py-op">.</tt><tt class="py-name">__module__</tt> </tt> |
| 603 | <a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_b64body'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">base64</tt><tt class="py-op">.</tt><tt class="py-name">b64encode</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_body</tt><tt class="py-op">)</tt> </tt> |
| 604 | <a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt> |
| 605 | </div><a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> </tt> |
| 606 | <a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt> |
| 607 | <a name="MediaInMemoryUpload.from_json"></a><div id="MediaInMemoryUpload.from_json-def"><a name="L494"></a><tt class="py-lineno"> 494</tt> <a class="py-toggle" href="#" id="MediaInMemoryUpload.from_json-toggle" onclick="return toggle('MediaInMemoryUpload.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaInMemoryUpload-class.html#from_json">from_json</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 608 | </div><div id="MediaInMemoryUpload.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaInMemoryUpload.from_json-expanded"><a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-42', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 609 | <a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-43" class="py-name" targets="Class apiclient.http.MediaInMemoryUpload=apiclient.http.MediaInMemoryUpload-class.html"><a title="apiclient.http.MediaInMemoryUpload" class="py-name" href="#" onclick="return doclink('link-43', 'MediaInMemoryUpload', 'link-43');">MediaInMemoryUpload</a></tt><tt class="py-op">(</tt><tt class="py-name">base64</tt><tt class="py-op">.</tt><tt class="py-name">b64decode</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_b64body'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 610 | <a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_mimetype'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_chunksize'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 611 | <a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'_resumable'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 612 | </div></div><a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> </tt> |
| 613 | <a name="MediaIoBaseDownload"></a><div id="MediaIoBaseDownload-def"><a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> </tt> |
| 614 | <a name="L501"></a><tt class="py-lineno"> 501</tt> <a class="py-toggle" href="#" id="MediaIoBaseDownload-toggle" onclick="return toggle('MediaIoBaseDownload');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseDownload-class.html">MediaIoBaseDownload</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 615 | </div><div id="MediaIoBaseDownload-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MediaIoBaseDownload-expanded"><a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-docstring">""""Download media resources.</tt> </tt> |
| 616 | <a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 617 | <a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-docstring"> Note that the Python file object is compatible with io.Base and can be used</tt> </tt> |
| 618 | <a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-docstring"> with this class also.</tt> </tt> |
| 619 | <a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 620 | <a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 621 | <a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 622 | <a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"> request = farms.animals().get_media(id='cow')</tt> </tt> |
| 623 | <a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> fh = io.FileIO('cow.png', mode='wb')</tt> </tt> |
| 624 | <a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024)</tt> </tt> |
| 625 | <a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 626 | <a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-docstring"> done = False</tt> </tt> |
| 627 | <a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-docstring"> while done is False:</tt> </tt> |
| 628 | <a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-docstring"> status, done = downloader.next_chunk()</tt> </tt> |
| 629 | <a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> if status:</tt> </tt> |
| 630 | <a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"> print "Download %d%%." % int(status.progress() * 100)</tt> </tt> |
| 631 | <a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> print "Download Complete!"</tt> </tt> |
| 632 | <a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 633 | <a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> </tt> |
| 634 | <a name="MediaIoBaseDownload.__init__"></a><div id="MediaIoBaseDownload.__init__-def"><a name="L521"></a><tt class="py-lineno"> 521</tt> <a class="py-toggle" href="#" id="MediaIoBaseDownload.__init__-toggle" onclick="return toggle('MediaIoBaseDownload.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseDownload-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fh</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">,</tt> <tt class="py-param">chunksize</tt><tt class="py-op">=</tt><tt id="link-44" class="py-name"><a title="apiclient.http.DEFAULT_CHUNK_SIZE" class="py-name" href="#" onclick="return doclink('link-44', 'DEFAULT_CHUNK_SIZE', 'link-15');">DEFAULT_CHUNK_SIZE</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 635 | </div><div id="MediaIoBaseDownload.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseDownload.__init__-expanded"><a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor.</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 636 | <a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 637 | <a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 638 | <a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"><tt class="py-docstring"> fh: io.Base or file object, The stream in which to write the downloaded</tt> </tt> |
| 639 | <a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-docstring"> bytes.</tt> </tt> |
| 640 | <a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-docstring"> request: apiclient.http.HttpRequest, the media request to perform in</tt> </tt> |
| 641 | <a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-docstring"> chunks.</tt> </tt> |
| 642 | <a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> chunksize: int, File will be downloaded in chunks of this many bytes.</tt> </tt> |
| 643 | <a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 644 | <a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh_</tt> <tt class="py-op">=</tt> <tt class="py-name">fh</tt> </tt> |
| 645 | <a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">request_</tt> <tt class="py-op">=</tt> <tt id="link-45" class="py-name" targets="Method apiclient.http.HttpMock.request()=apiclient.http.HttpMock-class.html#request,Method apiclient.http.HttpMockSequence.request()=apiclient.http.HttpMockSequence-class.html#request,Method apiclient.model.BaseModel.request()=apiclient.model.BaseModel-class.html#request,Method apiclient.model.Model.request()=apiclient.model.Model-class.html#request"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 646 | apiclient.http.HttpMockSequence.request |
| 647 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 648 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-45', 'request', 'link-45');">request</a></tt> </tt> |
| 649 | <a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri_</tt> <tt class="py-op">=</tt> <tt id="link-46" class="py-name"><a title="apiclient.http.HttpMock.request |
| 650 | apiclient.http.HttpMockSequence.request |
| 651 | apiclient.model.BaseModel.request |
| 652 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-46', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> </tt> |
| 653 | <a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">chunksize_</tt> <tt class="py-op">=</tt> <tt id="link-47" class="py-name"><a title="apiclient.http.MediaFileUpload.chunksize |
| 654 | apiclient.http.MediaInMemoryUpload.chunksize |
| 655 | apiclient.http.MediaIoBaseUpload.chunksize |
| 656 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-47', 'chunksize', 'link-27');">chunksize</a></tt> </tt> |
| 657 | <a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt> |
| 658 | <a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size_</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 659 | <a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">done_</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 660 | </div><a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> </tt> |
| 661 | <a name="MediaIoBaseDownload.next_chunk"></a><div id="MediaIoBaseDownload.next_chunk-def"><a name="L539"></a><tt class="py-lineno"> 539</tt> <a class="py-toggle" href="#" id="MediaIoBaseDownload.next_chunk-toggle" onclick="return toggle('MediaIoBaseDownload.next_chunk');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.MediaIoBaseDownload-class.html#next_chunk">next_chunk</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 662 | </div><div id="MediaIoBaseDownload.next_chunk-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MediaIoBaseDownload.next_chunk-expanded"><a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-docstring">"""Get the next chunk of the download.</tt> </tt> |
| 663 | <a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 664 | <a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 665 | <a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> (status, done): (MediaDownloadStatus, boolean)</tt> </tt> |
| 666 | <a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> The value of 'done' will be True when the media has been fully</tt> </tt> |
| 667 | <a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> downloaded.</tt> </tt> |
| 668 | <a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 669 | <a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 670 | <a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.HttpError if the response was not a 2xx.</tt> </tt> |
| 671 | <a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Error if a transport error has occured.</tt> </tt> |
| 672 | <a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 673 | <a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 674 | <a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt class="py-string">'range'</tt><tt class="py-op">:</tt> <tt class="py-string">'bytes=%d-%d'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt> |
| 675 | <a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">chunksize_</tt><tt class="py-op">)</tt> </tt> |
| 676 | <a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 677 | <a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt id="link-48" class="py-name" targets="Module apiclient.http=apiclient.http-module.html,Method oauth2client.appengine.OAuth2Decorator.http()=oauth2client.appengine.OAuth2Decorator-class.html#http"><a title="apiclient.http |
| 678 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-48', 'http', 'link-48');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">request_</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="apiclient.http |
| 679 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-49', 'http', 'link-48');">http</a></tt> </tt> |
| 680 | <a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> <tt id="link-50" class="py-name"><a title="apiclient.http |
| 681 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-50', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt class="py-name">follow_redirects</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 682 | <a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> </tt> |
| 683 | <a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-51" class="py-name"><a title="apiclient.http |
| 684 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-51', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="apiclient.http.HttpMock.request |
| 685 | apiclient.http.HttpMockSequence.request |
| 686 | apiclient.model.BaseModel.request |
| 687 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-52', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri_</tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 688 | <a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-number">301</tt><tt class="py-op">,</tt> <tt class="py-number">302</tt><tt class="py-op">,</tt> <tt class="py-number">303</tt><tt class="py-op">,</tt> <tt class="py-number">307</tt><tt class="py-op">,</tt> <tt class="py-number">308</tt><tt class="py-op">]</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'location'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 689 | <a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri_</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'location'</tt><tt class="py-op">]</tt> </tt> |
| 690 | <a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name"><a title="apiclient.http |
| 691 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-53', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="apiclient.http.HttpMock.request |
| 692 | apiclient.http.HttpMockSequence.request |
| 693 | apiclient.model.BaseModel.request |
| 694 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-54', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri_</tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 695 | <a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-number">200</tt><tt class="py-op">,</tt> <tt class="py-number">206</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt> |
| 696 | <a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt> <tt class="py-op">+=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 697 | <a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh_</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 698 | <a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> </tt> |
| 699 | <a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'content-range'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 700 | <a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-name">content_range</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'content-range'</tt><tt class="py-op">]</tt> </tt> |
| 701 | <a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt class="py-name">content_range</tt><tt class="py-op">.</tt><tt class="py-name">rsplit</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt> |
| 702 | <a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size_</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">length</tt><tt class="py-op">)</tt> </tt> |
| 703 | <a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> </tt> |
| 704 | <a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt> <tt class="py-op">==</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size_</tt><tt class="py-op">:</tt> </tt> |
| 705 | <a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">done_</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 706 | <a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-55" class="py-name" targets="Class apiclient.http.MediaDownloadProgress=apiclient.http.MediaDownloadProgress-class.html"><a title="apiclient.http.MediaDownloadProgress" class="py-name" href="#" onclick="return doclink('link-55', 'MediaDownloadProgress', 'link-55');">MediaDownloadProgress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">progress_</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">total_size_</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">done_</tt> </tt> |
| 707 | <a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 708 | <a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-56" class="py-name"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-56', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri_</tt><tt class="py-op">)</tt> </tt> |
| 709 | </div></div><a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> </tt> |
| 710 | <a name="HttpRequest"></a><div id="HttpRequest-def"><a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> </tt> |
| 711 | <a name="L578"></a><tt class="py-lineno"> 578</tt> <a class="py-toggle" href="#" id="HttpRequest-toggle" onclick="return toggle('HttpRequest');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html">HttpRequest</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 712 | </div><div id="HttpRequest-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="HttpRequest-expanded"><a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-docstring">"""Encapsulates a single HTTP request."""</tt> </tt> |
| 713 | <a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> </tt> |
| 714 | <a name="HttpRequest.__init__"></a><div id="HttpRequest.__init__-def"><a name="L581"></a><tt class="py-lineno"> 581</tt> <a class="py-toggle" href="#" id="HttpRequest.__init__-toggle" onclick="return toggle('HttpRequest.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">postproc</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">,</tt> </tt> |
| 715 | <a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> </tt> |
| 716 | <a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 717 | <a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 718 | <a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-param">methodId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 719 | <a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> <tt class="py-param">resumable</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 720 | </div><div id="HttpRequest.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest.__init__-expanded"><a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for an HttpRequest.</tt> </tt> |
| 721 | <a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 722 | <a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 723 | <a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, the transport object to use to make a request</tt> </tt> |
| 724 | <a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"><tt class="py-docstring"> postproc: callable, called on the HTTP response and content to transform</tt> </tt> |
| 725 | <a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-docstring"> it into a data object before returning, or raising an exception</tt> </tt> |
| 726 | <a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"><tt class="py-docstring"> on an error.</tt> </tt> |
| 727 | <a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"><tt class="py-docstring"> uri: string, the absolute URI to send the request to</tt> </tt> |
| 728 | <a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"><tt class="py-docstring"> method: string, the HTTP method to use</tt> </tt> |
| 729 | <a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-docstring"> body: string, the request body of the HTTP request,</tt> </tt> |
| 730 | <a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, the HTTP request headers</tt> </tt> |
| 731 | <a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> methodId: string, a unique identifier for the API method being called.</tt> </tt> |
| 732 | <a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> resumable: MediaUpload, None if this is not a resumbale request.</tt> </tt> |
| 733 | <a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 734 | <a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt> |
| 735 | <a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">method</tt> </tt> |
| 736 | <a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">body</tt> </tt> |
| 737 | <a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">or</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 738 | <a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">methodId</tt> <tt class="py-op">=</tt> <tt class="py-name">methodId</tt> </tt> |
| 739 | <a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="apiclient.http |
| 740 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-57', 'http', 'link-48');">http</a></tt> <tt class="py-op">=</tt> <tt id="link-58" class="py-name"><a title="apiclient.http |
| 741 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-58', 'http', 'link-48');">http</a></tt> </tt> |
| 742 | <a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt> <tt class="py-op">=</tt> <tt class="py-name">postproc</tt> </tt> |
| 743 | <a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 744 | apiclient.http.MediaInMemoryUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 745 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 746 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-59', 'resumable', 'link-28');">resumable</a></tt> <tt class="py-op">=</tt> <tt id="link-60" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 747 | apiclient.http.MediaInMemoryUpload.resumable |
| 748 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 749 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-60', 'resumable', 'link-28');">resumable</a></tt> </tt> |
| 750 | <a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 751 | <a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> </tt> |
| 752 | <a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-comment"># Pull the multipart boundary out of the content-type header.</tt> </tt> |
| 753 | <a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-name">major</tt><tt class="py-op">,</tt> <tt class="py-name">minor</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt id="link-61" class="py-name"><a title="apiclient.mimeparse" class="py-name" href="#" onclick="return doclink('link-61', 'mimeparse', 'link-0');">mimeparse</a></tt><tt class="py-op">.</tt><tt id="link-62" class="py-name" targets="Function apiclient.mimeparse.parse_mime_type()=apiclient.mimeparse-module.html#parse_mime_type"><a title="apiclient.mimeparse.parse_mime_type" class="py-name" href="#" onclick="return doclink('link-62', 'parse_mime_type', 'link-62');">parse_mime_type</a></tt><tt class="py-op">(</tt> </tt> |
| 754 | <a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-class.html#get,Method oauth2client.appengine.OAuth2Handler.get()=oauth2client.appengine.OAuth2Handler-class.html#get,Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="apiclient.schema.Schemas.get |
| 755 | oauth2client.appengine.OAuth2Handler.get |
| 756 | oauth2client.client.MemoryCache.get |
| 757 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-63', 'get', 'link-63');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'content-type'</tt><tt class="py-op">,</tt> <tt class="py-string">'application/json'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 758 | <a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> </tt> |
| 759 | <a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-comment"># The size of the non-media part of the request.</tt> </tt> |
| 760 | <a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body_size</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body</tt> <tt class="py-keyword">or</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt> |
| 761 | <a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> </tt> |
| 762 | <a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-comment"># The resumable URI to send chunks to.</tt> </tt> |
| 763 | <a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 764 | <a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> </tt> |
| 765 | <a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-comment"># The bytes that have been uploaded.</tt> </tt> |
| 766 | <a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt> |
| 767 | </div><a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> </tt> |
| 768 | <a name="HttpRequest.execute"></a><div id="HttpRequest.execute-def"><a name="L624"></a><tt class="py-lineno"> 624</tt> <a class="py-toggle" href="#" id="HttpRequest.execute-toggle" onclick="return toggle('HttpRequest.execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#execute">execute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 769 | </div><div id="HttpRequest.execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest.execute-expanded"><a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-docstring">"""Execute the request.</tt> </tt> |
| 770 | <a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 771 | <a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 772 | <a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used in place of the</tt> </tt> |
| 773 | <a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"><tt class="py-docstring"> one the HttpRequest request object was constructed with.</tt> </tt> |
| 774 | <a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 775 | <a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 776 | <a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"><tt class="py-docstring"> A deserialized object model of the response body as determined</tt> </tt> |
| 777 | <a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> by the postproc.</tt> </tt> |
| 778 | <a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 779 | <a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 780 | <a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.HttpError if the response was not a 2xx.</tt> </tt> |
| 781 | <a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Error if a transport error has occured.</tt> </tt> |
| 782 | <a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 783 | <a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-64" class="py-name"><a title="apiclient.http |
| 784 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-64', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 785 | <a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt id="link-65" class="py-name"><a title="apiclient.http |
| 786 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-65', 'http', 'link-48');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="apiclient.http |
| 787 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-66', 'http', 'link-48');">http</a></tt> </tt> |
| 788 | <a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 789 | apiclient.http.MediaInMemoryUpload.resumable |
| 790 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 791 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-67', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">:</tt> </tt> |
| 792 | <a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 793 | <a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">body</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 794 | <a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Method apiclient.http.HttpRequest.next_chunk()=apiclient.http.HttpRequest-class.html#next_chunk,Method apiclient.http.MediaIoBaseDownload.next_chunk()=apiclient.http.MediaIoBaseDownload-class.html#next_chunk"><a title="apiclient.http.HttpRequest.next_chunk |
| 795 | apiclient.http.MediaIoBaseDownload.next_chunk" class="py-name" href="#" onclick="return doclink('link-68', 'next_chunk', 'link-68');">next_chunk</a></tt><tt class="py-op">(</tt><tt id="link-69" class="py-name"><a title="apiclient.http |
| 796 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-69', 'http', 'link-48');">http</a></tt><tt class="py-op">)</tt> </tt> |
| 797 | <a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">body</tt> </tt> |
| 798 | <a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 799 | <a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'content-length'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt> |
| 800 | <a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-length'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body_size</tt><tt class="py-op">)</tt> </tt> |
| 801 | <a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-70" class="py-name"><a title="apiclient.http |
| 802 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-70', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-71" class="py-name"><a title="apiclient.http.HttpMock.request |
| 803 | apiclient.http.HttpMockSequence.request |
| 804 | apiclient.model.BaseModel.request |
| 805 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-71', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> </tt> |
| 806 | <a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-name">body</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body</tt><tt class="py-op">,</tt> </tt> |
| 807 | <a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 808 | <a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> </tt> |
| 809 | <a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">>=</tt> <tt class="py-number">300</tt><tt class="py-op">:</tt> </tt> |
| 810 | <a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-72" class="py-name"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-72', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt> |
| 811 | <a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 812 | </div><a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> </tt> |
| 813 | <a name="HttpRequest.next_chunk"></a><div id="HttpRequest.next_chunk-def"><a name="L657"></a><tt class="py-lineno"> 657</tt> <a class="py-toggle" href="#" id="HttpRequest.next_chunk-toggle" onclick="return toggle('HttpRequest.next_chunk');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#next_chunk">next_chunk</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 814 | </div><div id="HttpRequest.next_chunk-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest.next_chunk-expanded"><a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt class="py-docstring">"""Execute the next step of a resumable upload.</tt> </tt> |
| 815 | <a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 816 | <a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"><tt class="py-docstring"> Can only be used if the method being executed supports media uploads and</tt> </tt> |
| 817 | <a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"><tt class="py-docstring"> the MediaUpload object passed in was flagged as using resumable upload.</tt> </tt> |
| 818 | <a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 819 | <a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 820 | <a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 821 | <a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"><tt class="py-docstring"> media = MediaFileUpload('cow.png', mimetype='image/png',</tt> </tt> |
| 822 | <a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"><tt class="py-docstring"> chunksize=1000, resumable=True)</tt> </tt> |
| 823 | <a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"><tt class="py-docstring"> request = farm.animals().insert(</tt> </tt> |
| 824 | <a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"><tt class="py-docstring"> id='cow',</tt> </tt> |
| 825 | <a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"><tt class="py-docstring"> name='cow.png',</tt> </tt> |
| 826 | <a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"><tt class="py-docstring"> media_body=media)</tt> </tt> |
| 827 | <a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 828 | <a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"><tt class="py-docstring"> response = None</tt> </tt> |
| 829 | <a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"><tt class="py-docstring"> while response is None:</tt> </tt> |
| 830 | <a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"><tt class="py-docstring"> status, response = request.next_chunk()</tt> </tt> |
| 831 | <a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"><tt class="py-docstring"> if status:</tt> </tt> |
| 832 | <a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"><tt class="py-docstring"> print "Upload %d%% complete." % int(status.progress() * 100)</tt> </tt> |
| 833 | <a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 834 | <a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 835 | <a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 836 | <a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-docstring"> (status, body): (ResumableMediaStatus, object)</tt> </tt> |
| 837 | <a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"><tt class="py-docstring"> The body will be None until the resumable media is fully uploaded.</tt> </tt> |
| 838 | <a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 839 | <a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 840 | <a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.HttpError if the response was not a 2xx.</tt> </tt> |
| 841 | <a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Error if a transport error has occured.</tt> </tt> |
| 842 | <a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 843 | <a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-73" class="py-name"><a title="apiclient.http |
| 844 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-73', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 845 | <a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt id="link-74" class="py-name"><a title="apiclient.http |
| 846 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-74', 'http', 'link-48');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="apiclient.http |
| 847 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-75', 'http', 'link-48');">http</a></tt> </tt> |
| 848 | <a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> </tt> |
| 849 | <a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| 850 | apiclient.http.MediaInMemoryUpload.resumable |
| 851 | apiclient.http.MediaIoBaseUpload.resumable |
| 852 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-76', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| 853 | apiclient.http.MediaInMemoryUpload.size |
| 854 | apiclient.http.MediaIoBaseUpload.size |
| 855 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-77', 'size', 'link-36');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 856 | <a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt id="link-78" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| 857 | apiclient.http.MediaInMemoryUpload.size |
| 858 | apiclient.http.MediaIoBaseUpload.size |
| 859 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-78', 'size', 'link-36');">size</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'*'</tt> </tt> |
| 860 | <a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 861 | <a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt id="link-79" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| 862 | apiclient.http.MediaInMemoryUpload.size |
| 863 | apiclient.http.MediaIoBaseUpload.size |
| 864 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-79', 'size', 'link-36');">size</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| 865 | apiclient.http.MediaInMemoryUpload.resumable |
| 866 | apiclient.http.MediaIoBaseUpload.resumable |
| 867 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-80', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| 868 | apiclient.http.MediaInMemoryUpload.size |
| 869 | apiclient.http.MediaIoBaseUpload.size |
| 870 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-81', 'size', 'link-36');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 871 | <a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> </tt> |
| 872 | <a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 873 | <a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-name">start_headers</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 874 | <a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-name">start_headers</tt><tt class="py-op">[</tt><tt class="py-string">'X-Upload-Content-Type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| 875 | apiclient.http.MediaInMemoryUpload.resumable |
| 876 | apiclient.http.MediaIoBaseUpload.resumable |
| 877 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-82', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="apiclient.http.MediaFileUpload.mimetype |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 878 | apiclient.http.MediaInMemoryUpload.mimetype |
| 879 | apiclient.http.MediaIoBaseUpload.mimetype |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 880 | apiclient.http.MediaUpload.mimetype" class="py-name" href="#" onclick="return doclink('link-83', 'mimetype', 'link-23');">mimetype</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 881 | <a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-84" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 882 | apiclient.http.MediaInMemoryUpload.size |
| 883 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 884 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-84', 'size', 'link-36');">size</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">'*'</tt><tt class="py-op">:</tt> </tt> |
| 885 | <a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-name">start_headers</tt><tt class="py-op">[</tt><tt class="py-string">'X-Upload-Content-Length'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-85" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 886 | apiclient.http.MediaInMemoryUpload.size |
| 887 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 888 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-85', 'size', 'link-36');">size</a></tt> </tt> |
| 889 | <a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-name">start_headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-length'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body_size</tt><tt class="py-op">)</tt> </tt> |
| 890 | <a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> </tt> |
| 891 | <a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-86" class="py-name"><a title="apiclient.http |
| 892 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-86', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-87" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 893 | apiclient.http.HttpMockSequence.request |
| 894 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 895 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-87', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> </tt> |
| 896 | <a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-name">body</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">body</tt><tt class="py-op">,</tt> </tt> |
| 897 | <a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">start_headers</tt><tt class="py-op">)</tt> </tt> |
| 898 | <a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">==</tt> <tt class="py-number">200</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'location'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 899 | <a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'location'</tt><tt class="py-op">]</tt> </tt> |
| 900 | <a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 901 | <a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-88" class="py-name"><a title="apiclient.errors.ResumableUploadError" class="py-name" href="#" onclick="return doclink('link-88', 'ResumableUploadError', 'link-6');">ResumableUploadError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Failed to retrieve starting URI."</tt><tt class="py-op">)</tt> </tt> |
| 902 | <a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt><tt class="py-op">:</tt> </tt> |
| 903 | <a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-comment"># If we are in an error state then query the server for current state of</tt> </tt> |
| 904 | <a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-comment"># the upload by sending an empty PUT and reading the 'range' header in</tt> </tt> |
| 905 | <a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-comment"># the response.</tt> </tt> |
| 906 | <a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 907 | <a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-string">'Content-Range'</tt><tt class="py-op">:</tt> <tt class="py-string">'bytes */%s'</tt> <tt class="py-op">%</tt> <tt id="link-89" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 908 | apiclient.http.MediaInMemoryUpload.size |
| 909 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 910 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-89', 'size', 'link-36');">size</a></tt><tt class="py-op">,</tt> </tt> |
| 911 | <a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-string">'content-length'</tt><tt class="py-op">:</tt> <tt class="py-string">'0'</tt> </tt> |
| 912 | <a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 913 | <a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-90" class="py-name"><a title="apiclient.http |
| 914 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-90', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 915 | apiclient.http.HttpMockSequence.request |
| 916 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 917 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-91', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt><tt class="py-op">,</tt> <tt class="py-string">'PUT'</tt><tt class="py-op">,</tt> </tt> |
| 918 | <a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 919 | <a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name" targets="Method apiclient.http.HttpRequest._process_response()=apiclient.http.HttpRequest-class.html#_process_response"><a title="apiclient.http.HttpRequest._process_response" class="py-name" href="#" onclick="return doclink('link-92', '_process_response', 'link-92');">_process_response</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 920 | <a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">body</tt><tt class="py-op">:</tt> </tt> |
| 921 | <a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-comment"># The upload was complete.</tt> </tt> |
| 922 | <a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| 923 | <a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> </tt> |
| 924 | <a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 925 | apiclient.http.MediaInMemoryUpload.resumable |
| 926 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 927 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-93', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name" targets="Method apiclient.http.MediaFileUpload.getbytes()=apiclient.http.MediaFileUpload-class.html#getbytes,Method apiclient.http.MediaInMemoryUpload.getbytes()=apiclient.http.MediaInMemoryUpload-class.html#getbytes,Method apiclient.http.MediaIoBaseUpload.getbytes()=apiclient.http.MediaIoBaseUpload-class.html#getbytes,Method apiclient.http.MediaUpload.getbytes()=apiclient.http.MediaUpload-class.html#getbytes"><a title="apiclient.http.MediaFileUpload.getbytes |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 928 | apiclient.http.MediaInMemoryUpload.getbytes |
| 929 | apiclient.http.MediaIoBaseUpload.getbytes |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 930 | apiclient.http.MediaUpload.getbytes" class="py-name" href="#" onclick="return doclink('link-94', 'getbytes', 'link-94');">getbytes</a></tt><tt class="py-op">(</tt> </tt> |
| 931 | <a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 932 | apiclient.http.MediaInMemoryUpload.resumable |
| 933 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 934 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-95', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="apiclient.http.MediaFileUpload.chunksize |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 935 | apiclient.http.MediaInMemoryUpload.chunksize |
| 936 | apiclient.http.MediaIoBaseUpload.chunksize |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 937 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-96', 'chunksize', 'link-27');">chunksize</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 938 | <a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> </tt> |
| 939 | <a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-comment"># A short read implies that we are at EOF, so finish the upload.</tt> </tt> |
| 940 | <a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 941 | apiclient.http.MediaInMemoryUpload.resumable |
| 942 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 943 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-97', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="apiclient.http.MediaFileUpload.chunksize |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 944 | apiclient.http.MediaInMemoryUpload.chunksize |
| 945 | apiclient.http.MediaIoBaseUpload.chunksize |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 946 | apiclient.http.MediaUpload.chunksize" class="py-name" href="#" onclick="return doclink('link-98', 'chunksize', 'link-27');">chunksize</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 947 | <a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt id="link-99" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 948 | apiclient.http.MediaInMemoryUpload.size |
| 949 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 950 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-99', 'size', 'link-36');">size</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 951 | <a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> </tt> |
| 952 | <a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 953 | <a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-string">'Content-Range'</tt><tt class="py-op">:</tt> <tt class="py-string">'bytes %d-%d/%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt> |
| 954 | <a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> </tt> |
| 955 | <a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 956 | apiclient.http.MediaInMemoryUpload.size |
| 957 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 958 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-100', 'size', 'link-36');">size</a></tt><tt class="py-op">)</tt> </tt> |
| 959 | <a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 960 | <a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 961 | <a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-101" class="py-name"><a title="apiclient.http |
| 962 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-101', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 963 | apiclient.http.HttpMockSequence.request |
| 964 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 965 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-102', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt><tt class="py-op">,</tt> <tt class="py-string">'PUT'</tt><tt class="py-op">,</tt> </tt> |
| 966 | <a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> <tt class="py-name">body</tt><tt class="py-op">=</tt><tt class="py-name">data</tt><tt class="py-op">,</tt> </tt> |
| 967 | <a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 968 | <a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt> |
| 969 | <a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 970 | <a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt> |
| 971 | <a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> </tt> |
| 972 | <a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="apiclient.http.HttpRequest._process_response" class="py-name" href="#" onclick="return doclink('link-103', '_process_response', 'link-92');">_process_response</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 973 | </div><a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> </tt> |
| 974 | <a name="HttpRequest._process_response"></a><div id="HttpRequest._process_response-def"><a name="L746"></a><tt class="py-lineno"> 746</tt> <a class="py-toggle" href="#" id="HttpRequest._process_response-toggle" onclick="return toggle('HttpRequest._process_response');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#_process_response">_process_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resp</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 975 | </div><div id="HttpRequest._process_response-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest._process_response-expanded"><a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-docstring">"""Process the response from a single chunk upload.</tt> </tt> |
| 976 | <a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 977 | <a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 978 | <a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-docstring"> resp: httplib2.Response, the response object.</tt> </tt> |
| 979 | <a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-docstring"> content: string, the content of the response.</tt> </tt> |
| 980 | <a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 981 | <a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 982 | <a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"><tt class="py-docstring"> (status, body): (ResumableMediaStatus, object)</tt> </tt> |
| 983 | <a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"><tt class="py-docstring"> The body will be None until the resumable media is fully uploaded.</tt> </tt> |
| 984 | <a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 985 | <a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 986 | <a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.HttpError if the response was not a 2xx or a 308.</tt> </tt> |
| 987 | <a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 988 | <a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-number">200</tt><tt class="py-op">,</tt> <tt class="py-number">201</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt> |
| 989 | <a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 990 | <a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 991 | <a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">==</tt> <tt class="py-number">308</tt><tt class="py-op">:</tt> </tt> |
| 992 | <a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 993 | <a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-comment"># A "308 Resume Incomplete" indicates we are not done.</tt> </tt> |
| 994 | <a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'range'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'-'</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt> |
| 995 | <a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'location'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 996 | <a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'location'</tt><tt class="py-op">]</tt> </tt> |
| 997 | <a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 998 | <a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error_state</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 999 | <a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-104" class="py-name"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-104', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt> |
| 1000 | <a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> </tt> |
| 1001 | <a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt id="link-105" class="py-name" targets="Class apiclient.http.MediaUploadProgress=apiclient.http.MediaUploadProgress-class.html"><a title="apiclient.http.MediaUploadProgress" class="py-name" href="#" onclick="return doclink('link-105', 'MediaUploadProgress', 'link-105');">MediaUploadProgress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resumable_progress</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1002 | apiclient.http.MediaInMemoryUpload.resumable |
| 1003 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1004 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-106', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="apiclient.http.MediaFileUpload.size |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1005 | apiclient.http.MediaInMemoryUpload.size |
| 1006 | apiclient.http.MediaIoBaseUpload.size |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1007 | apiclient.http.MediaUpload.size" class="py-name" href="#" onclick="return doclink('link-107', 'size', 'link-36');">size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 1008 | <a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 1009 | </div><a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> </tt> |
| 1010 | <a name="HttpRequest.to_json"></a><div id="HttpRequest.to_json-def"><a name="L776"></a><tt class="py-lineno"> 776</tt> <a class="py-toggle" href="#" id="HttpRequest.to_json-toggle" onclick="return toggle('HttpRequest.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#to_json">to_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1011 | </div><div id="HttpRequest.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest.to_json-expanded"><a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a JSON representation of the HttpRequest."""</tt> </tt> |
| 1012 | <a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">copy</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt> |
| 1013 | <a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1014 | <a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1015 | apiclient.http.MediaInMemoryUpload.resumable |
| 1016 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1017 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-108', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">.</tt><tt id="link-109" class="py-name" targets="Method apiclient.http.HttpRequest.to_json()=apiclient.http.HttpRequest-class.html#to_json,Method apiclient.http.MediaFileUpload.to_json()=apiclient.http.MediaFileUpload-class.html#to_json,Method apiclient.http.MediaInMemoryUpload.to_json()=apiclient.http.MediaInMemoryUpload-class.html#to_json,Method apiclient.http.MediaIoBaseUpload.to_json()=apiclient.http.MediaIoBaseUpload-class.html#to_json,Method apiclient.http.MediaUpload.to_json()=apiclient.http.MediaUpload-class.html#to_json,Method oauth2client.client.Credentials.to_json()=oauth2client.client.Credentials-class.html#to_json,Method oauth2client.client.OAuth2Credentials.to_json()=oauth2client.client.OAuth2Credentials-class.html#to_json"><a title="apiclient.http.HttpRequest.to_json |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1018 | apiclient.http.MediaFileUpload.to_json |
| 1019 | apiclient.http.MediaInMemoryUpload.to_json |
| 1020 | apiclient.http.MediaIoBaseUpload.to_json |
| 1021 | apiclient.http.MediaUpload.to_json |
| 1022 | oauth2client.client.Credentials.to_json |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1023 | oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-109', 'to_json', 'link-109');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1024 | <a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'http'</tt><tt class="py-op">]</tt> </tt> |
| 1025 | <a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'postproc'</tt><tt class="py-op">]</tt> </tt> |
| 1026 | <a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> </tt> |
| 1027 | <a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt> |
| 1028 | </div><a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> </tt> |
| 1029 | <a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">staticmethod</tt> </tt> |
| 1030 | <a name="HttpRequest.from_json"></a><div id="HttpRequest.from_json-def"><a name="L787"></a><tt class="py-lineno"> 787</tt> <a class="py-toggle" href="#" id="HttpRequest.from_json-toggle" onclick="return toggle('HttpRequest.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequest-class.html#from_json">from_json</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">postproc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1031 | </div><div id="HttpRequest.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequest.from_json-expanded"><a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns an HttpRequest populated with info from a JSON object."""</tt> </tt> |
| 1032 | <a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-110', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 1033 | <a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1034 | <a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-111" class="py-name" targets="Class apiclient.http.MediaUpload=apiclient.http.MediaUpload-class.html"><a title="apiclient.http.MediaUpload" class="py-name" href="#" onclick="return doclink('link-111', 'MediaUpload', 'link-111');">MediaUpload</a></tt><tt class="py-op">.</tt><tt id="link-112" class="py-name" targets="Class Method apiclient.http.MediaUpload.new_from_json()=apiclient.http.MediaUpload-class.html#new_from_json,Class Method oauth2client.client.Credentials.new_from_json()=oauth2client.client.Credentials-class.html#new_from_json"><a title="apiclient.http.MediaUpload.new_from_json |
| 1035 | oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick="return doclink('link-112', 'new_from_json', 'link-112');">new_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1036 | <a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-113" class="py-name" targets="Class apiclient.http.HttpRequest=apiclient.http.HttpRequest-class.html"><a title="apiclient.http.HttpRequest" class="py-name" href="#" onclick="return doclink('link-113', 'HttpRequest', 'link-113');">HttpRequest</a></tt><tt class="py-op">(</tt> </tt> |
| 1037 | <a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt id="link-114" class="py-name"><a title="apiclient.http |
| 1038 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-114', 'http', 'link-48');">http</a></tt><tt class="py-op">,</tt> </tt> |
| 1039 | <a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-name">postproc</tt><tt class="py-op">,</tt> </tt> |
| 1040 | <a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">uri</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1041 | <a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'method'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1042 | <a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-name">body</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'body'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1043 | <a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'headers'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1044 | <a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-name">methodId</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'methodId'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1045 | <a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt id="link-115" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1046 | apiclient.http.MediaInMemoryUpload.resumable |
| 1047 | apiclient.http.MediaIoBaseUpload.resumable |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1048 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-115', 'resumable', 'link-28');">resumable</a></tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'resumable'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1049 | </div></div><a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> </tt> |
| 1050 | <a name="BatchHttpRequest"></a><div id="BatchHttpRequest-def"><a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> </tt> |
| 1051 | <a name="L803"></a><tt class="py-lineno"> 803</tt> <a class="py-toggle" href="#" id="BatchHttpRequest-toggle" onclick="return toggle('BatchHttpRequest');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html">BatchHttpRequest</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1052 | </div><div id="BatchHttpRequest-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="BatchHttpRequest-expanded"><a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-docstring">"""Batches multiple HttpRequest objects into a single HTTP request.</tt> </tt> |
| 1053 | <a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1054 | <a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 1055 | <a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"><tt class="py-docstring"> from apiclient.http import BatchHttpRequest</tt> </tt> |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 1056 | <a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1057 | <a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"><tt class="py-docstring"> def list_animals(request_id, response, exception):</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1058 | <a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"><tt class="py-docstring"> \"\"\"Do something with the animals list response.\"\"\"</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1059 | <a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"><tt class="py-docstring"> if exception is not None:</tt> </tt> |
| 1060 | <a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-docstring"> # Do something with the exception.</tt> </tt> |
| 1061 | <a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-docstring"> pass</tt> </tt> |
| 1062 | <a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-docstring"> else:</tt> </tt> |
| 1063 | <a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-docstring"> # Do something with the response.</tt> </tt> |
| 1064 | <a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-docstring"> pass</tt> </tt> |
| 1065 | <a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1066 | <a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"><tt class="py-docstring"> def list_farmers(request_id, response, exception):</tt> </tt> |
| 1067 | <a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-docstring"> \"\"\"Do something with the farmers list response.\"\"\"</tt> </tt> |
| 1068 | <a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"><tt class="py-docstring"> if exception is not None:</tt> </tt> |
| 1069 | <a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-docstring"> # Do something with the exception.</tt> </tt> |
| 1070 | <a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"><tt class="py-docstring"> pass</tt> </tt> |
| 1071 | <a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"><tt class="py-docstring"> else:</tt> </tt> |
| 1072 | <a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"><tt class="py-docstring"> # Do something with the response.</tt> </tt> |
| 1073 | <a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"><tt class="py-docstring"> pass</tt> </tt> |
| 1074 | <a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1075 | <a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"><tt class="py-docstring"> service = build('farm', 'v2')</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1076 | <a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1077 | <a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"><tt class="py-docstring"> batch = BatchHttpRequest()</tt> </tt> |
| 1078 | <a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1079 | <a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"><tt class="py-docstring"> batch.add(service.animals().list(), list_animals)</tt> </tt> |
| 1080 | <a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt class="py-docstring"> batch.add(service.farmers().list(), list_farmers)</tt> </tt> |
| 1081 | <a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-docstring"> batch.execute(http)</tt> </tt> |
| 1082 | <a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1083 | <a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> </tt> |
| 1084 | <a name="BatchHttpRequest.__init__"></a><div id="BatchHttpRequest.__init__-def"><a name="L836"></a><tt class="py-lineno"> 836</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.__init__-toggle" onclick="return toggle('BatchHttpRequest.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">batch_uri</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1085 | </div><div id="BatchHttpRequest.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest.__init__-expanded"><a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for a BatchHttpRequest.</tt> </tt> |
| 1086 | <a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1087 | <a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1088 | <a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for each response, of the</tt> </tt> |
| 1089 | <a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt> |
| 1090 | <a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt> |
| 1091 | <a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"><tt class="py-docstring"> third is an apiclient.errors.HttpError exception object if an HTTP error</tt> </tt> |
| 1092 | <a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"><tt class="py-docstring"> occurred while processing the request, or None if no error occurred.</tt> </tt> |
| 1093 | <a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-docstring"> batch_uri: string, URI to send batch requests to.</tt> </tt> |
| 1094 | <a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1095 | <a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">batch_uri</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1096 | <a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-name">batch_uri</tt> <tt class="py-op">=</tt> <tt class="py-string">'https://www.googleapis.com/batch'</tt> </tt> |
| 1097 | <a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">batch_uri</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1098 | <a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1099 | <a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-comment"># Global callback to be called for each individual response in the batch.</tt> </tt> |
| 1100 | <a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1101 | <a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1102 | <a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-comment"># A map from id to request.</tt> </tt> |
| 1103 | <a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1104 | <a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1105 | <a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-comment"># A map from id to callback.</tt> </tt> |
| 1106 | <a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1107 | <a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1108 | <a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt class="py-comment"># List of request ids, in the order in which they were added.</tt> </tt> |
| 1109 | <a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt> |
| 1110 | <a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> </tt> |
| 1111 | <a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-comment"># The last auto generated id.</tt> </tt> |
| 1112 | <a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt> |
| 1113 | <a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> </tt> |
| 1114 | <a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-comment"># Unique ID on which to base the Content-ID headers.</tt> </tt> |
| 1115 | <a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base_id</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1116 | <a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> </tt> |
| 1117 | <a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-comment"># A map from request id to (httplib2.Response, content) response pairs</tt> </tt> |
| 1118 | <a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1119 | <a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> </tt> |
| 1120 | <a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-comment"># A map of id(Credentials) that have been refreshed.</tt> </tt> |
| 1121 | <a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_refreshed_credentials</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1122 | </div><a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> </tt> |
| 1123 | <a name="BatchHttpRequest._refresh_and_apply_credentials"></a><div id="BatchHttpRequest._refresh_and_apply_credentials-def"><a name="L875"></a><tt class="py-lineno"> 875</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._refresh_and_apply_credentials-toggle" onclick="return toggle('BatchHttpRequest._refresh_and_apply_credentials');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_refresh_and_apply_credentials">_refresh_and_apply_credentials</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1124 | </div><div id="BatchHttpRequest._refresh_and_apply_credentials-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._refresh_and_apply_credentials-expanded"><a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-docstring">"""Refresh the credentials and apply to the request.</tt> </tt> |
| 1125 | <a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1126 | <a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1127 | <a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> request: HttpRequest, the request.</tt> </tt> |
| 1128 | <a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, the global http object for the batch.</tt> </tt> |
| 1129 | <a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1130 | <a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-comment"># For the credentials to refresh, but only once per refresh_token</tt> </tt> |
| 1131 | <a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-comment"># If there is no http per the request then refresh the http passed in</tt> </tt> |
| 1132 | <a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-comment"># via execute()</tt> </tt> |
| 1133 | <a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-name">creds</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1134 | <a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-116" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 1135 | apiclient.http.HttpMockSequence.request |
| 1136 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1137 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-116', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="apiclient.http |
| 1138 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-117', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-118" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1139 | apiclient.http.HttpMockSequence.request |
| 1140 | apiclient.model.BaseModel.request |
| 1141 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-118', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="apiclient.http |
| 1142 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-119', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1143 | apiclient.http.HttpMockSequence.request |
| 1144 | apiclient.model.BaseModel.request |
| 1145 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-120', 'request', 'link-45');">request</a></tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1146 | <a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1147 | <a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-name">creds</tt> <tt class="py-op">=</tt> <tt id="link-121" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1148 | apiclient.http.HttpMockSequence.request |
| 1149 | apiclient.model.BaseModel.request |
| 1150 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-121', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="apiclient.http |
| 1151 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-122', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1152 | apiclient.http.HttpMockSequence.request |
| 1153 | apiclient.model.BaseModel.request |
| 1154 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-123', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-124" class="py-name" targets="Variable oauth2client.appengine.CredentialsModel.credentials=oauth2client.appengine.CredentialsModel-class.html#credentials"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-124', 'credentials', 'link-124');">credentials</a></tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1155 | <a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-125" class="py-name"><a title="apiclient.http |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1156 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-125', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-126" class="py-name"><a title="apiclient.http |
| 1157 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-126', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1158 | apiclient.http.HttpMockSequence.request |
| 1159 | apiclient.model.BaseModel.request |
| 1160 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-127', 'request', 'link-45');">request</a></tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1161 | <a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-name">creds</tt> <tt class="py-op">=</tt> <tt id="link-128" class="py-name"><a title="apiclient.http |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1162 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-128', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1163 | apiclient.http.HttpMockSequence.request |
| 1164 | apiclient.model.BaseModel.request |
| 1165 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-129', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-130', 'credentials', 'link-124');">credentials</a></tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1166 | <a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">creds</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1167 | <a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">creds</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_refreshed_credentials</tt><tt class="py-op">:</tt> </tt> |
| 1168 | <a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">creds</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name" targets="Method oauth2client.client.Credentials.refresh()=oauth2client.client.Credentials-class.html#refresh,Method oauth2client.client.OAuth2Credentials.refresh()=oauth2client.client.OAuth2Credentials-class.html#refresh"><a title="oauth2client.client.Credentials.refresh |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1169 | oauth2client.client.OAuth2Credentials.refresh" class="py-name" href="#" onclick="return doclink('link-131', 'refresh', 'link-131');">refresh</a></tt><tt class="py-op">(</tt><tt id="link-132" class="py-name"><a title="apiclient.http |
| 1170 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-132', 'http', 'link-48');">http</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1171 | <a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_refreshed_credentials</tt><tt class="py-op">[</tt><tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">creds</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt> |
| 1172 | <a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> </tt> |
| 1173 | <a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-comment"># Only apply the credentials if we are using the http object passed in,</tt> </tt> |
| 1174 | <a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-comment"># otherwise apply() will get called during _serialize_request().</tt> </tt> |
| 1175 | <a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-133" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1176 | apiclient.http.HttpMockSequence.request |
| 1177 | apiclient.model.BaseModel.request |
| 1178 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-133', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="apiclient.http |
| 1179 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-134', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-135" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1180 | apiclient.http.HttpMockSequence.request |
| 1181 | apiclient.model.BaseModel.request |
| 1182 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-135', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="apiclient.http |
| 1183 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-136', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1184 | apiclient.http.HttpMockSequence.request |
| 1185 | apiclient.model.BaseModel.request |
| 1186 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-137', 'request', 'link-45');">request</a></tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1187 | <a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1188 | <a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-name">creds</tt><tt class="py-op">.</tt><tt id="link-138" class="py-name" targets="Method oauth2client.client.Credentials.apply()=oauth2client.client.Credentials-class.html#apply,Method oauth2client.client.OAuth2Credentials.apply()=oauth2client.client.OAuth2Credentials-class.html#apply"><a title="oauth2client.client.Credentials.apply |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1189 | oauth2client.client.OAuth2Credentials.apply" class="py-name" href="#" onclick="return doclink('link-138', 'apply', 'link-138');">apply</a></tt><tt class="py-op">(</tt><tt id="link-139" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1190 | apiclient.http.HttpMockSequence.request |
| 1191 | apiclient.model.BaseModel.request |
| 1192 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-139', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1193 | </div><a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> </tt> |
| 1194 | <a name="BatchHttpRequest._id_to_header"></a><div id="BatchHttpRequest._id_to_header-def"><a name="L902"></a><tt class="py-lineno"> 902</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._id_to_header-toggle" onclick="return toggle('BatchHttpRequest._id_to_header');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_id_to_header">_id_to_header</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id_</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1195 | </div><div id="BatchHttpRequest._id_to_header-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._id_to_header-expanded"><a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert an id to a Content-ID header value.</tt> </tt> |
| 1196 | <a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1197 | <a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1198 | <a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-docstring"> id_: string, identifier of individual request.</tt> </tt> |
| 1199 | <a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1200 | <a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1201 | <a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-docstring"> A Content-ID header with the id_ encoded into it. A UUID is prepended to</tt> </tt> |
| 1202 | <a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"><tt class="py-docstring"> the value because Content-ID headers are supposed to be universally</tt> </tt> |
| 1203 | <a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"><tt class="py-docstring"> unique.</tt> </tt> |
| 1204 | <a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1205 | <a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base_id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1206 | <a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base_id</tt> <tt class="py-op">=</tt> <tt class="py-name">uuid</tt><tt class="py-op">.</tt><tt class="py-name">uuid4</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1207 | <a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> </tt> |
| 1208 | <a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s+%s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base_id</tt><tt class="py-op">,</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1209 | </div><a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> </tt> |
| 1210 | <a name="BatchHttpRequest._header_to_id"></a><div id="BatchHttpRequest._header_to_id-def"><a name="L918"></a><tt class="py-lineno"> 918</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._header_to_id-toggle" onclick="return toggle('BatchHttpRequest._header_to_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_header_to_id">_header_to_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">header</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1211 | </div><div id="BatchHttpRequest._header_to_id-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._header_to_id-expanded"><a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert a Content-ID header value to an id.</tt> </tt> |
| 1212 | <a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1213 | <a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-docstring"> Presumes the Content-ID header conforms to the format that _id_to_header()</tt> </tt> |
| 1214 | <a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> returns.</tt> </tt> |
| 1215 | <a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1216 | <a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1217 | <a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-docstring"> header: string, Content-ID header value.</tt> </tt> |
| 1218 | <a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1219 | <a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1220 | <a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-docstring"> The extracted id value.</tt> </tt> |
| 1221 | <a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1222 | <a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1223 | <a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-docstring"> BatchError if the header is not in the expected format.</tt> </tt> |
| 1224 | <a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1225 | <a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">header</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'<'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">header</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'>'</tt><tt class="py-op">:</tt> </tt> |
| 1226 | <a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-140" class="py-name"><a title="apiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-140', 'BatchError', 'link-2');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Invalid value for Content-ID: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">header</tt><tt class="py-op">)</tt> </tt> |
| 1227 | <a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'+'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">header</tt><tt class="py-op">:</tt> </tt> |
| 1228 | <a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-141" class="py-name"><a title="apiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-141', 'BatchError', 'link-2');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Invalid value for Content-ID: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">header</tt><tt class="py-op">)</tt> </tt> |
| 1229 | <a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">id_</tt> <tt class="py-op">=</tt> <tt class="py-name">header</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">rsplit</tt><tt class="py-op">(</tt><tt class="py-string">'+'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt> |
| 1230 | <a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> </tt> |
| 1231 | <a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">unquote</tt><tt class="py-op">(</tt><tt class="py-name">id_</tt><tt class="py-op">)</tt> </tt> |
| 1232 | </div><a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> </tt> |
| 1233 | <a name="BatchHttpRequest._serialize_request"></a><div id="BatchHttpRequest._serialize_request-def"><a name="L941"></a><tt class="py-lineno"> 941</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._serialize_request-toggle" onclick="return toggle('BatchHttpRequest._serialize_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_serialize_request">_serialize_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1234 | </div><div id="BatchHttpRequest._serialize_request-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._serialize_request-expanded"><a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert an HttpRequest object into a string.</tt> </tt> |
| 1235 | <a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1236 | <a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1237 | <a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-docstring"> request: HttpRequest, the request to serialize.</tt> </tt> |
| 1238 | <a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1239 | <a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1240 | <a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> The request as a string in application/http format.</tt> </tt> |
| 1241 | <a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1242 | <a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-comment"># Construct status line</tt> </tt> |
| 1243 | <a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-name">parsed</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt id="link-142" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1244 | apiclient.http.HttpMockSequence.request |
| 1245 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1246 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-142', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1247 | <a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt class="py-name">request_line</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlunparse</tt><tt class="py-op">(</tt> </tt> |
| 1248 | <a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">parsed</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">parsed</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">parsed</tt><tt class="py-op">.</tt><tt class="py-name">query</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 1249 | <a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt> |
| 1250 | <a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-name">status_line</tt> <tt class="py-op">=</tt> <tt id="link-143" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1251 | apiclient.http.HttpMockSequence.request |
| 1252 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1253 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-143', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">request_line</tt> <tt class="py-op">+</tt> <tt class="py-string">' HTTP/1.1\n'</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1254 | <a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-name">major</tt><tt class="py-op">,</tt> <tt class="py-name">minor</tt> <tt class="py-op">=</tt> <tt id="link-144" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1255 | apiclient.http.HttpMockSequence.request |
| 1256 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1257 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-144', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1258 | oauth2client.appengine.OAuth2Handler.get |
| 1259 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1260 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-145', 'get', 'link-63');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'content-type'</tt><tt class="py-op">,</tt> <tt class="py-string">'application/json'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1261 | <a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-name">major</tt><tt class="py-op">,</tt> <tt class="py-name">minor</tt><tt class="py-op">)</tt> </tt> |
| 1262 | <a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt id="link-146" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1263 | apiclient.http.HttpMockSequence.request |
| 1264 | apiclient.model.BaseModel.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1265 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-146', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1266 | <a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> </tt> |
| 1267 | <a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-147" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1268 | apiclient.http.HttpMockSequence.request |
| 1269 | apiclient.model.BaseModel.request |
| 1270 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-147', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="apiclient.http |
| 1271 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-148', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-149" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1272 | apiclient.http.HttpMockSequence.request |
| 1273 | apiclient.model.BaseModel.request |
| 1274 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-149', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-150" class="py-name"><a title="apiclient.http |
| 1275 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-150', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-151" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1276 | apiclient.http.HttpMockSequence.request |
| 1277 | apiclient.model.BaseModel.request |
| 1278 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-151', 'request', 'link-45');">request</a></tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1279 | <a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1280 | <a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt id="link-152" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1281 | apiclient.http.HttpMockSequence.request |
| 1282 | apiclient.model.BaseModel.request |
| 1283 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-152', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="apiclient.http |
| 1284 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-153', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1285 | apiclient.http.HttpMockSequence.request |
| 1286 | apiclient.model.BaseModel.request |
| 1287 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-154', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-155', 'credentials', 'link-124');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="oauth2client.client.Credentials.apply |
| 1288 | oauth2client.client.OAuth2Credentials.apply" class="py-name" href="#" onclick="return doclink('link-156', 'apply', 'link-138');">apply</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1289 | <a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"> </tt> |
| 1290 | <a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"> <tt class="py-comment"># MIMENonMultipart adds its own Content-Type header.</tt> </tt> |
| 1291 | <a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'content-type'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt> |
| 1292 | <a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> </tt> |
| 1293 | <a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> </tt> |
| 1294 | <a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1295 | <a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt> |
| 1296 | <a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Host'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">parsed</tt><tt class="py-op">.</tt><tt class="py-name">netloc</tt> </tt> |
| 1297 | <a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_unixfrom</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 1298 | <a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"> </tt> |
| 1299 | <a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-157" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1300 | apiclient.http.HttpMockSequence.request |
| 1301 | apiclient.model.BaseModel.request |
| 1302 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-157', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">body</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1303 | <a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt id="link-158" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1304 | apiclient.http.HttpMockSequence.request |
| 1305 | apiclient.model.BaseModel.request |
| 1306 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-158', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1307 | <a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'content-length'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-159" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1308 | apiclient.http.HttpMockSequence.request |
| 1309 | apiclient.model.BaseModel.request |
| 1310 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-159', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">body</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1311 | <a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> </tt> |
| 1312 | <a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-comment"># Serialize the mime message.</tt> </tt> |
| 1313 | <a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">.</tt><tt class="py-name">StringIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1314 | <a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-comment"># maxheaderlen=0 means don't line wrap headers.</tt> </tt> |
| 1315 | <a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt class="py-name">Generator</tt><tt class="py-op">(</tt><tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt class="py-name">maxheaderlen</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt> |
| 1316 | <a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-name">g</tt><tt class="py-op">.</tt><tt class="py-name">flatten</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt class="py-name">unixfrom</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt> |
| 1317 | <a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">fp</tt><tt class="py-op">.</tt><tt class="py-name">getvalue</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1318 | <a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> </tt> |
| 1319 | <a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-comment"># Strip off the \n\n that the MIME lib tacks onto the end of the payload.</tt> </tt> |
| 1320 | <a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-160" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1321 | apiclient.http.HttpMockSequence.request |
| 1322 | apiclient.model.BaseModel.request |
| 1323 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-160', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">body</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1324 | <a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">body</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt> |
| 1325 | <a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> </tt> |
| 1326 | <a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">status_line</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">body</tt> </tt> |
| 1327 | </div><a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> </tt> |
| 1328 | <a name="BatchHttpRequest._deserialize_response"></a><div id="BatchHttpRequest._deserialize_response-def"><a name="L990"></a><tt class="py-lineno"> 990</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._deserialize_response-toggle" onclick="return toggle('BatchHttpRequest._deserialize_response');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_deserialize_response">_deserialize_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">payload</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1329 | </div><div id="BatchHttpRequest._deserialize_response-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._deserialize_response-expanded"><a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-docstring">"""Convert string into httplib2 response and content.</tt> </tt> |
| 1330 | <a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1331 | <a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1332 | <a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-docstring"> payload: string, headers and body as a string.</tt> </tt> |
| 1333 | <a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1334 | <a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1335 | <a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"><tt class="py-docstring"> A pair (resp, content), such as would be returned from httplib2.request.</tt> </tt> |
| 1336 | <a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1337 | <a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-comment"># Strip off the status line</tt> </tt> |
| 1338 | <a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt class="py-name">status_line</tt><tt class="py-op">,</tt> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt> |
| 1339 | <a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-name">protocol</tt><tt class="py-op">,</tt> <tt class="py-name">status</tt><tt class="py-op">,</tt> <tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">status_line</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt> </tt> |
| 1340 | <a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> </tt> |
| 1341 | <a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> <tt class="py-comment"># Parse the rest of the response</tt> </tt> |
| 1342 | <a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1343 | <a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt> |
| 1344 | <a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1345 | <a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">status</tt> </tt> |
| 1346 | <a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> </tt> |
| 1347 | <a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-comment"># Create httplib2.Response from the parsed headers.</tt> </tt> |
| 1348 | <a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt> |
| 1349 | <a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">reason</tt> </tt> |
| 1350 | <a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">protocol</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1351 | <a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> </tt> |
| 1352 | <a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\r\n\r\n'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt> |
| 1353 | <a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> </tt> |
| 1354 | <a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt> |
| 1355 | </div><a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> </tt> |
| 1356 | <a name="BatchHttpRequest._new_id"></a><div id="BatchHttpRequest._new_id-def"><a name="L1018"></a><tt class="py-lineno">1018</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._new_id-toggle" onclick="return toggle('BatchHttpRequest._new_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_new_id">_new_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1357 | </div><div id="BatchHttpRequest._new_id-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._new_id-expanded"><a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new id.</tt> </tt> |
| 1358 | <a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1359 | <a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-docstring"> Auto incrementing number that avoids conflicts with ids already used.</tt> </tt> |
| 1360 | <a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1361 | <a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1362 | <a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"><tt class="py-docstring"> string, a new unique id.</tt> </tt> |
| 1363 | <a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1364 | <a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt> |
| 1365 | <a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt> |
| 1366 | <a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt> |
| 1367 | <a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_auto_id</tt><tt class="py-op">)</tt> </tt> |
| 1368 | </div><a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> </tt> |
| 1369 | <a name="BatchHttpRequest.add"></a><div id="BatchHttpRequest.add-def"><a name="L1031"></a><tt class="py-lineno">1031</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.add-toggle" onclick="return toggle('BatchHttpRequest.add');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#add">add</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">request_id</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1370 | </div><div id="BatchHttpRequest.add-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest.add-expanded"><a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-docstring">"""Add a new request.</tt> </tt> |
| 1371 | <a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1372 | <a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"> Every callback added will be paired with a unique id, the request_id. That</tt> </tt> |
| 1373 | <a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"> unique id will be passed back to the callback when the response comes back</tt> </tt> |
| 1374 | <a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-docstring"> from the server. The default behavior is to have the library generate it's</tt> </tt> |
| 1375 | <a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-docstring"> own unique id. If the caller passes in a request_id then they must ensure</tt> </tt> |
| 1376 | <a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-docstring"> uniqueness for each request_id, and if they are not an exception is</tt> </tt> |
| 1377 | <a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"> raised. Callers should either supply all request_ids or nevery supply a</tt> </tt> |
| 1378 | <a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"> request id, to avoid such an error.</tt> </tt> |
| 1379 | <a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1380 | <a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1381 | <a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-docstring"> request: HttpRequest, Request to add to the batch.</tt> </tt> |
| 1382 | <a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt class="py-docstring"> callback: callable, A callback to be called for this response, of the</tt> </tt> |
| 1383 | <a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"><tt class="py-docstring"> form callback(id, response, exception). The first parameter is the</tt> </tt> |
| 1384 | <a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt class="py-docstring"> request id, and the second is the deserialized response object. The</tt> </tt> |
| 1385 | <a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt class="py-docstring"> third is an apiclient.errors.HttpError exception object if an HTTP error</tt> </tt> |
| 1386 | <a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"><tt class="py-docstring"> occurred while processing the request, or None if no errors occurred.</tt> </tt> |
| 1387 | <a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-docstring"> request_id: string, A unique id for the request. The id will be passed to</tt> </tt> |
| 1388 | <a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt class="py-docstring"> the callback with the response.</tt> </tt> |
| 1389 | <a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1390 | <a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1391 | <a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-docstring"> None</tt> </tt> |
| 1392 | <a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1393 | <a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1394 | <a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"><tt class="py-docstring"> BatchError if a media request is added to a batch.</tt> </tt> |
| 1395 | <a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"><tt class="py-docstring"> KeyError is the request_id is not unique.</tt> </tt> |
| 1396 | <a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1397 | <a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1398 | <a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name" targets="Method apiclient.http.BatchHttpRequest._new_id()=apiclient.http.BatchHttpRequest-class.html#_new_id"><a title="apiclient.http.BatchHttpRequest._new_id" class="py-name" href="#" onclick="return doclink('link-161', '_new_id', 'link-161');">_new_id</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1399 | <a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-162" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1400 | apiclient.http.HttpMockSequence.request |
| 1401 | apiclient.model.BaseModel.request |
| 1402 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-162', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-163" class="py-name"><a title="apiclient.http.MediaFileUpload.resumable |
| 1403 | apiclient.http.MediaInMemoryUpload.resumable |
| 1404 | apiclient.http.MediaIoBaseUpload.resumable |
| 1405 | apiclient.http.MediaUpload.resumable" class="py-name" href="#" onclick="return doclink('link-163', 'resumable', 'link-28');">resumable</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1406 | <a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-164" class="py-name"><a title="apiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-164', 'BatchError', 'link-2');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Media requests cannot be used in a batch request."</tt><tt class="py-op">)</tt> </tt> |
| 1407 | <a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">:</tt> </tt> |
| 1408 | <a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">KeyError</tt><tt class="py-op">(</tt><tt class="py-string">"A request with this ID already exists: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt> |
| 1409 | <a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-165" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1410 | apiclient.http.HttpMockSequence.request |
| 1411 | apiclient.model.BaseModel.request |
| 1412 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-165', 'request', 'link-45');">request</a></tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1413 | <a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">callback</tt> </tt> |
| 1414 | <a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt> |
| 1415 | </div><a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> </tt> |
| 1416 | <a name="BatchHttpRequest._execute"></a><div id="BatchHttpRequest._execute-def"><a name="L1069"></a><tt class="py-lineno">1069</tt> <a class="py-toggle" href="#" id="BatchHttpRequest._execute-toggle" onclick="return toggle('BatchHttpRequest._execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#_execute">_execute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">order</tt><tt class="py-op">,</tt> <tt class="py-param">requests</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1417 | </div><div id="BatchHttpRequest._execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest._execute-expanded"><a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-docstring">"""Serialize batch request, send to server, process response.</tt> </tt> |
| 1418 | <a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1419 | <a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1420 | <a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used to make the request with.</tt> </tt> |
| 1421 | <a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> order: list, list of request ids in the order they were added to the</tt> </tt> |
| 1422 | <a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-docstring"> batch.</tt> </tt> |
| 1423 | <a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"><tt class="py-docstring"> request: list, list of request objects to send.</tt> </tt> |
| 1424 | <a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1425 | <a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1426 | <a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Error if a transport error has occured.</tt> </tt> |
| 1427 | <a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.BatchError if the response is the wrong format.</tt> </tt> |
| 1428 | <a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1429 | <a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMEMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'mixed'</tt><tt class="py-op">)</tt> </tt> |
| 1430 | <a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-comment"># Message should not write out it's own headers.</tt> </tt> |
| 1431 | <a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-string">'_write_headers'</tt><tt class="py-op">,</tt> <tt class="py-keyword">lambda</tt> <tt class="py-name">self</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 1432 | <a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> </tt> |
| 1433 | <a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-comment"># Add all the individual requests.</tt> </tt> |
| 1434 | <a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">order</tt><tt class="py-op">:</tt> </tt> |
| 1435 | <a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt id="link-166" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1436 | apiclient.http.HttpMockSequence.request |
| 1437 | apiclient.model.BaseModel.request |
| 1438 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-166', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1439 | <a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> </tt> |
| 1440 | <a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-name">MIMENonMultipart</tt><tt class="py-op">(</tt><tt class="py-string">'application'</tt><tt class="py-op">,</tt> <tt class="py-string">'http'</tt><tt class="py-op">)</tt> </tt> |
| 1441 | <a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-Transfer-Encoding'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'binary'</tt> </tt> |
| 1442 | <a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-167" class="py-name" targets="Method apiclient.http.BatchHttpRequest._id_to_header()=apiclient.http.BatchHttpRequest-class.html#_id_to_header"><a title="apiclient.http.BatchHttpRequest._id_to_header" class="py-name" href="#" onclick="return doclink('link-167', '_id_to_header', 'link-167');">_id_to_header</a></tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt> |
| 1443 | <a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> </tt> |
| 1444 | <a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name" targets="Method apiclient.http.BatchHttpRequest._serialize_request()=apiclient.http.BatchHttpRequest-class.html#_serialize_request"><a title="apiclient.http.BatchHttpRequest._serialize_request" class="py-name" href="#" onclick="return doclink('link-168', '_serialize_request', 'link-168');">_serialize_request</a></tt><tt class="py-op">(</tt><tt id="link-169" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1445 | apiclient.http.HttpMockSequence.request |
| 1446 | apiclient.model.BaseModel.request |
| 1447 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-169', 'request', 'link-45');">request</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1448 | <a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">.</tt><tt class="py-name">set_payload</tt><tt class="py-op">(</tt><tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| 1449 | <a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">attach</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt> |
| 1450 | <a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> </tt> |
| 1451 | <a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">as_string</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1452 | <a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> </tt> |
| 1453 | <a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1454 | <a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'multipart/mixed; '</tt> </tt> |
| 1455 | <a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-string">'boundary="%s"'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-name">message</tt><tt class="py-op">.</tt><tt class="py-name">get_boundary</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1456 | <a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> </tt> |
| 1457 | <a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-170" class="py-name"><a title="apiclient.http |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1458 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-170', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1459 | apiclient.http.HttpMockSequence.request |
| 1460 | apiclient.model.BaseModel.request |
| 1461 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-171', 'request', 'link-45');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">,</tt> <tt class="py-string">'POST'</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">=</tt><tt class="py-name">body</tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1462 | <a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1463 | <a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1464 | <a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt> <tt class="py-op">>=</tt> <tt class="py-number">300</tt><tt class="py-op">:</tt> </tt> |
| 1465 | <a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-172" class="py-name"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-172', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_batch_uri</tt><tt class="py-op">)</tt> </tt> |
| 1466 | <a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> </tt> |
| 1467 | <a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-comment"># Now break out the individual responses and store each one.</tt> </tt> |
| 1468 | <a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">boundary</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt> |
| 1469 | <a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> </tt> |
| 1470 | <a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-comment"># Prepend with a content-type header so FeedParser can handle it.</tt> </tt> |
| 1471 | <a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-name">header</tt> <tt class="py-op">=</tt> <tt class="py-string">'content-type: %s\r\n\r\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'content-type'</tt><tt class="py-op">]</tt> </tt> |
| 1472 | <a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"> <tt class="py-name">for_parser</tt> <tt class="py-op">=</tt> <tt class="py-name">header</tt> <tt class="py-op">+</tt> <tt class="py-name">content</tt> </tt> |
| 1473 | <a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"> </tt> |
| 1474 | <a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> <tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt class="py-name">FeedParser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1475 | <a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">feed</tt><tt class="py-op">(</tt><tt class="py-name">for_parser</tt><tt class="py-op">)</tt> </tt> |
| 1476 | <a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"> <tt class="py-name">mime_response</tt> <tt class="py-op">=</tt> <tt class="py-name">parser</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1477 | <a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"> </tt> |
| 1478 | <a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">is_multipart</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1479 | <a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-173" class="py-name"><a title="apiclient.errors.BatchError" class="py-name" href="#" onclick="return doclink('link-173', 'BatchError', 'link-2');">BatchError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Response not in multipart/mixed format."</tt><tt class="py-op">,</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> </tt> |
| 1480 | <a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1481 | <a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> </tt> |
| 1482 | <a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">mime_response</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1483 | <a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-name">request_id</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name" targets="Method apiclient.http.BatchHttpRequest._header_to_id()=apiclient.http.BatchHttpRequest-class.html#_header_to_id"><a title="apiclient.http.BatchHttpRequest._header_to_id" class="py-name" href="#" onclick="return doclink('link-174', '_header_to_id', 'link-174');">_header_to_id</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">[</tt><tt class="py-string">'Content-ID'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1484 | <a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt id="link-175" class="py-name" targets="Method apiclient.model.BaseModel.response()=apiclient.model.BaseModel-class.html#response,Method apiclient.model.Model.response()=apiclient.model.Model-class.html#response"><a title="apiclient.model.BaseModel.response |
| 1485 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-175', 'response', 'link-175');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name" targets="Method apiclient.http.BatchHttpRequest._deserialize_response()=apiclient.http.BatchHttpRequest-class.html#_deserialize_response"><a title="apiclient.http.BatchHttpRequest._deserialize_response" class="py-name" href="#" onclick="return doclink('link-176', '_deserialize_response', 'link-176');">_deserialize_response</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">.</tt><tt class="py-name">get_payload</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1486 | <a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-177" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1487 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-177', 'response', 'link-175');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1488 | </div><a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> </tt> |
| 1489 | <a name="BatchHttpRequest.execute"></a><div id="BatchHttpRequest.execute-def"><a name="L1130"></a><tt class="py-lineno">1130</tt> <a class="py-toggle" href="#" id="BatchHttpRequest.execute-toggle" onclick="return toggle('BatchHttpRequest.execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.BatchHttpRequest-class.html#execute">execute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1490 | </div><div id="BatchHttpRequest.execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="BatchHttpRequest.execute-expanded"><a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"> <tt class="py-docstring">"""Execute all the requests as a single batched HTTP request.</tt> </tt> |
| 1491 | <a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1492 | <a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1493 | <a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used in place of the one the</tt> </tt> |
| 1494 | <a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"><tt class="py-docstring"> HttpRequest request object was constructed with. If one isn't supplied</tt> </tt> |
| 1495 | <a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"><tt class="py-docstring"> then use a http object from the requests in this batch.</tt> </tt> |
| 1496 | <a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1497 | <a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1498 | <a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"><tt class="py-docstring"> None</tt> </tt> |
| 1499 | <a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1500 | <a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1501 | <a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Error if a transport error has occured.</tt> </tt> |
| 1502 | <a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.errors.BatchError if the response is the wrong format.</tt> </tt> |
| 1503 | <a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1504 | <a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> </tt> |
| 1505 | <a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt class="py-comment"># If http is not supplied use the first valid one given in the requests.</tt> </tt> |
| 1506 | <a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-178" class="py-name"><a title="apiclient.http |
| 1507 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-178', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1508 | <a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">:</tt> </tt> |
| 1509 | <a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1510 | apiclient.http.HttpMockSequence.request |
| 1511 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1512 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-179', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1513 | <a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-180" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1514 | apiclient.http.HttpMockSequence.request |
| 1515 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1516 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-180', 'request', 'link-45');">request</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1517 | <a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt id="link-181" class="py-name"><a title="apiclient.http |
| 1518 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-181', 'http', 'link-48');">http</a></tt> <tt class="py-op">=</tt> <tt id="link-182" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1519 | apiclient.http.HttpMockSequence.request |
| 1520 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1521 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-182', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt id="link-183" class="py-name"><a title="apiclient.http |
| 1522 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-183', 'http', 'link-48');">http</a></tt> </tt> |
| 1523 | <a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt> |
| 1524 | <a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> </tt> |
| 1525 | <a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-184" class="py-name"><a title="apiclient.http |
| 1526 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-184', 'http', 'link-48');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1527 | <a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Missing a valid http object."</tt><tt class="py-op">)</tt> </tt> |
| 1528 | <a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> </tt> |
| 1529 | <a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-185" class="py-name" targets="Method apiclient.http.BatchHttpRequest._execute()=apiclient.http.BatchHttpRequest-class.html#_execute"><a title="apiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-185', '_execute', 'link-185');">_execute</a></tt><tt class="py-op">(</tt><tt id="link-186" class="py-name"><a title="apiclient.http |
| 1530 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-186', 'http', 'link-48');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">)</tt> </tt> |
| 1531 | <a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> </tt> |
| 1532 | <a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"> <tt class="py-comment"># Loop over all the requests and check for 401s. For each 401 request the</tt> </tt> |
| 1533 | <a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"> <tt class="py-comment"># credentials should be refreshed and then sent again in a separate batch.</tt> </tt> |
| 1534 | <a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-name">redo_requests</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1535 | <a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-name">redo_order</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt> |
| 1536 | <a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> </tt> |
| 1537 | <a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">:</tt> </tt> |
| 1538 | <a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1539 | <a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'401'</tt><tt class="py-op">:</tt> </tt> |
| 1540 | <a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">redo_order</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">)</tt> </tt> |
| 1541 | <a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt id="link-187" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1542 | apiclient.http.HttpMockSequence.request |
| 1543 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1544 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-187', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1545 | <a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-188" class="py-name" targets="Method apiclient.http.BatchHttpRequest._refresh_and_apply_credentials()=apiclient.http.BatchHttpRequest-class.html#_refresh_and_apply_credentials"><a title="apiclient.http.BatchHttpRequest._refresh_and_apply_credentials" class="py-name" href="#" onclick="return doclink('link-188', '_refresh_and_apply_credentials', 'link-188');">_refresh_and_apply_credentials</a></tt><tt class="py-op">(</tt><tt id="link-189" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1546 | apiclient.http.HttpMockSequence.request |
| 1547 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1548 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-189', 'request', 'link-45');">request</a></tt><tt class="py-op">,</tt> <tt id="link-190" class="py-name"><a title="apiclient.http |
| 1549 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-190', 'http', 'link-48');">http</a></tt><tt class="py-op">)</tt> </tt> |
| 1550 | <a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-name">redo_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-191" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1551 | apiclient.http.HttpMockSequence.request |
| 1552 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1553 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-191', 'request', 'link-45');">request</a></tt> </tt> |
| 1554 | <a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> </tt> |
| 1555 | <a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">redo_requests</tt><tt class="py-op">:</tt> </tt> |
| 1556 | <a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name"><a title="apiclient.http.BatchHttpRequest._execute" class="py-name" href="#" onclick="return doclink('link-192', '_execute', 'link-185');">_execute</a></tt><tt class="py-op">(</tt><tt id="link-193" class="py-name"><a title="apiclient.http |
| 1557 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-193', 'http', 'link-48');">http</a></tt><tt class="py-op">,</tt> <tt class="py-name">redo_order</tt><tt class="py-op">,</tt> <tt class="py-name">redo_requests</tt><tt class="py-op">)</tt> </tt> |
| 1558 | <a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> </tt> |
| 1559 | <a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"> <tt class="py-comment"># Now process all callbacks that are erroring, and raise an exception for</tt> </tt> |
| 1560 | <a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt class="py-comment"># ones that return a non-2xx response? Or add extra parameter to callback</tt> </tt> |
| 1561 | <a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-comment"># that contains an HttpError?</tt> </tt> |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1562 | <a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1563 | <a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">request_id</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_order</tt><tt class="py-op">:</tt> </tt> |
| 1564 | <a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_responses</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1565 | <a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> </tt> |
| 1566 | <a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> <tt id="link-194" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1567 | apiclient.http.HttpMockSequence.request |
| 1568 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1569 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-194', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_requests</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1570 | <a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> <tt class="py-name">callback</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callbacks</tt><tt class="py-op">[</tt><tt class="py-name">request_id</tt><tt class="py-op">]</tt> </tt> |
| 1571 | <a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"> </tt> |
| 1572 | <a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> <tt id="link-195" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1573 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-195', 'response', 'link-175');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1574 | <a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">exception</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1575 | <a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 1576 | <a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt id="link-196" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1577 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-196', 'response', 'link-175');">response</a></tt> <tt class="py-op">=</tt> <tt id="link-197" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1578 | apiclient.http.HttpMockSequence.request |
| 1579 | apiclient.model.BaseModel.request |
| 1580 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-197', 'request', 'link-45');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1581 | <a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-198" class="py-name"><a title="apiclient.errors.HttpError" class="py-name" href="#" onclick="return doclink('link-198', 'HttpError', 'link-4');">HttpError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt> |
| 1582 | <a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"> <tt class="py-name">exception</tt> <tt class="py-op">=</tt> <tt class="py-name">e</tt> </tt> |
| 1583 | <a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"> </tt> |
| 1584 | <a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1585 | <a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> <tt class="py-name">callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-199" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1586 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-199', 'response', 'link-175');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt> |
| 1587 | <a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1588 | <a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback</tt><tt class="py-op">(</tt><tt class="py-name">request_id</tt><tt class="py-op">,</tt> <tt id="link-200" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1589 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-200', 'response', 'link-175');">response</a></tt><tt class="py-op">,</tt> <tt class="py-name">exception</tt><tt class="py-op">)</tt> </tt> |
| 1590 | </div></div><a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> </tt> |
| 1591 | <a name="HttpRequestMock"></a><div id="HttpRequestMock-def"><a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"> </tt> |
| 1592 | <a name="L1198"></a><tt class="py-lineno">1198</tt> <a class="py-toggle" href="#" id="HttpRequestMock-toggle" onclick="return toggle('HttpRequestMock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.HttpRequestMock-class.html">HttpRequestMock</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1593 | </div><div id="HttpRequestMock-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="HttpRequestMock-expanded"><a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-docstring">"""Mock of HttpRequest.</tt> </tt> |
| 1594 | <a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1595 | <a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"><tt class="py-docstring"> Do not construct directly, instead use RequestMockBuilder.</tt> </tt> |
| 1596 | <a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1597 | <a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> </tt> |
| 1598 | <a name="HttpRequestMock.__init__"></a><div id="HttpRequestMock.__init__-def"><a name="L1204"></a><tt class="py-lineno">1204</tt> <a class="py-toggle" href="#" id="HttpRequestMock.__init__-toggle" onclick="return toggle('HttpRequestMock.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequestMock-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">resp</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">,</tt> <tt class="py-param">postproc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1599 | </div><div id="HttpRequestMock.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequestMock.__init__-expanded"><a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for HttpRequestMock</tt> </tt> |
| 1600 | <a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1601 | <a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1602 | <a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"><tt class="py-docstring"> resp: httplib2.Response, the response to emulate coming from the request</tt> </tt> |
| 1603 | <a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"><tt class="py-docstring"> content: string, the response body</tt> </tt> |
| 1604 | <a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"><tt class="py-docstring"> postproc: callable, the post processing function usually supplied by</tt> </tt> |
| 1605 | <a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-docstring"> the model class. See model.JsonModel.response() as an example.</tt> </tt> |
| 1606 | <a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1607 | <a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt> </tt> |
| 1608 | <a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt> </tt> |
| 1609 | <a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt> <tt class="py-op">=</tt> <tt class="py-name">postproc</tt> </tt> |
| 1610 | <a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1611 | <a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'status'</tt><tt class="py-op">:</tt> <tt class="py-number">200</tt><tt class="py-op">,</tt> <tt class="py-string">'reason'</tt><tt class="py-op">:</tt> <tt class="py-string">'OK'</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt> |
| 1612 | <a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'reason'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 1613 | <a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">reason</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'reason'</tt><tt class="py-op">]</tt> </tt> |
| 1614 | </div><a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> </tt> |
| 1615 | <a name="HttpRequestMock.execute"></a><div id="HttpRequestMock.execute-def"><a name="L1221"></a><tt class="py-lineno">1221</tt> <a class="py-toggle" href="#" id="HttpRequestMock.execute-toggle" onclick="return toggle('HttpRequestMock.execute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpRequestMock-class.html#execute">execute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1616 | </div><div id="HttpRequestMock.execute-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpRequestMock.execute-expanded"><a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-docstring">"""Execute the request.</tt> </tt> |
| 1617 | <a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1618 | <a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"><tt class="py-docstring"> Same behavior as HttpRequest.execute(), but the response is</tt> </tt> |
| 1619 | <a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"><tt class="py-docstring"> mocked and not really from an HTTP request/response.</tt> </tt> |
| 1620 | <a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1621 | <a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">postproc</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1622 | </div></div><a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> </tt> |
| 1623 | <a name="RequestMockBuilder"></a><div id="RequestMockBuilder-def"><a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> </tt> |
| 1624 | <a name="L1230"></a><tt class="py-lineno">1230</tt> <a class="py-toggle" href="#" id="RequestMockBuilder-toggle" onclick="return toggle('RequestMockBuilder');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.RequestMockBuilder-class.html">RequestMockBuilder</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1625 | </div><div id="RequestMockBuilder-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="RequestMockBuilder-expanded"><a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"> <tt class="py-docstring">"""A simple mock of HttpRequest</tt> </tt> |
| 1626 | <a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1627 | <a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"><tt class="py-docstring"> Pass in a dictionary to the constructor that maps request methodIds to</tt> </tt> |
| 1628 | <a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"><tt class="py-docstring"> tuples of (httplib2.Response, content, opt_expected_body) that should be</tt> </tt> |
| 1629 | <a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"><tt class="py-docstring"> returned when that method is called. None may also be passed in for the</tt> </tt> |
| 1630 | <a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Response, in which case a 200 OK response will be generated.</tt> </tt> |
| 1631 | <a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"><tt class="py-docstring"> If an opt_expected_body (str or dict) is provided, it will be compared to</tt> </tt> |
| 1632 | <a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"><tt class="py-docstring"> the body and UnexpectedBodyError will be raised on inequality.</tt> </tt> |
| 1633 | <a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1634 | <a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 1635 | <a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"><tt class="py-docstring"> response = '{"data": {"id": "tag:google.c...'</tt> </tt> |
| 1636 | <a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"><tt class="py-docstring"> requestBuilder = RequestMockBuilder(</tt> </tt> |
| 1637 | <a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-docstring"> {</tt> </tt> |
| 1638 | <a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-docstring"> 'plus.activities.get': (None, response),</tt> </tt> |
| 1639 | <a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"><tt class="py-docstring"> }</tt> </tt> |
| 1640 | <a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"><tt class="py-docstring"> )</tt> </tt> |
| 1641 | <a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"><tt class="py-docstring"> apiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)</tt> </tt> |
| 1642 | <a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1643 | <a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"> Methods that you do not supply a response for will return a</tt> </tt> |
| 1644 | <a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-docstring"> 200 OK with an empty string as the response content or raise an excpetion</tt> </tt> |
| 1645 | <a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"><tt class="py-docstring"> if check_unexpected is set to True. The methodId is taken from the rpcName</tt> </tt> |
| 1646 | <a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"><tt class="py-docstring"> in the discovery document.</tt> </tt> |
| 1647 | <a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1648 | <a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-docstring"> For more details see the project wiki.</tt> </tt> |
| 1649 | <a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1650 | <a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"> </tt> |
| 1651 | <a name="RequestMockBuilder.__init__"></a><div id="RequestMockBuilder.__init__-def"><a name="L1257"></a><tt class="py-lineno">1257</tt> <a class="py-toggle" href="#" id="RequestMockBuilder.__init__-toggle" onclick="return toggle('RequestMockBuilder.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.RequestMockBuilder-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">responses</tt><tt class="py-op">,</tt> <tt class="py-param">check_unexpected</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1652 | </div><div id="RequestMockBuilder.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="RequestMockBuilder.__init__-expanded"><a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for RequestMockBuilder</tt> </tt> |
| 1653 | <a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1654 | <a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"><tt class="py-docstring"> The constructed object should be a callable object</tt> </tt> |
| 1655 | <a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"><tt class="py-docstring"> that can replace the class HttpResponse.</tt> </tt> |
| 1656 | <a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1657 | <a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"><tt class="py-docstring"> responses - A dictionary that maps methodIds into tuples</tt> </tt> |
| 1658 | <a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"><tt class="py-docstring"> of (httplib2.Response, content). The methodId</tt> </tt> |
| 1659 | <a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"><tt class="py-docstring"> comes from the 'rpcName' field in the discovery</tt> </tt> |
| 1660 | <a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"><tt class="py-docstring"> document.</tt> </tt> |
| 1661 | <a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"><tt class="py-docstring"> check_unexpected - A boolean setting whether or not UnexpectedMethodError</tt> </tt> |
| 1662 | <a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"><tt class="py-docstring"> should be raised on unsupplied method.</tt> </tt> |
| 1663 | <a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1664 | <a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt> <tt class="py-op">=</tt> <tt class="py-name">responses</tt> </tt> |
| 1665 | <a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">check_unexpected</tt> <tt class="py-op">=</tt> <tt class="py-name">check_unexpected</tt> </tt> |
| 1666 | </div><a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> </tt> |
| 1667 | <a name="RequestMockBuilder.__call__"></a><div id="RequestMockBuilder.__call__-def"><a name="L1273"></a><tt class="py-lineno">1273</tt> <a class="py-toggle" href="#" id="RequestMockBuilder.__call__-toggle" onclick="return toggle('RequestMockBuilder.__call__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.RequestMockBuilder-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">postproc</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1668 | <a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">methodId</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">resumable</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1669 | </div><div id="RequestMockBuilder.__call__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="RequestMockBuilder.__call__-expanded"><a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-docstring">"""Implements the callable interface that discovery.build() expects</tt> </tt> |
| 1670 | <a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"><tt class="py-docstring"> of requestBuilder, which is to build an object compatible with</tt> </tt> |
| 1671 | <a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"><tt class="py-docstring"> HttpRequest.execute(). See that method for the description of the</tt> </tt> |
| 1672 | <a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"><tt class="py-docstring"> parameters and the expected response.</tt> </tt> |
| 1673 | <a name="L1279"></a><tt class="py-lineno">1279</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1674 | <a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">methodId</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt><tt class="py-op">:</tt> </tt> |
| 1675 | <a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> <tt id="link-201" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1676 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-201', 'response', 'link-175');">response</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">responses</tt><tt class="py-op">[</tt><tt class="py-name">methodId</tt><tt class="py-op">]</tt> </tt> |
| 1677 | <a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt id="link-202" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1678 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-202', 'response', 'link-175');">response</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt> |
| 1679 | <a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-203" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1680 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-203', 'response', 'link-175');">response</a></tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt> |
| 1681 | <a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"> <tt class="py-comment"># Test the body against the supplied expected_body.</tt> </tt> |
| 1682 | <a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"> <tt class="py-name">expected_body</tt> <tt class="py-op">=</tt> <tt id="link-204" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1683 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-204', 'response', 'link-175');">response</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt> </tt> |
| 1684 | <a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">body</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1685 | <a name="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"> <tt class="py-comment"># Not expecting a body and provided one</tt> </tt> |
| 1686 | <a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> <tt class="py-comment"># or expecting a body and not provided one.</tt> </tt> |
| 1687 | <a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-205" class="py-name"><a title="apiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-205', 'UnexpectedBodyError', 'link-8');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| 1688 | <a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1689 | <a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> <tt class="py-name">expected_body</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-206', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">)</tt> </tt> |
| 1690 | <a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-207', 'loads', 'link-17');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| 1691 | <a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">body</tt> <tt class="py-op">!=</tt> <tt class="py-name">expected_body</tt><tt class="py-op">:</tt> </tt> |
| 1692 | <a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-208" class="py-name"><a title="apiclient.errors.UnexpectedBodyError" class="py-name" href="#" onclick="return doclink('link-208', 'UnexpectedBodyError', 'link-8');">UnexpectedBodyError</a></tt><tt class="py-op">(</tt><tt class="py-name">expected_body</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">)</tt> </tt> |
| 1693 | <a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-209" class="py-name" targets="Class apiclient.http.HttpRequestMock=apiclient.http.HttpRequestMock-class.html"><a title="apiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-209', 'HttpRequestMock', 'link-209');">HttpRequestMock</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">postproc</tt><tt class="py-op">)</tt> </tt> |
| 1694 | <a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">check_unexpected</tt><tt class="py-op">:</tt> </tt> |
| 1695 | <a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-210" class="py-name"><a title="apiclient.errors.UnexpectedMethodError" class="py-name" href="#" onclick="return doclink('link-210', 'UnexpectedMethodError', 'link-10');">UnexpectedMethodError</a></tt><tt class="py-op">(</tt><tt class="py-name">methodId</tt><tt class="py-op">)</tt> </tt> |
| 1696 | <a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1697 | <a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> <tt id="link-211" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-211', 'model', 'link-11');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-212" class="py-name"><a title="apiclient.model.JsonModel" class="py-name" href="#" onclick="return doclink('link-212', 'JsonModel', 'link-12');">JsonModel</a></tt><tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt> |
| 1698 | <a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-213" class="py-name"><a title="apiclient.http.HttpRequestMock" class="py-name" href="#" onclick="return doclink('link-213', 'HttpRequestMock', 'link-209');">HttpRequestMock</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-string">'{}'</tt><tt class="py-op">,</tt> <tt id="link-214" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-214', 'model', 'link-11');">model</a></tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1699 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-215', 'response', 'link-175');">response</a></tt><tt class="py-op">)</tt> </tt> |
| 1700 | </div></div><a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"> </tt> |
| 1701 | <a name="HttpMock"></a><div id="HttpMock-def"><a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> </tt> |
| 1702 | <a name="L1303"></a><tt class="py-lineno">1303</tt> <a class="py-toggle" href="#" id="HttpMock-toggle" onclick="return toggle('HttpMock');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.HttpMock-class.html">HttpMock</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1703 | </div><div id="HttpMock-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="HttpMock-expanded"><a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> <tt class="py-docstring">"""Mock of httplib2.Http"""</tt> </tt> |
| 1704 | <a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> </tt> |
| 1705 | <a name="HttpMock.__init__"></a><div id="HttpMock.__init__-def"><a name="L1306"></a><tt class="py-lineno">1306</tt> <a class="py-toggle" href="#" id="HttpMock.__init__-toggle" onclick="return toggle('HttpMock.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpMock-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1706 | </div><div id="HttpMock.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpMock.__init__-expanded"><a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> |
| 1707 | <a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1708 | <a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, absolute filename to read response from</tt> </tt> |
| 1709 | <a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, header to return with response</tt> </tt> |
| 1710 | <a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1711 | <a name="L1312"></a><tt class="py-lineno">1312</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1712 | <a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'status'</tt><tt class="py-op">:</tt> <tt class="py-string">'200 OK'</tt><tt class="py-op">}</tt> </tt> |
| 1713 | <a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt id="link-216" class="py-name" targets="Module oauth2client.file=oauth2client.file-module.html"><a title="oauth2client.file" class="py-name" href="#" onclick="return doclink('link-216', 'file', 'link-216');">file</a></tt><tt class="py-op">(</tt><tt id="link-217" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename |
| 1714 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-217', 'filename', 'link-21');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt> |
| 1715 | <a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1716 | <a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1717 | <a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-name">headers</tt> </tt> |
| 1718 | </div><a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"> </tt> |
| 1719 | <a name="HttpMock.request"></a><div id="HttpMock.request-def"><a name="L1319"></a><tt class="py-lineno">1319</tt> <a class="py-toggle" href="#" id="HttpMock.request-toggle" onclick="return toggle('HttpMock.request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpMock-class.html#request">request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">,</tt> </tt> |
| 1720 | <a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> </tt> |
| 1721 | <a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1722 | <a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1723 | <a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> </tt> |
| 1724 | <a name="L1324"></a><tt class="py-lineno">1324</tt> <tt class="py-line"> <tt class="py-param">connection_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1725 | </div><div id="HttpMock.request-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpMock.request-expanded"><a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">data</tt> </tt> |
| 1726 | </div></div><a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"> </tt> |
| 1727 | <a name="HttpMockSequence"></a><div id="HttpMockSequence-def"><a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> </tt> |
| 1728 | <a name="L1328"></a><tt class="py-lineno">1328</tt> <a class="py-toggle" href="#" id="HttpMockSequence-toggle" onclick="return toggle('HttpMockSequence');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.http.HttpMockSequence-class.html">HttpMockSequence</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1729 | </div><div id="HttpMockSequence-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="HttpMockSequence-expanded"><a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> <tt class="py-docstring">"""Mock of httplib2.Http</tt> </tt> |
| 1730 | <a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1731 | <a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"><tt class="py-docstring"> Mocks a sequence of calls to request returning different responses for each</tt> </tt> |
| 1732 | <a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"><tt class="py-docstring"> call. Create an instance initialized with the desired response headers</tt> </tt> |
| 1733 | <a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"><tt class="py-docstring"> and content and then use as if an httplib2.Http instance.</tt> </tt> |
| 1734 | <a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1735 | <a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"><tt class="py-docstring"> http = HttpMockSequence([</tt> </tt> |
| 1736 | <a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"><tt class="py-docstring"> ({'status': '401'}, ''),</tt> </tt> |
| 1737 | <a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"><tt class="py-docstring"> ({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'),</tt> </tt> |
| 1738 | <a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"><tt class="py-docstring"> ({'status': '200'}, 'echo_request_headers'),</tt> </tt> |
| 1739 | <a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"><tt class="py-docstring"> ])</tt> </tt> |
| 1740 | <a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"><tt class="py-docstring"> resp, content = http.request("http://examples.com")</tt> </tt> |
| 1741 | <a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1742 | <a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"><tt class="py-docstring"> There are special values you can pass in for content to trigger</tt> </tt> |
| 1743 | <a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"><tt class="py-docstring"> behavours that are helpful in testing.</tt> </tt> |
| 1744 | <a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1745 | <a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"><tt class="py-docstring"> 'echo_request_headers' means return the request headers in the response body</tt> </tt> |
| 1746 | <a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"><tt class="py-docstring"> 'echo_request_headers_as_json' means return the request headers in</tt> </tt> |
| 1747 | <a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"><tt class="py-docstring"> the response body</tt> </tt> |
| 1748 | <a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"><tt class="py-docstring"> 'echo_request_body' means return the request body in the response body</tt> </tt> |
| 1749 | <a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"><tt class="py-docstring"> 'echo_request_uri' means return the request uri in the response body</tt> </tt> |
| 1750 | <a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1751 | <a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> </tt> |
| 1752 | <a name="HttpMockSequence.__init__"></a><div id="HttpMockSequence.__init__-def"><a name="L1352"></a><tt class="py-lineno">1352</tt> <a class="py-toggle" href="#" id="HttpMockSequence.__init__-toggle" onclick="return toggle('HttpMockSequence.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpMockSequence-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">iterable</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1753 | </div><div id="HttpMockSequence.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpMockSequence.__init__-expanded"><a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> |
| 1754 | <a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1755 | <a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"><tt class="py-docstring"> iterable: iterable, a sequence of pairs of (headers, body)</tt> </tt> |
| 1756 | <a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1757 | <a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_iterable</tt> <tt class="py-op">=</tt> <tt class="py-name">iterable</tt> </tt> |
| 1758 | <a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">follow_redirects</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 1759 | </div><a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"> </tt> |
| 1760 | <a name="HttpMockSequence.request"></a><div id="HttpMockSequence.request-def"><a name="L1360"></a><tt class="py-lineno">1360</tt> <a class="py-toggle" href="#" id="HttpMockSequence.request-toggle" onclick="return toggle('HttpMockSequence.request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http.HttpMockSequence-class.html#request">request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">uri</tt><tt class="py-op">,</tt> </tt> |
| 1761 | <a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> </tt> |
| 1762 | <a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1763 | <a name="L1363"></a><tt class="py-lineno">1363</tt> <tt class="py-line"> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1764 | <a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> </tt> |
| 1765 | <a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"> <tt class="py-param">connection_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1766 | </div><div id="HttpMockSequence.request-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="HttpMockSequence.request-expanded"><a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_iterable</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt> |
| 1767 | <a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_headers'</tt><tt class="py-op">:</tt> </tt> |
| 1768 | <a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">headers</tt> </tt> |
| 1769 | <a name="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_headers_as_json'</tt><tt class="py-op">:</tt> </tt> |
| 1770 | <a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 1771 | <a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_body'</tt><tt class="py-op">:</tt> </tt> |
| 1772 | <a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">body</tt> </tt> |
| 1773 | <a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">content</tt> <tt class="py-op">==</tt> <tt class="py-string">'echo_request_uri'</tt><tt class="py-op">:</tt> </tt> |
| 1774 | <a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt> </tt> |
| 1775 | <a name="L1375"></a><tt class="py-lineno">1375</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Response</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt> |
| 1776 | </div></div><a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"> </tt> |
| 1777 | <a name="set_user_agent"></a><div id="set_user_agent-def"><a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"> </tt> |
| 1778 | <a name="L1378"></a><tt class="py-lineno">1378</tt> <a class="py-toggle" href="#" id="set_user_agent-toggle" onclick="return toggle('set_user_agent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http-module.html#set_user_agent">set_user_agent</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1779 | </div><div id="set_user_agent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_user_agent-expanded"><a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"> <tt class="py-docstring">"""Set the user-agent on every request.</tt> </tt> |
| 1780 | <a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1781 | <a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1782 | <a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt> |
| 1783 | <a name="L1383"></a><tt class="py-lineno">1383</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt> |
| 1784 | <a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, the value for the user-agent header.</tt> </tt> |
| 1785 | <a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1786 | <a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1787 | <a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt> |
| 1788 | <a name="L1388"></a><tt class="py-lineno">1388</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1789 | <a name="L1389"></a><tt class="py-lineno">1389</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 1790 | <a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1791 | <a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt> |
| 1792 | <a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"><tt class="py-docstring"> h = set_user_agent(h, "my-app-name/6.0")</tt> </tt> |
| 1793 | <a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1794 | <a name="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"><tt class="py-docstring"> Most of the time the user-agent will be set doing auth, this is for the rare</tt> </tt> |
| 1795 | <a name="L1395"></a><tt class="py-lineno">1395</tt> <tt class="py-line"><tt class="py-docstring"> cases where you are accessing an unauthenticated endpoint.</tt> </tt> |
| 1796 | <a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1797 | <a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-218" class="py-name"><a title="apiclient.http |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1798 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-218', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1799 | apiclient.http.HttpMockSequence.request |
| 1800 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1801 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-219', 'request', 'link-45');">request</a></tt> </tt> |
| 1802 | <a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"> </tt> |
| 1803 | <a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt> |
| 1804 | <a name="L1400"></a><tt class="py-lineno">1400</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1805 | <a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt> |
| 1806 | <a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"> <tt class="py-param">connection_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1807 | <a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt> |
| 1808 | <a name="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1809 | <a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1810 | <a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'user-agent'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt> |
| 1811 | <a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> </tt> |
| 1812 | <a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1813 | <a name="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'user-agent'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> </tt> |
| 1814 | <a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt> |
| 1815 | <a name="L1411"></a><tt class="py-lineno">1411</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt> |
| 1816 | <a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt> |
| 1817 | </div><a name="L1413"></a><tt class="py-lineno">1413</tt> <tt class="py-line"> </tt> |
| 1818 | <a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"> <tt id="link-220" class="py-name"><a title="apiclient.http |
| 1819 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-220', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1820 | apiclient.http.HttpMockSequence.request |
| 1821 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1822 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-221', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt> |
| 1823 | <a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-222" class="py-name"><a title="apiclient.http |
| 1824 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-222', 'http', 'link-48');">http</a></tt> </tt> |
| 1825 | </div><a name="L1416"></a><tt class="py-lineno">1416</tt> <tt class="py-line"> </tt> |
| 1826 | <a name="tunnel_patch"></a><div id="tunnel_patch-def"><a name="L1417"></a><tt class="py-lineno">1417</tt> <tt class="py-line"> </tt> |
| 1827 | <a name="L1418"></a><tt class="py-lineno">1418</tt> <a class="py-toggle" href="#" id="tunnel_patch-toggle" onclick="return toggle('tunnel_patch');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.http-module.html#tunnel_patch">tunnel_patch</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1828 | </div><div id="tunnel_patch-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="tunnel_patch-expanded"><a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"> <tt class="py-docstring">"""Tunnel PATCH requests over POST.</tt> </tt> |
| 1829 | <a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1830 | <a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"><tt class="py-docstring"> http - An instance of httplib2.Http</tt> </tt> |
| 1831 | <a name="L1422"></a><tt class="py-lineno">1422</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt> |
| 1832 | <a name="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1833 | <a name="L1424"></a><tt class="py-lineno">1424</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1834 | <a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt> |
| 1835 | <a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1836 | <a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 1837 | <a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1838 | <a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt> |
| 1839 | <a name="L1430"></a><tt class="py-lineno">1430</tt> <tt class="py-line"><tt class="py-docstring"> h = tunnel_patch(h, "my-app-name/6.0")</tt> </tt> |
| 1840 | <a name="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1841 | <a name="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"><tt class="py-docstring"> Useful if you are running on a platform that doesn't support PATCH.</tt> </tt> |
| 1842 | <a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"><tt class="py-docstring"> Apply this last if you are using OAuth 1.0, as changing the method</tt> </tt> |
| 1843 | <a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"><tt class="py-docstring"> will result in a different signature.</tt> </tt> |
| 1844 | <a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1845 | <a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-223" class="py-name"><a title="apiclient.http |
| 1846 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-223', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-224" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1847 | apiclient.http.HttpMockSequence.request |
| 1848 | apiclient.model.BaseModel.request |
| 1849 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-224', 'request', 'link-45');">request</a></tt> </tt> |
| 1850 | <a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> </tt> |
| 1851 | <a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt> |
| 1852 | <a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new_request</tt><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">=</tt><tt class="py-string">'GET'</tt><tt class="py-op">,</tt> <tt class="py-param">body</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1853 | <a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"> <tt class="py-param">redirections</tt><tt class="py-op">=</tt><tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">DEFAULT_MAX_REDIRECTS</tt><tt class="py-op">,</tt> </tt> |
| 1854 | <a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-param">connection_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1855 | <a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> <tt class="py-docstring">"""Modify the request headers to add the user-agent."""</tt> </tt> |
| 1856 | <a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">headers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 1857 | <a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1858 | <a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">method</tt> <tt class="py-op">==</tt> <tt class="py-string">'PATCH'</tt><tt class="py-op">:</tt> </tt> |
| 1859 | <a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'oauth_token'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1860 | oauth2client.appengine.OAuth2Handler.get |
| 1861 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1862 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-225', 'get', 'link-63');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'authorization'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1863 | <a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt> </tt> |
| 1864 | <a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-string">'OAuth 1.0 request made with Credentials after tunnel_patch.'</tt><tt class="py-op">)</tt> </tt> |
| 1865 | <a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'x-http-method-override'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">"PATCH"</tt> </tt> |
| 1866 | <a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-string">'POST'</tt> </tt> |
| 1867 | <a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">request_orig</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-name">body</tt><tt class="py-op">,</tt> <tt class="py-name">headers</tt><tt class="py-op">,</tt> </tt> |
| 1868 | <a name="L1452"></a><tt class="py-lineno">1452</tt> <tt class="py-line"> <tt class="py-name">redirections</tt><tt class="py-op">,</tt> <tt class="py-name">connection_type</tt><tt class="py-op">)</tt> </tt> |
| 1869 | <a name="L1453"></a><tt class="py-lineno">1453</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt> </tt> |
| 1870 | </div><a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"> </tt> |
| 1871 | <a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"> <tt id="link-226" class="py-name"><a title="apiclient.http |
| 1872 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-226', 'http', 'link-48');">http</a></tt><tt class="py-op">.</tt><tt id="link-227" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1873 | apiclient.http.HttpMockSequence.request |
| 1874 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1875 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-227', 'request', 'link-45');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt> |
| 1876 | <a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-228" class="py-name"><a title="apiclient.http |
| 1877 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-228', 'http', 'link-48');">http</a></tt> </tt> |
| 1878 | </div><a name="L1457"></a><tt class="py-lineno">1457</tt> <tt class="py-line"> </tt><script type="text/javascript"> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1879 | <!-- |
| 1880 | expandto(location.href); |
| 1881 | // --> |
| 1882 | </script> |
| 1883 | </pre> |
| 1884 | <br /> |
| 1885 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 1886 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 1887 | bgcolor="#a0c0ff" cellspacing="0"> |
| 1888 | <tr valign="middle"> |
| 1889 | |
| 1890 | <!-- Tree link --> |
| 1891 | <th> <a |
| 1892 | href="module-tree.html">Trees</a> </th> |
| 1893 | |
| 1894 | <!-- Index link --> |
| 1895 | <th> <a |
| 1896 | href="identifier-index.html">Indices</a> </th> |
| 1897 | |
| 1898 | <!-- Help link --> |
| 1899 | <th> <a |
| 1900 | href="help.html">Help</a> </th> |
| 1901 | |
| 1902 | <th class="navbar" width="100%"></th> |
| 1903 | </tr> |
| 1904 | </table> |
| 1905 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 1906 | <tr> |
| 1907 | <td align="left" class="footer"> |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame^] | 1908 | Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:15 2012 |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1909 | </td> |
| 1910 | <td align="right" class="footer"> |
| 1911 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 1912 | >http://epydoc.sourceforge.net</a> |
| 1913 | </td> |
| 1914 | </tr> |
| 1915 | </table> |
| 1916 | |
| 1917 | <script type="text/javascript"> |
| 1918 | <!-- |
| 1919 | // Private objects are initially displayed (because if |
| 1920 | // javascript is turned off then we want them to be |
| 1921 | // visible); but by default, we want to hide them. So hide |
| 1922 | // them unless we have a cookie that says to show them. |
| 1923 | checkCookie(); |
| 1924 | // --> |
| 1925 | </script> |
| 1926 | </body> |
| 1927 | </html> |