| 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>oauth2client.client</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="oauth2client-module.html">Package oauth2client</a> :: |
| 38 | Module client |
| 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="oauth2client.client-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="oauth2client.client-module.html">Module oauth2client.client</a></h1> |
| 55 | <pre class="py-src"> |
| 56 | <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2010 Google Inc.</tt> </tt> |
| 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">"""An OAuth 2.0 client.</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">Tools for interacting with OAuth 2.0 protected resources.</tt> </tt> |
| 73 | <a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt> |
| 74 | <a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"> </tt> |
| 75 | <a name="L20"></a><tt class="py-lineno"> 20</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> |
| 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-keyword">import</tt> <tt class="py-name">base64</tt> </tt> |
| 78 | <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module oauth2client.clientsecrets=oauth2client.clientsecrets-module.html"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-0', 'clientsecrets', 'link-0');">clientsecrets</a></tt> </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">copy</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">datetime</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">httplib2</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">logging</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">os</tt> </tt> |
| 84 | <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</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">time</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">urllib</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">urlparse</tt> </tt> |
| 88 | <a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> </tt> |
| 89 | <a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-1', 'anyjson', 'link-1');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</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 id="link-2" class="py-name" targets="Variable oauth2client.client.HAS_OPENSSL=oauth2client.client-module.html#HAS_OPENSSL"><a title="oauth2client.client.HAS_OPENSSL" class="py-name" href="#" onclick="return doclink('link-2', 'HAS_OPENSSL', 'link-2');">HAS_OPENSSL</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 92 | <a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 93 | <a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-3" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-3', 'oauth2client', 'link-3');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module oauth2client.crypt=oauth2client.crypt-module.html"><a title="oauth2client.crypt" class="py-name" href="#" onclick="return doclink('link-4', 'crypt', 'link-4');">crypt</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Class oauth2client.crypt.Signer=oauth2client.crypt.Signer-class.html"><a title="oauth2client.crypt.Signer" class="py-name" href="#" onclick="return doclink('link-5', 'Signer', 'link-5');">Signer</a></tt> </tt> |
| 94 | <a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-6', 'oauth2client', 'link-3');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="oauth2client.crypt" class="py-name" href="#" onclick="return doclink('link-7', 'crypt', 'link-4');">crypt</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Function oauth2client.crypt.make_signed_jwt()=oauth2client.crypt-module.html#make_signed_jwt"><a title="oauth2client.crypt.make_signed_jwt" class="py-name" href="#" onclick="return doclink('link-8', 'make_signed_jwt', 'link-8');">make_signed_jwt</a></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-9" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-9', 'oauth2client', 'link-3');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="oauth2client.crypt" class="py-name" href="#" onclick="return doclink('link-10', 'crypt', 'link-4');">crypt</a></tt> <tt class="py-keyword">import</tt> <tt id="link-11" class="py-name" targets="Function oauth2client.crypt.verify_signed_jwt_with_certs()=oauth2client.crypt-module.html#verify_signed_jwt_with_certs"><a title="oauth2client.crypt.verify_signed_jwt_with_certs" class="py-name" href="#" onclick="return doclink('link-11', 'verify_signed_jwt_with_certs', 'link-11');">verify_signed_jwt_with_certs</a></tt> </tt> |
| 96 | <a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt id="link-12" class="py-name"><a title="oauth2client.client.HAS_OPENSSL" class="py-name" href="#" onclick="return doclink('link-12', 'HAS_OPENSSL', 'link-2');">HAS_OPENSSL</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 97 | <a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt> |
| 98 | <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 99 | <a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </tt> |
| 100 | <a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 101 | <a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">urlparse</tt> <tt class="py-keyword">import</tt> <tt class="py-name">parse_qsl</tt> </tt> |
| 102 | <a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt> |
| 103 | <a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">cgi</tt> <tt class="py-keyword">import</tt> <tt class="py-name">parse_qsl</tt> </tt> |
| 104 | <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 105 | <a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt id="link-13" class="py-name" targets="Variable apiclient.discovery.logger=apiclient.discovery-module.html#logger,Variable oauth2client.appengine.logger=oauth2client.appengine-module.html#logger,Variable oauth2client.client.logger=oauth2client.client-module.html#logger,Variable oauth2client.crypt.logger=oauth2client.crypt-module.html#logger,Variable oauth2client.locked_file.logger=oauth2client.locked_file-module.html#logger,Variable oauth2client.multistore_file.logger=oauth2client.multistore_file-module.html#logger,Variable oauth2client.util.logger=oauth2client.util-module.html#logger"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 106 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 107 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 108 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 109 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 110 | oauth2client.multistore_file.logger |
| 111 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-13', 'logger', 'link-13');">logger</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 112 | <a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt> |
| 113 | <a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-comment"># Expiry is stored in RFC3339 UTC format</tt> </tt> |
| 114 | <a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt id="link-14" class="py-name" targets="Variable oauth2client.client.EXPIRY_FORMAT=oauth2client.client-module.html#EXPIRY_FORMAT"><a title="oauth2client.client.EXPIRY_FORMAT" class="py-name" href="#" onclick="return doclink('link-14', 'EXPIRY_FORMAT', 'link-14');">EXPIRY_FORMAT</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%Y-%m-%dT%H:%M:%SZ'</tt> </tt> |
| 115 | <a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt> |
| 116 | <a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-comment"># Which certs to use to validate id_tokens received.</tt> </tt> |
| 117 | <a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt id="link-15" class="py-name" targets="Variable oauth2client.client.ID_TOKEN_VERIFICATON_CERTS=oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS"><a title="oauth2client.client.ID_TOKEN_VERIFICATON_CERTS" class="py-name" href="#" onclick="return doclink('link-15', 'ID_TOKEN_VERIFICATON_CERTS', 'link-15');">ID_TOKEN_VERIFICATON_CERTS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'https://www.googleapis.com/oauth2/v1/certs'</tt> </tt> |
| 118 | <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt> |
| 119 | <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-comment"># Constant to use for the out of band OAuth 2.0 flow.</tt> </tt> |
| 120 | <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt id="link-16" class="py-name" targets="Variable oauth2client.client.OOB_CALLBACK_URN=oauth2client.client-module.html#OOB_CALLBACK_URN"><a title="oauth2client.client.OOB_CALLBACK_URN" class="py-name" href="#" onclick="return doclink('link-16', 'OOB_CALLBACK_URN', 'link-16');">OOB_CALLBACK_URN</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'urn:ietf:wg:oauth:2.0:oob'</tt> </tt> |
| 121 | <a name="Error"></a><div id="Error-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> </tt> |
| 122 | <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt> |
| 123 | <a name="L62"></a><tt class="py-lineno"> 62</tt> <a class="py-toggle" href="#" id="Error-toggle" onclick="return toggle('Error');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.Error-class.html">Error</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 124 | </div><div id="Error-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Error-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-docstring">"""Base error for this module."""</tt> </tt> |
| 125 | <a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 126 | </div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt> |
| 127 | <a name="FlowExchangeError"></a><div id="FlowExchangeError-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt> |
| 128 | <a name="L67"></a><tt class="py-lineno"> 67</tt> <a class="py-toggle" href="#" id="FlowExchangeError-toggle" onclick="return toggle('FlowExchangeError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.FlowExchangeError-class.html">FlowExchangeError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 129 | </div><div id="FlowExchangeError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="FlowExchangeError-expanded"><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-docstring">"""Error trying to exchange an authorization grant for an access token."""</tt> </tt> |
| 130 | <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 131 | </div><a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt> |
| 132 | <a name="AccessTokenRefreshError"></a><div id="AccessTokenRefreshError-def"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt> |
| 133 | <a name="L72"></a><tt class="py-lineno"> 72</tt> <a class="py-toggle" href="#" id="AccessTokenRefreshError-toggle" onclick="return toggle('AccessTokenRefreshError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenRefreshError-class.html">AccessTokenRefreshError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 134 | </div><div id="AccessTokenRefreshError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="AccessTokenRefreshError-expanded"><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-docstring">"""Error trying to refresh an expired access token."""</tt> </tt> |
| 135 | <a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 136 | </div><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt> |
| 137 | <a name="UnknownClientSecretsFlowError"></a><div id="UnknownClientSecretsFlowError-def"><a name="L76"></a><tt class="py-lineno"> 76</tt> <a class="py-toggle" href="#" id="UnknownClientSecretsFlowError-toggle" onclick="return toggle('UnknownClientSecretsFlowError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.UnknownClientSecretsFlowError-class.html">UnknownClientSecretsFlowError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 138 | </div><div id="UnknownClientSecretsFlowError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="UnknownClientSecretsFlowError-expanded"><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-docstring">"""The client secrets file called for an unknown type of OAuth 2.0 flow. """</tt> </tt> |
| 139 | <a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 140 | </div><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt> |
| 141 | <a name="AccessTokenCredentialsError"></a><div id="AccessTokenCredentialsError-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt> |
| 142 | <a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="AccessTokenCredentialsError-toggle" onclick="return toggle('AccessTokenCredentialsError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenCredentialsError-class.html">AccessTokenCredentialsError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 143 | </div><div id="AccessTokenCredentialsError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="AccessTokenCredentialsError-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-docstring">"""Having only the access_token means no refresh is possible."""</tt> </tt> |
| 144 | <a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 145 | </div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt> |
| 146 | <a name="VerifyJwtTokenError"></a><div id="VerifyJwtTokenError-def"><a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt> |
| 147 | <a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="VerifyJwtTokenError-toggle" onclick="return toggle('VerifyJwtTokenError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.VerifyJwtTokenError-class.html">VerifyJwtTokenError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 148 | </div><div id="VerifyJwtTokenError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="VerifyJwtTokenError-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""Could on retrieve certificates for validation."""</tt> </tt> |
| 149 | <a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 150 | </div><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> </tt> |
| 151 | <a name="_abstract"></a><div id="_abstract-def"><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt> |
| 152 | <a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="_abstract-toggle" onclick="return toggle('_abstract');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#_abstract">_abstract</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 153 | </div><div id="_abstract-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_abstract-expanded"><a name="L92"></a><tt class="py-lineno"> 92</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">'You need to override this function'</tt><tt class="py-op">)</tt> </tt> |
| 154 | </div><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> </tt> |
| 155 | <a name="MemoryCache"></a><div id="MemoryCache-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt> |
| 156 | <a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="MemoryCache-toggle" onclick="return toggle('MemoryCache');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.MemoryCache-class.html">MemoryCache</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 157 | </div><div id="MemoryCache-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MemoryCache-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-docstring">"""httplib2 Cache implementation which only caches locally."""</tt> </tt> |
| 158 | <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> </tt> |
| 159 | <a name="MemoryCache.__init__"></a><div id="MemoryCache.__init__-def"><a name="L98"></a><tt class="py-lineno"> 98</tt> <a class="py-toggle" href="#" id="MemoryCache.__init__-toggle" onclick="return toggle('MemoryCache.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.MemoryCache-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 160 | </div><div id="MemoryCache.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MemoryCache.__init__-expanded"><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 161 | </div><a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> </tt> |
| 162 | <a name="MemoryCache.get"></a><div id="MemoryCache.get-def"><a name="L101"></a><tt class="py-lineno"> 101</tt> <a class="py-toggle" href="#" id="MemoryCache.get-toggle" onclick="return toggle('MemoryCache.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.MemoryCache-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 163 | </div><div id="MemoryCache.get-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MemoryCache.get-expanded"><a name="L102"></a><tt class="py-lineno"> 102</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">cache</tt><tt class="py-op">.</tt><tt id="link-17" 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 |
| 164 | oauth2client.appengine.OAuth2Handler.get |
| 165 | oauth2client.client.MemoryCache.get |
| 166 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-17', 'get', 'link-17');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt> |
| 167 | </div><a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> </tt> |
| 168 | <a name="MemoryCache.set"></a><div id="MemoryCache.set-def"><a name="L104"></a><tt class="py-lineno"> 104</tt> <a class="py-toggle" href="#" id="MemoryCache.set-toggle" onclick="return toggle('MemoryCache.set');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.MemoryCache-class.html#set">set</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 169 | </div><div id="MemoryCache.set-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MemoryCache.set-expanded"><a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</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> |
| 170 | </div><a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> </tt> |
| 171 | <a name="MemoryCache.delete"></a><div id="MemoryCache.delete-def"><a name="L107"></a><tt class="py-lineno"> 107</tt> <a class="py-toggle" href="#" id="MemoryCache.delete-toggle" onclick="return toggle('MemoryCache.delete');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.MemoryCache-class.html#delete">delete</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 172 | </div><div id="MemoryCache.delete-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="MemoryCache.delete-expanded"><a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 173 | </div></div><a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> </tt> |
| 174 | <a name="Credentials"></a><div id="Credentials-def"><a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> </tt> |
| 175 | <a name="L111"></a><tt class="py-lineno"> 111</tt> <a class="py-toggle" href="#" id="Credentials-toggle" onclick="return toggle('Credentials');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.Credentials-class.html">Credentials</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 176 | </div><div id="Credentials-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Credentials-expanded"><a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"> <tt class="py-docstring">"""Base class for all Credentials objects.</tt> </tt> |
| 177 | <a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 178 | <a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-docstring"> Subclasses must define an authorize() method that applies the credentials to</tt> </tt> |
| 179 | <a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-docstring"> an HTTP transport.</tt> </tt> |
| 180 | <a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 181 | <a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"><tt class="py-docstring"> Subclasses must also specify a classmethod named 'from_json' that takes a JSON</tt> </tt> |
| 182 | <a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt class="py-docstring"> string as input and returns an instaniated Credentials object.</tt> </tt> |
| 183 | <a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 184 | <a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> </tt> |
| 185 | <a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Variable oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS=oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS"><a title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" class="py-name" href="#" onclick="return doclink('link-18', 'NON_SERIALIZED_MEMBERS', 'link-18');">NON_SERIALIZED_MEMBERS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'store'</tt><tt class="py-op">]</tt> </tt> |
| 186 | <a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> </tt> |
| 187 | <a name="Credentials.authorize"></a><div id="Credentials.authorize-def"><a name="L123"></a><tt class="py-lineno"> 123</tt> <a class="py-toggle" href="#" id="Credentials.authorize-toggle" onclick="return toggle('Credentials.authorize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-class.html#authorize">authorize</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-op">:</tt> </tt> |
| 188 | </div><div id="Credentials.authorize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.authorize-expanded"><a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-docstring">"""Take an httplib2.Http instance (or equivalent) and</tt> </tt> |
| 189 | <a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"> authorizes it for the set of credentials, usually by</tt> </tt> |
| 190 | <a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-docstring"> replacing http.request() with a method that adds in</tt> </tt> |
| 191 | <a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-docstring"> the appropriate headers and then delegates to the original</tt> </tt> |
| 192 | <a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"> Http.request() method.</tt> </tt> |
| 193 | <a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 194 | <a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> <tt id="link-19" class="py-name" targets="Function apiclient.model._abstract()=apiclient.model-module.html#_abstract,Function oauth2client.client._abstract()=oauth2client.client-module.html#_abstract"><a title="apiclient.model._abstract |
| 195 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-19', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 196 | </div><a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"> </tt> |
| 197 | <a name="Credentials.refresh"></a><div id="Credentials.refresh-def"><a name="L132"></a><tt class="py-lineno"> 132</tt> <a class="py-toggle" href="#" id="Credentials.refresh-toggle" onclick="return toggle('Credentials.refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-class.html#refresh">refresh</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-op">:</tt> </tt> |
| 198 | </div><div id="Credentials.refresh-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.refresh-expanded"><a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-docstring">"""Forces a refresh of the access_token.</tt> </tt> |
| 199 | <a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 200 | <a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 201 | <a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used to make the refresh</tt> </tt> |
| 202 | <a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt> |
| 203 | <a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 204 | <a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt id="link-20" class="py-name"><a title="apiclient.model._abstract |
| 205 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-20', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 206 | </div><a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> </tt> |
| 207 | <a name="Credentials.apply"></a><div id="Credentials.apply-def"><a name="L141"></a><tt class="py-lineno"> 141</tt> <a class="py-toggle" href="#" id="Credentials.apply-toggle" onclick="return toggle('Credentials.apply');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-class.html#apply">apply</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 208 | </div><div id="Credentials.apply-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.apply-expanded"><a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> <tt class="py-docstring">"""Add the authorization to the headers.</tt> </tt> |
| 209 | <a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 210 | <a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 211 | <a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, the headers to add the Authorization header to.</tt> </tt> |
| 212 | <a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 213 | <a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="apiclient.model._abstract |
| 214 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-21', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 215 | </div><a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> </tt> |
| 216 | <a name="Credentials._to_json"></a><div id="Credentials._to_json-def"><a name="L149"></a><tt class="py-lineno"> 149</tt> <a class="py-toggle" href="#" id="Credentials._to_json-toggle" onclick="return toggle('Credentials._to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-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-op">:</tt> </tt> |
| 217 | </div><div id="Credentials._to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials._to_json-expanded"><a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-docstring">"""Utility function for creating a JSON representation of an instance of Credentials.</tt> </tt> |
| 218 | <a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 219 | <a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 220 | <a name="L153"></a><tt class="py-lineno"> 153</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> |
| 221 | <a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 222 | <a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 223 | <a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 224 | <a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 225 | <a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 226 | <a name="L159"></a><tt class="py-lineno"> 159</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> |
| 227 | <a name="L160"></a><tt class="py-lineno"> 160</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> |
| 228 | <a name="L161"></a><tt class="py-lineno"> 161</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> |
| 229 | <a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">member</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 230 | <a name="L163"></a><tt class="py-lineno"> 163</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> |
| 231 | <a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'token_expiry'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 232 | <a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</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">'token_expiry'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strftime</tt><tt class="py-op">(</tt><tt id="link-22" class="py-name"><a title="oauth2client.client.EXPIRY_FORMAT" class="py-name" href="#" onclick="return doclink('link-22', 'EXPIRY_FORMAT', 'link-14');">EXPIRY_FORMAT</a></tt><tt class="py-op">)</tt> </tt> |
| 233 | <a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-comment"># Add in information we will need later to reconsistitue this instance.</tt> </tt> |
| 234 | <a name="L167"></a><tt class="py-lineno"> 167</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> |
| 235 | <a name="L168"></a><tt class="py-lineno"> 168</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> |
| 236 | <a name="L169"></a><tt class="py-lineno"> 169</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> |
| 237 | </div><a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> </tt> |
| 238 | <a name="Credentials.to_json"></a><div id="Credentials.to_json-def"><a name="L171"></a><tt class="py-lineno"> 171</tt> <a class="py-toggle" href="#" id="Credentials.to_json-toggle" onclick="return toggle('Credentials.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-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> |
| 239 | </div><div id="Credentials.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.to_json-expanded"><a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-docstring">"""Creating a JSON representation of an instance of Credentials.</tt> </tt> |
| 240 | <a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 241 | <a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 242 | <a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-docstring"> string, a JSON representation of this instance, suitable to pass to</tt> </tt> |
| 243 | <a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"> from_json().</tt> </tt> |
| 244 | <a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 245 | <a name="L178"></a><tt class="py-lineno"> 178</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-23" 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 |
| 246 | oauth2client.client.Credentials._to_json" class="py-name" href="#" onclick="return doclink('link-23', '_to_json', 'link-23');">_to_json</a></tt><tt class="py-op">(</tt><tt id="link-24" class="py-name" targets="Class oauth2client.client.Credentials=oauth2client.client.Credentials-class.html"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-24', 'Credentials', 'link-24');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" class="py-name" href="#" onclick="return doclink('link-25', 'NON_SERIALIZED_MEMBERS', 'link-18');">NON_SERIALIZED_MEMBERS</a></tt><tt class="py-op">)</tt> </tt> |
| 247 | </div><a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> </tt> |
| 248 | <a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 249 | <a name="Credentials.new_from_json"></a><div id="Credentials.new_from_json-def"><a name="L181"></a><tt class="py-lineno"> 181</tt> <a class="py-toggle" href="#" id="Credentials.new_from_json-toggle" onclick="return toggle('Credentials.new_from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-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> |
| 250 | </div><div id="Credentials.new_from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.new_from_json-expanded"><a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> <tt class="py-docstring">"""Utility class method to instantiate a Credentials subclass from a JSON</tt> </tt> |
| 251 | <a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-docstring"> representation produced by to_json().</tt> </tt> |
| 252 | <a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 253 | <a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 254 | <a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> s: string, JSON from to_json().</tt> </tt> |
| 255 | <a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 256 | <a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 257 | <a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-docstring"> An instance of the subclass of Credentials that was serialized with</tt> </tt> |
| 258 | <a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-docstring"> to_json().</tt> </tt> |
| 259 | <a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 260 | <a name="L192"></a><tt class="py-lineno"> 192</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-26" 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-26', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 261 | <a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <tt class="py-comment"># Find and call the right classmethod from_json() to restore the object.</tt> </tt> |
| 262 | <a name="L194"></a><tt class="py-lineno"> 194</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> |
| 263 | <a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 264 | <a name="L196"></a><tt class="py-lineno"> 196</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> |
| 265 | <a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt> |
| 266 | <a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"> <tt class="py-comment"># In case there's an object from the old package structure, update it</tt> </tt> |
| 267 | <a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'.apiclient'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">)</tt> </tt> |
| 268 | <a name="L200"></a><tt class="py-lineno"> 200</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> |
| 269 | <a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"> </tt> |
| 270 | <a name="L202"></a><tt class="py-lineno"> 202</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> |
| 271 | <a name="L203"></a><tt class="py-lineno"> 203</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> |
| 272 | <a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"> <tt id="link-27" 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 |
| 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-27', 'from_json', 'link-27');">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> |
| 280 | <a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-28" class="py-name"><a title="apiclient.http.HttpRequest.from_json |
| 281 | apiclient.http.MediaFileUpload.from_json |
| 282 | apiclient.http.MediaInMemoryUpload.from_json |
| 283 | oauth2client.appengine.AppAssertionCredentials.from_json |
| 284 | oauth2client.client.AccessTokenCredentials.from_json |
| 285 | oauth2client.client.Credentials.from_json |
| 286 | oauth2client.client.OAuth2Credentials.from_json |
| 287 | oauth2client.client.SignedJwtAssertionCredentials.from_json" class="py-name" href="#" onclick="return doclink('link-28', 'from_json', 'link-27');">from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 288 | </div><a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> </tt> |
| 289 | <a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 290 | <a name="Credentials.from_json"></a><div id="Credentials.from_json-def"><a name="L208"></a><tt class="py-lineno"> 208</tt> <a class="py-toggle" href="#" id="Credentials.from_json-toggle" onclick="return toggle('Credentials.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Credentials-class.html#from_json">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> |
| 291 | </div><div id="Credentials.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Credentials.from_json-expanded"><a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-docstring">"""Instantiate a Credentials object from a JSON description of it.</tt> </tt> |
| 292 | <a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 293 | <a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"><tt class="py-docstring"> The JSON should have been produced by calling .to_json() on the object.</tt> </tt> |
| 294 | <a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 295 | <a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 296 | <a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-docstring"> data: dict, A deserialized JSON object.</tt> </tt> |
| 297 | <a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 298 | <a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 299 | <a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"><tt class="py-docstring"> An instance of a Credentials subclass.</tt> </tt> |
| 300 | <a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 301 | <a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-29" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-29', 'Credentials', 'link-24');">Credentials</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 302 | </div></div><a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> </tt> |
| 303 | <a name="Flow"></a><div id="Flow-def"><a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> </tt> |
| 304 | <a name="L222"></a><tt class="py-lineno"> 222</tt> <a class="py-toggle" href="#" id="Flow-toggle" onclick="return toggle('Flow');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.Flow-class.html">Flow</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 305 | </div><div id="Flow-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Flow-expanded"><a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-docstring">"""Base class for all Flow objects."""</tt> </tt> |
| 306 | <a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 307 | </div><a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> </tt> |
| 308 | <a name="Storage"></a><div id="Storage-def"><a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> </tt> |
| 309 | <a name="L227"></a><tt class="py-lineno"> 227</tt> <a class="py-toggle" href="#" id="Storage-toggle" onclick="return toggle('Storage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html">Storage</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 310 | </div><div id="Storage-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Storage-expanded"><a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-docstring">"""Base class for all Storage objects.</tt> </tt> |
| 311 | <a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 312 | <a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"> Store and retrieve a single credential. This class supports locking</tt> </tt> |
| 313 | <a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> such that multiple processes and threads can operate on a single</tt> </tt> |
| 314 | <a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> store.</tt> </tt> |
| 315 | <a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 316 | <a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> </tt> |
| 317 | <a name="Storage.acquire_lock"></a><div id="Storage.acquire_lock-def"><a name="L235"></a><tt class="py-lineno"> 235</tt> <a class="py-toggle" href="#" id="Storage.acquire_lock-toggle" onclick="return toggle('Storage.acquire_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#acquire_lock">acquire_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 318 | </div><div id="Storage.acquire_lock-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.acquire_lock-expanded"><a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> <tt class="py-docstring">"""Acquires any lock necessary to access this Storage.</tt> </tt> |
| 319 | <a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 320 | <a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> This lock is not reentrant.</tt> </tt> |
| 321 | <a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 322 | <a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 323 | </div><a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> </tt> |
| 324 | <a name="Storage.release_lock"></a><div id="Storage.release_lock-def"><a name="L242"></a><tt class="py-lineno"> 242</tt> <a class="py-toggle" href="#" id="Storage.release_lock-toggle" onclick="return toggle('Storage.release_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#release_lock">release_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 325 | </div><div id="Storage.release_lock-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.release_lock-expanded"><a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"> <tt class="py-docstring">"""Release the Storage lock.</tt> </tt> |
| 326 | <a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 327 | <a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"><tt class="py-docstring"> Trying to release a lock that isn't held will result in a</tt> </tt> |
| 328 | <a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"><tt class="py-docstring"> RuntimeError.</tt> </tt> |
| 329 | <a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 330 | <a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 331 | </div><a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> </tt> |
| 332 | <a name="Storage.locked_get"></a><div id="Storage.locked_get-def"><a name="L250"></a><tt class="py-lineno"> 250</tt> <a class="py-toggle" href="#" id="Storage.locked_get-toggle" onclick="return toggle('Storage.locked_get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#locked_get">locked_get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 333 | </div><div id="Storage.locked_get-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.locked_get-expanded"><a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieve credential.</tt> </tt> |
| 334 | <a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 335 | <a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt> |
| 336 | <a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 337 | <a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 338 | <a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials</tt> </tt> |
| 339 | <a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 340 | <a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> <tt id="link-30" class="py-name"><a title="apiclient.model._abstract |
| 341 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-30', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 342 | </div><a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> </tt> |
| 343 | <a name="Storage.locked_put"></a><div id="Storage.locked_put-def"><a name="L260"></a><tt class="py-lineno"> 260</tt> <a class="py-toggle" href="#" id="Storage.locked_put-toggle" onclick="return toggle('Storage.locked_put');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#locked_put">locked_put</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 344 | </div><div id="Storage.locked_put-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.locked_put-expanded"><a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-docstring">"""Write a credential.</tt> </tt> |
| 345 | <a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 346 | <a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt> |
| 347 | <a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 348 | <a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 349 | <a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-docstring"> credentials: Credentials, the credentials to store.</tt> </tt> |
| 350 | <a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 351 | <a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt id="link-31" class="py-name"><a title="apiclient.model._abstract |
| 352 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-31', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 353 | </div><a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"> </tt> |
| 354 | <a name="Storage.locked_delete"></a><div id="Storage.locked_delete-def"><a name="L270"></a><tt class="py-lineno"> 270</tt> <a class="py-toggle" href="#" id="Storage.locked_delete-toggle" onclick="return toggle('Storage.locked_delete');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#locked_delete">locked_delete</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 355 | </div><div id="Storage.locked_delete-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.locked_delete-expanded"><a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete a credential.</tt> </tt> |
| 356 | <a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 357 | <a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt> |
| 358 | <a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 359 | <a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> <tt id="link-32" class="py-name"><a title="apiclient.model._abstract |
| 360 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-32', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 361 | </div><a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> </tt> |
| 362 | <a name="Storage.get"></a><div id="Storage.get-def"><a name="L277"></a><tt class="py-lineno"> 277</tt> <a class="py-toggle" href="#" id="Storage.get-toggle" onclick="return toggle('Storage.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 363 | </div><div id="Storage.get-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.get-expanded"><a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieve credential.</tt> </tt> |
| 364 | <a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 365 | <a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must *not* be held when this is called.</tt> </tt> |
| 366 | <a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 367 | <a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 368 | <a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials</tt> </tt> |
| 369 | <a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 370 | <a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Method oauth2client.client.Storage.acquire_lock()=oauth2client.client.Storage-class.html#acquire_lock,Method oauth2client.file.Storage.acquire_lock()=oauth2client.file.Storage-class.html#acquire_lock,Method oauth2client.keyring_storage.Storage.acquire_lock()=oauth2client.keyring_storage.Storage-class.html#acquire_lock,Method oauth2client.multistore_file._MultiStore._Storage.acquire_lock()=oauth2client.multistore_file._MultiStore._Storage-class.html#acquire_lock"><a title="oauth2client.client.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 371 | oauth2client.file.Storage.acquire_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 372 | oauth2client.keyring_storage.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 373 | oauth2client.multistore_file._MultiStore._Storage.acquire_lock" class="py-name" href="#" onclick="return doclink('link-33', 'acquire_lock', 'link-33');">acquire_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 374 | <a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 375 | <a name="L287"></a><tt class="py-lineno"> 287</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-34" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName.locked_get()=oauth2client.appengine.StorageByKeyName-class.html#locked_get,Method oauth2client.client.Storage.locked_get()=oauth2client.client.Storage-class.html#locked_get,Method oauth2client.django_orm.Storage.locked_get()=oauth2client.django_orm.Storage-class.html#locked_get,Method oauth2client.file.Storage.locked_get()=oauth2client.file.Storage-class.html#locked_get,Method oauth2client.keyring_storage.Storage.locked_get()=oauth2client.keyring_storage.Storage-class.html#locked_get,Method oauth2client.multistore_file._MultiStore._Storage.locked_get()=oauth2client.multistore_file._MultiStore._Storage-class.html#locked_get"><a title="oauth2client.appengine.StorageByKeyName.locked_get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 376 | oauth2client.client.Storage.locked_get |
| 377 | oauth2client.django_orm.Storage.locked_get |
| 378 | oauth2client.file.Storage.locked_get |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 379 | oauth2client.keyring_storage.Storage.locked_get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 380 | oauth2client.multistore_file._MultiStore._Storage.locked_get" class="py-name" href="#" onclick="return doclink('link-34', 'locked_get', 'link-34');">locked_get</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 381 | <a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 382 | <a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Method oauth2client.client.Storage.release_lock()=oauth2client.client.Storage-class.html#release_lock,Method oauth2client.file.Storage.release_lock()=oauth2client.file.Storage-class.html#release_lock,Method oauth2client.keyring_storage.Storage.release_lock()=oauth2client.keyring_storage.Storage-class.html#release_lock,Method oauth2client.multistore_file._MultiStore._Storage.release_lock()=oauth2client.multistore_file._MultiStore._Storage-class.html#release_lock"><a title="oauth2client.client.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 383 | oauth2client.file.Storage.release_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 384 | oauth2client.keyring_storage.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 385 | oauth2client.multistore_file._MultiStore._Storage.release_lock" class="py-name" href="#" onclick="return doclink('link-35', 'release_lock', 'link-35');">release_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 386 | </div><a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> </tt> |
| 387 | <a name="Storage.put"></a><div id="Storage.put-def"><a name="L291"></a><tt class="py-lineno"> 291</tt> <a class="py-toggle" href="#" id="Storage.put-toggle" onclick="return toggle('Storage.put');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#put">put</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 388 | </div><div id="Storage.put-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.put-expanded"><a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-docstring">"""Write a credential.</tt> </tt> |
| 389 | <a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 390 | <a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt> |
| 391 | <a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 392 | <a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 393 | <a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"> credentials: Credentials, the credentials to store.</tt> </tt> |
| 394 | <a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 395 | <a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="oauth2client.client.Storage.acquire_lock |
| 396 | oauth2client.file.Storage.acquire_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 397 | oauth2client.keyring_storage.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 398 | oauth2client.multistore_file._MultiStore._Storage.acquire_lock" class="py-name" href="#" onclick="return doclink('link-36', 'acquire_lock', 'link-33');">acquire_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 399 | <a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 400 | <a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName.locked_put()=oauth2client.appengine.StorageByKeyName-class.html#locked_put,Method oauth2client.client.Storage.locked_put()=oauth2client.client.Storage-class.html#locked_put,Method oauth2client.django_orm.Storage.locked_put()=oauth2client.django_orm.Storage-class.html#locked_put,Method oauth2client.file.Storage.locked_put()=oauth2client.file.Storage-class.html#locked_put,Method oauth2client.keyring_storage.Storage.locked_put()=oauth2client.keyring_storage.Storage-class.html#locked_put,Method oauth2client.multistore_file._MultiStore._Storage.locked_put()=oauth2client.multistore_file._MultiStore._Storage-class.html#locked_put"><a title="oauth2client.appengine.StorageByKeyName.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 401 | oauth2client.client.Storage.locked_put |
| 402 | oauth2client.django_orm.Storage.locked_put |
| 403 | oauth2client.file.Storage.locked_put |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 404 | oauth2client.keyring_storage.Storage.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 405 | oauth2client.multistore_file._MultiStore._Storage.locked_put" class="py-name" href="#" onclick="return doclink('link-37', 'locked_put', 'link-37');">locked_put</a></tt><tt class="py-op">(</tt><tt id="link-38" 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-38', 'credentials', 'link-38');">credentials</a></tt><tt class="py-op">)</tt> </tt> |
| 406 | <a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt> |
| 407 | <a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="oauth2client.client.Storage.release_lock |
| 408 | oauth2client.file.Storage.release_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 409 | oauth2client.keyring_storage.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 410 | oauth2client.multistore_file._MultiStore._Storage.release_lock" class="py-name" href="#" onclick="return doclink('link-39', 'release_lock', 'link-35');">release_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 411 | </div><a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> </tt> |
| 412 | <a name="Storage.delete"></a><div id="Storage.delete-def"><a name="L305"></a><tt class="py-lineno"> 305</tt> <a class="py-toggle" href="#" id="Storage.delete-toggle" onclick="return toggle('Storage.delete');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.Storage-class.html#delete">delete</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 413 | </div><div id="Storage.delete-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="Storage.delete-expanded"><a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete credential.</tt> </tt> |
| 414 | <a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 415 | <a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"><tt class="py-docstring"> Frees any resources associated with storing the credential.</tt> </tt> |
| 416 | <a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must *not* be held when this is called.</tt> </tt> |
| 417 | <a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 418 | <a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 419 | <a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"><tt class="py-docstring"> None</tt> </tt> |
| 420 | <a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 421 | <a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="oauth2client.client.Storage.acquire_lock |
| 422 | oauth2client.file.Storage.acquire_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 423 | oauth2client.keyring_storage.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 424 | oauth2client.multistore_file._MultiStore._Storage.acquire_lock" class="py-name" href="#" onclick="return doclink('link-40', 'acquire_lock', 'link-33');">acquire_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 425 | <a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 426 | <a name="L316"></a><tt class="py-lineno"> 316</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-41" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName.locked_delete()=oauth2client.appengine.StorageByKeyName-class.html#locked_delete,Method oauth2client.client.Storage.locked_delete()=oauth2client.client.Storage-class.html#locked_delete,Method oauth2client.django_orm.Storage.locked_delete()=oauth2client.django_orm.Storage-class.html#locked_delete,Method oauth2client.file.Storage.locked_delete()=oauth2client.file.Storage-class.html#locked_delete,Method oauth2client.keyring_storage.Storage.locked_delete()=oauth2client.keyring_storage.Storage-class.html#locked_delete,Method oauth2client.multistore_file._MultiStore._Storage.locked_delete()=oauth2client.multistore_file._MultiStore._Storage-class.html#locked_delete"><a title="oauth2client.appengine.StorageByKeyName.locked_delete |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 427 | oauth2client.client.Storage.locked_delete |
| 428 | oauth2client.django_orm.Storage.locked_delete |
| 429 | oauth2client.file.Storage.locked_delete |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 430 | oauth2client.keyring_storage.Storage.locked_delete |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 431 | oauth2client.multistore_file._MultiStore._Storage.locked_delete" class="py-name" href="#" onclick="return doclink('link-41', 'locked_delete', 'link-41');">locked_delete</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 432 | <a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt> |
| 433 | <a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="oauth2client.client.Storage.release_lock |
| 434 | oauth2client.file.Storage.release_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 435 | oauth2client.keyring_storage.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 436 | oauth2client.multistore_file._MultiStore._Storage.release_lock" class="py-name" href="#" onclick="return doclink('link-42', 'release_lock', 'link-35');">release_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 437 | </div></div><a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> </tt> |
| 438 | <a name="OAuth2Credentials"></a><div id="OAuth2Credentials-def"><a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> </tt> |
| 439 | <a name="L321"></a><tt class="py-lineno"> 321</tt> <a class="py-toggle" href="#" id="OAuth2Credentials-toggle" onclick="return toggle('OAuth2Credentials');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a><tt class="py-op">(</tt><tt class="py-base-class">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 440 | </div><div id="OAuth2Credentials-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="OAuth2Credentials-expanded"><a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-docstring">"""Credentials object for OAuth 2.0.</tt> </tt> |
| 441 | <a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 442 | <a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"><tt class="py-docstring"> Credentials can be applied to an httplib2.Http object using the authorize()</tt> </tt> |
| 443 | <a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"><tt class="py-docstring"> method, which then adds the OAuth 2.0 access token to each request.</tt> </tt> |
| 444 | <a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 445 | <a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"><tt class="py-docstring"> OAuth2Credentials objects may be safely pickled and unpickled.</tt> </tt> |
| 446 | <a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 447 | <a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> </tt> |
| 448 | <a name="OAuth2Credentials.__init__"></a><div id="OAuth2Credentials.__init__-def"><a name="L330"></a><tt class="py-lineno"> 330</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.__init__-toggle" onclick="return toggle('OAuth2Credentials.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-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">access_token</tt><tt class="py-op">,</tt> <tt class="py-param">client_id</tt><tt class="py-op">,</tt> <tt class="py-param">client_secret</tt><tt class="py-op">,</tt> <tt class="py-param">refresh_token</tt><tt class="py-op">,</tt> </tt> |
| 449 | <a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-param">token_expiry</tt><tt class="py-op">,</tt> <tt class="py-param">token_uri</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">,</tt> <tt class="py-param">id_token</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 450 | </div><div id="OAuth2Credentials.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.__init__-expanded"><a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-docstring">"""Create an instance of OAuth2Credentials.</tt> </tt> |
| 451 | <a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 452 | <a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-docstring"> This constructor is not usually called by the user, instead</tt> </tt> |
| 453 | <a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"><tt class="py-docstring"> OAuth2Credentials objects are instantiated by the OAuth2WebServerFlow.</tt> </tt> |
| 454 | <a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 455 | <a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 456 | <a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"><tt class="py-docstring"> access_token: string, access token.</tt> </tt> |
| 457 | <a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-docstring"> client_id: string, client identifier.</tt> </tt> |
| 458 | <a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-docstring"> client_secret: string, client secret.</tt> </tt> |
| 459 | <a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"><tt class="py-docstring"> refresh_token: string, refresh token.</tt> </tt> |
| 460 | <a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"><tt class="py-docstring"> token_expiry: datetime, when the access_token expires.</tt> </tt> |
| 461 | <a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI of token endpoint.</tt> </tt> |
| 462 | <a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, The HTTP User-Agent to provide for this application.</tt> </tt> |
| 463 | <a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"><tt class="py-docstring"> id_token: object, The identity of the resource owner.</tt> </tt> |
| 464 | <a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 465 | <a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"><tt class="py-docstring"> Notes:</tt> </tt> |
| 466 | <a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"><tt class="py-docstring"> store: callable, A callable that when passed a Credential</tt> </tt> |
| 467 | <a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"><tt class="py-docstring"> will store the credential back to where it came from.</tt> </tt> |
| 468 | <a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"><tt class="py-docstring"> This is needed to store the latest access_token if it</tt> </tt> |
| 469 | <a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-docstring"> has expired and been refreshed.</tt> </tt> |
| 470 | <a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 471 | <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">access_token</tt> <tt class="py-op">=</tt> <tt class="py-name">access_token</tt> </tt> |
| 472 | <a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt> <tt class="py-op">=</tt> <tt class="py-name">client_id</tt> </tt> |
| 473 | <a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_secret</tt> <tt class="py-op">=</tt> <tt class="py-name">client_secret</tt> </tt> |
| 474 | <a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">refresh_token</tt> <tt class="py-op">=</tt> <tt class="py-name">refresh_token</tt> </tt> |
| 475 | <a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 476 | <a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_expiry</tt> <tt class="py-op">=</tt> <tt class="py-name">token_expiry</tt> </tt> |
| 477 | <a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">token_uri</tt> </tt> |
| 478 | <a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">user_agent</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> </tt> |
| 479 | <a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id_token</tt> <tt class="py-op">=</tt> <tt class="py-name">id_token</tt> </tt> |
| 480 | <a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> </tt> |
| 481 | <a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> <tt class="py-comment"># True if the credentials have been revoked or expired and can't be</tt> </tt> |
| 482 | <a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-comment"># refreshed.</tt> </tt> |
| 483 | <a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 484 | </div><a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> </tt> |
| 485 | <a name="OAuth2Credentials.authorize"></a><div id="OAuth2Credentials.authorize-def"><a name="L367"></a><tt class="py-lineno"> 367</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.authorize-toggle" onclick="return toggle('OAuth2Credentials.authorize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</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-op">:</tt> </tt> |
| 486 | </div><div id="OAuth2Credentials.authorize-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.authorize-expanded"><a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> <tt class="py-docstring">"""Authorize an httplib2.Http instance with these credentials.</tt> </tt> |
| 487 | <a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 488 | <a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> The modified http.request method will add authentication headers to each</tt> </tt> |
| 489 | <a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"> request and will refresh access_tokens when a 401 is received on a</tt> </tt> |
| 490 | <a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"> request. In addition the http.request method has a credentials property,</tt> </tt> |
| 491 | <a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"> http.request.credentials, which is the Credentials object that authorized</tt> </tt> |
| 492 | <a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"> it.</tt> </tt> |
| 493 | <a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 494 | <a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 495 | <a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> http: An instance of httplib2.Http</tt> </tt> |
| 496 | <a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt> |
| 497 | <a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 498 | <a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 499 | <a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-docstring"> A modified instance of http that was passed in.</tt> </tt> |
| 500 | <a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 501 | <a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 502 | <a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 503 | <a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> h = httplib2.Http()</tt> </tt> |
| 504 | <a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> h = credentials.authorize(h)</tt> </tt> |
| 505 | <a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 506 | <a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"><tt class="py-docstring"> You can't create a new OAuth subclass of httplib2.Authenication</tt> </tt> |
| 507 | <a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"><tt class="py-docstring"> because it never gets passed the absolute URI, which is needed for</tt> </tt> |
| 508 | <a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"><tt class="py-docstring"> signing. So instead we have to overload 'request' with a closure</tt> </tt> |
| 509 | <a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"><tt class="py-docstring"> that adds in the Authorization header and then calls the original</tt> </tt> |
| 510 | <a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"><tt class="py-docstring"> version of 'request()'.</tt> </tt> |
| 511 | <a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 512 | <a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> <tt class="py-name">request_orig</tt> <tt class="py-op">=</tt> <tt id="link-43" 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 |
| 513 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-43', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-44" 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 |
| 514 | apiclient.http.HttpMockSequence.request |
| 515 | apiclient.model.BaseModel.request |
| 516 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-44', 'request', 'link-44');">request</a></tt> </tt> |
| 517 | <a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> </tt> |
| 518 | <a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-comment"># The closure that will replace 'httplib2.Http.request'.</tt> </tt> |
| 519 | <a name="L397"></a><tt class="py-lineno"> 397</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> |
| 520 | <a name="L398"></a><tt class="py-lineno"> 398</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> |
| 521 | <a name="L399"></a><tt class="py-lineno"> 399</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> |
| 522 | <a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">access_token</tt><tt class="py-op">:</tt> </tt> |
| 523 | <a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt id="link-45" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 524 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 525 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 526 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 527 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 528 | oauth2client.multistore_file.logger |
| 529 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-45', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Attempting refresh to obtain initial access_token'</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 530 | <a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name" targets="Method oauth2client.appengine.AppAssertionCredentials._refresh()=oauth2client.appengine.AppAssertionCredentials-class.html#_refresh,Method oauth2client.client.AccessTokenCredentials._refresh()=oauth2client.client.AccessTokenCredentials-class.html#_refresh,Method oauth2client.client.OAuth2Credentials._refresh()=oauth2client.client.OAuth2Credentials-class.html#_refresh"><a title="oauth2client.appengine.AppAssertionCredentials._refresh |
| 531 | oauth2client.client.AccessTokenCredentials._refresh |
| 532 | oauth2client.client.OAuth2Credentials._refresh" class="py-name" href="#" onclick="return doclink('link-46', '_refresh', 'link-46');">_refresh</a></tt><tt class="py-op">(</tt><tt class="py-name">request_orig</tt><tt class="py-op">)</tt> </tt> |
| 533 | <a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> </tt> |
| 534 | <a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-comment"># Modify the request headers to add the appropriate</tt> </tt> |
| 535 | <a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-comment"># Authorization header.</tt> </tt> |
| 536 | <a name="L406"></a><tt class="py-lineno"> 406</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> |
| 537 | <a name="L407"></a><tt class="py-lineno"> 407</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> |
| 538 | <a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" 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 |
| 539 | oauth2client.client.OAuth2Credentials.apply" class="py-name" href="#" onclick="return doclink('link-47', 'apply', 'link-47');">apply</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 540 | <a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> </tt> |
| 541 | <a name="L410"></a><tt class="py-lineno"> 410</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">user_agent</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> |
| 542 | <a name="L411"></a><tt class="py-lineno"> 411</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> |
| 543 | <a name="L412"></a><tt class="py-lineno"> 412</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">self</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> |
| 544 | <a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 545 | <a name="L414"></a><tt class="py-lineno"> 414</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">self</tt><tt class="py-op">.</tt><tt class="py-name">user_agent</tt> </tt> |
| 546 | <a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> </tt> |
| 547 | <a name="L416"></a><tt class="py-lineno"> 416</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> |
| 548 | <a name="L417"></a><tt class="py-lineno"> 417</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> |
| 549 | <a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 550 | <a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-comment"># Older API (GData) respond with 403</tt> </tt> |
| 551 | <a name="L420"></a><tt class="py-lineno"> 420</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">401</tt><tt class="py-op">,</tt> <tt class="py-number">403</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt> |
| 552 | <a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt id="link-48" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 553 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 554 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 555 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 556 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 557 | oauth2client.multistore_file.logger |
| 558 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-48', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Refreshing due to a %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</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-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 559 | <a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="oauth2client.appengine.AppAssertionCredentials._refresh |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 560 | oauth2client.client.AccessTokenCredentials._refresh |
| 561 | oauth2client.client.OAuth2Credentials._refresh" class="py-name" href="#" onclick="return doclink('link-49', '_refresh', 'link-46');">_refresh</a></tt><tt class="py-op">(</tt><tt class="py-name">request_orig</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 562 | <a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="oauth2client.client.Credentials.apply |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 563 | oauth2client.client.OAuth2Credentials.apply" class="py-name" href="#" onclick="return doclink('link-50', 'apply', 'link-47');">apply</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 564 | <a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-keyword">return</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> |
| 565 | <a name="L425"></a><tt class="py-lineno"> 425</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> |
| 566 | <a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 567 | <a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-keyword">return</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> |
| 568 | </div><a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> </tt> |
| 569 | <a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-comment"># Replace the request method with our own closure.</tt> </tt> |
| 570 | <a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt id="link-51" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 571 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-51', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="apiclient.http.HttpMock.request |
| 572 | apiclient.http.HttpMockSequence.request |
| 573 | apiclient.model.BaseModel.request |
| 574 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-52', 'request', 'link-44');">request</a></tt> <tt class="py-op">=</tt> <tt class="py-name">new_request</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 575 | <a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> </tt> |
| 576 | <a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-comment"># Set credentials as a property of the request method.</tt> </tt> |
| 577 | <a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt id="link-53" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 578 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-53', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="apiclient.http.HttpMock.request |
| 579 | apiclient.http.HttpMockSequence.request |
| 580 | apiclient.model.BaseModel.request |
| 581 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-54', 'request', 'link-44');">request</a></tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 582 | <a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> </tt> |
| 583 | <a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-55" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 584 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-55', 'http', 'link-43');">http</a></tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 585 | </div><a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> </tt> |
| 586 | <a name="OAuth2Credentials.refresh"></a><div id="OAuth2Credentials.refresh-def"><a name="L437"></a><tt class="py-lineno"> 437</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.refresh-toggle" onclick="return toggle('OAuth2Credentials.refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</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-op">:</tt> </tt> |
| 587 | </div><div id="OAuth2Credentials.refresh-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.refresh-expanded"><a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> <tt class="py-docstring">"""Forces a refresh of the access_token.</tt> </tt> |
| 588 | <a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 589 | <a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 590 | <a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, an http object to be used to make the refresh</tt> </tt> |
| 591 | <a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt> |
| 592 | <a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 593 | <a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="oauth2client.appengine.AppAssertionCredentials._refresh |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 594 | oauth2client.client.AccessTokenCredentials._refresh |
| 595 | oauth2client.client.OAuth2Credentials._refresh" class="py-name" href="#" onclick="return doclink('link-56', '_refresh', 'link-46');">_refresh</a></tt><tt class="py-op">(</tt><tt id="link-57" class="py-name"><a title="apiclient.http |
| 596 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-57', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="apiclient.http.HttpMock.request |
| 597 | apiclient.http.HttpMockSequence.request |
| 598 | apiclient.model.BaseModel.request |
| 599 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-58', 'request', 'link-44');">request</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 600 | </div><a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> </tt> |
| 601 | <a name="OAuth2Credentials.apply"></a><div id="OAuth2Credentials.apply-def"><a name="L446"></a><tt class="py-lineno"> 446</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.apply-toggle" onclick="return toggle('OAuth2Credentials.apply');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 602 | </div><div id="OAuth2Credentials.apply-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.apply-expanded"><a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-docstring">"""Add the authorization to the headers.</tt> </tt> |
| 603 | <a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 604 | <a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 605 | <a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, the headers to add the Authorization header to.</tt> </tt> |
| 606 | <a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 607 | <a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-string">'Authorization'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'Bearer '</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">access_token</tt> </tt> |
| 608 | </div><a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> </tt> |
| 609 | <a name="OAuth2Credentials.to_json"></a><div id="OAuth2Credentials.to_json-def"><a name="L454"></a><tt class="py-lineno"> 454</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.to_json-toggle" onclick="return toggle('OAuth2Credentials.to_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-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> |
| 610 | </div><div id="OAuth2Credentials.to_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.to_json-expanded"><a name="L455"></a><tt class="py-lineno"> 455</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-59" class="py-name"><a title="apiclient.http.MediaUpload._to_json |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 611 | oauth2client.client.Credentials._to_json" class="py-name" href="#" onclick="return doclink('link-59', '_to_json', 'link-23');">_to_json</a></tt><tt class="py-op">(</tt><tt id="link-60" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-60', 'Credentials', 'link-24');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" class="py-name" href="#" onclick="return doclink('link-61', 'NON_SERIALIZED_MEMBERS', 'link-18');">NON_SERIALIZED_MEMBERS</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 612 | </div><a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> </tt> |
| 613 | <a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 614 | <a name="OAuth2Credentials.from_json"></a><div id="OAuth2Credentials.from_json-def"><a name="L458"></a><tt class="py-lineno"> 458</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.from_json-toggle" onclick="return toggle('OAuth2Credentials.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#from_json">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> |
| 615 | </div><div id="OAuth2Credentials.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.from_json-expanded"><a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> <tt class="py-docstring">"""Instantiate a Credentials object from a JSON description of it. The JSON</tt> </tt> |
| 616 | <a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> should have been produced by calling .to_json() on the object.</tt> </tt> |
| 617 | <a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 618 | <a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 619 | <a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> data: dict, A deserialized JSON object.</tt> </tt> |
| 620 | <a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 621 | <a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 622 | <a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"><tt class="py-docstring"> An instance of a Credentials subclass.</tt> </tt> |
| 623 | <a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 624 | <a name="L468"></a><tt class="py-lineno"> 468</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-62" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-62', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 625 | <a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'token_expiry'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">data</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 626 | <a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 627 | <a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 628 | <a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">strptime</tt><tt class="py-op">(</tt> </tt> |
| 629 | <a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-63" class="py-name"><a title="oauth2client.client.EXPIRY_FORMAT" class="py-name" href="#" onclick="return doclink('link-63', 'EXPIRY_FORMAT', 'link-14');">EXPIRY_FORMAT</a></tt><tt class="py-op">)</tt> </tt> |
| 630 | <a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt> |
| 631 | <a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 632 | <a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-64" class="py-name" targets="Class oauth2client.client.OAuth2Credentials=oauth2client.client.OAuth2Credentials-class.html"><a title="oauth2client.client.OAuth2Credentials" class="py-name" href="#" onclick="return doclink('link-64', 'OAuth2Credentials', 'link-64');">OAuth2Credentials</a></tt><tt class="py-op">(</tt> </tt> |
| 633 | <a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'access_token'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 634 | <a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'client_id'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 635 | <a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'client_secret'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 636 | <a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'refresh_token'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 637 | <a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_expiry'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 638 | <a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 639 | <a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'user_agent'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 640 | <a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 641 | oauth2client.appengine.OAuth2Handler.get |
| 642 | oauth2client.client.MemoryCache.get |
| 643 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-65', 'get', 'link-17');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'id_token'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 644 | <a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-name">retval</tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'invalid'</tt><tt class="py-op">]</tt> </tt> |
| 645 | <a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">retval</tt> </tt> |
| 646 | </div><a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> </tt> |
| 647 | <a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| 648 | <a name="OAuth2Credentials.access_token_expired"></a><div id="OAuth2Credentials.access_token_expired-def"><a name="L489"></a><tt class="py-lineno"> 489</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.access_token_expired-toggle" onclick="return toggle('OAuth2Credentials.access_token_expired');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 649 | </div><div id="OAuth2Credentials.access_token_expired-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.access_token_expired-expanded"><a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-docstring">"""True if the credential is expired or invalid.</tt> </tt> |
| 650 | <a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 651 | <a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-docstring"> If the token_expiry isn't set, we assume the token doesn't expire.</tt> </tt> |
| 652 | <a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 653 | <a name="L494"></a><tt class="py-lineno"> 494</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">invalid</tt><tt class="py-op">:</tt> </tt> |
| 654 | <a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt> |
| 655 | <a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> </tt> |
| 656 | <a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_expiry</tt><tt class="py-op">:</tt> </tt> |
| 657 | <a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt> |
| 658 | <a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> </tt> |
| 659 | <a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> <tt class="py-name">now</tt> <tt class="py-op">=</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">utcnow</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 660 | <a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">now</tt> <tt class="py-op">>=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_expiry</tt><tt class="py-op">:</tt> </tt> |
| 661 | <a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt id="link-66" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 662 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 663 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 664 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 665 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 666 | oauth2client.multistore_file.logger |
| 667 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-66', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'access_token is expired. Now: %s, token_expiry: %s'</tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 668 | <a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-name">now</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_expiry</tt><tt class="py-op">)</tt> </tt> |
| 669 | <a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt> |
| 670 | <a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt> |
| 671 | </div><a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> </tt> |
| 672 | <a name="OAuth2Credentials.set_store"></a><div id="OAuth2Credentials.set_store-def"><a name="L507"></a><tt class="py-lineno"> 507</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.set_store-toggle" onclick="return toggle('OAuth2Credentials.set_store');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">store</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 673 | </div><div id="OAuth2Credentials.set_store-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.set_store-expanded"><a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> <tt class="py-docstring">"""Set the Storage for the credential.</tt> </tt> |
| 674 | <a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 675 | <a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 676 | <a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-docstring"> store: Storage, an implementation of Stroage object.</tt> </tt> |
| 677 | <a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-docstring"> This is needed to store the latest access_token if it</tt> </tt> |
| 678 | <a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-docstring"> has expired and been refreshed. This implementation uses</tt> </tt> |
| 679 | <a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-docstring"> locking to check for updates before updating the</tt> </tt> |
| 680 | <a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-docstring"> access_token.</tt> </tt> |
| 681 | <a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 682 | <a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt> <tt class="py-op">=</tt> <tt class="py-name">store</tt> </tt> |
| 683 | </div><a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"> </tt> |
| 684 | <a name="OAuth2Credentials._updateFromCredential"></a><div id="OAuth2Credentials._updateFromCredential-def"><a name="L519"></a><tt class="py-lineno"> 519</tt> <a class="py-toggle" href="#" id="OAuth2Credentials._updateFromCredential-toggle" onclick="return toggle('OAuth2Credentials._updateFromCredential');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential">_updateFromCredential</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 685 | </div><div id="OAuth2Credentials._updateFromCredential-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials._updateFromCredential-expanded"><a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-docstring">"""Update this Credential from another instance."""</tt> </tt> |
| 686 | <a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name" targets="Method oauth2client.client.OAuth2Credentials.__getstate__()=oauth2client.client.OAuth2Credentials-class.html#__getstate__"><a title="oauth2client.client.OAuth2Credentials.__getstate__" class="py-name" href="#" onclick="return doclink('link-67', '__getstate__', 'link-67');">__getstate__</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 687 | </div><a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> </tt> |
| 688 | <a name="OAuth2Credentials.__getstate__"></a><div id="OAuth2Credentials.__getstate__-def"><a name="L523"></a><tt class="py-lineno"> 523</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.__getstate__-toggle" onclick="return toggle('OAuth2Credentials.__getstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 689 | </div><div id="OAuth2Credentials.__getstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.__getstate__-expanded"><a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-docstring">"""Trim the state down to something that can be pickled."""</tt> </tt> |
| 690 | <a name="L525"></a><tt class="py-lineno"> 525</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> |
| 691 | <a name="L526"></a><tt class="py-lineno"> 526</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">'store'</tt><tt class="py-op">]</tt> </tt> |
| 692 | <a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">d</tt> </tt> |
| 693 | </div><a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> </tt> |
| 694 | <a name="OAuth2Credentials.__setstate__"></a><div id="OAuth2Credentials.__setstate__-def"><a name="L529"></a><tt class="py-lineno"> 529</tt> <a class="py-toggle" href="#" id="OAuth2Credentials.__setstate__-toggle" onclick="return toggle('OAuth2Credentials.__setstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 695 | </div><div id="OAuth2Credentials.__setstate__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials.__setstate__-expanded"><a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt class="py-docstring">"""Reconstitute the state of the object from being pickled."""</tt> </tt> |
| 696 | <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">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">state</tt><tt class="py-op">)</tt> </tt> |
| 697 | <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">store</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 698 | </div><a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> </tt> |
| 699 | <a name="OAuth2Credentials._generate_refresh_request_body"></a><div id="OAuth2Credentials._generate_refresh_request_body-def"><a name="L534"></a><tt class="py-lineno"> 534</tt> <a class="py-toggle" href="#" id="OAuth2Credentials._generate_refresh_request_body-toggle" onclick="return toggle('OAuth2Credentials._generate_refresh_request_body');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body">_generate_refresh_request_body</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 700 | </div><div id="OAuth2Credentials._generate_refresh_request_body-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials._generate_refresh_request_body-expanded"><a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-docstring">"""Generate the body that will be used in the refresh request."""</tt> </tt> |
| 701 | <a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt> </tt> |
| 702 | <a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-string">'grant_type'</tt><tt class="py-op">:</tt> <tt class="py-string">'refresh_token'</tt><tt class="py-op">,</tt> </tt> |
| 703 | <a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt><tt class="py-op">,</tt> </tt> |
| 704 | <a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_secret</tt><tt class="py-op">,</tt> </tt> |
| 705 | <a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-string">'refresh_token'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">refresh_token</tt><tt class="py-op">,</tt> </tt> |
| 706 | <a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt class="py-op">}</tt><tt class="py-op">)</tt> </tt> |
| 707 | <a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">body</tt> </tt> |
| 708 | </div><a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> </tt> |
| 709 | <a name="OAuth2Credentials._generate_refresh_request_headers"></a><div id="OAuth2Credentials._generate_refresh_request_headers-def"><a name="L544"></a><tt class="py-lineno"> 544</tt> <a class="py-toggle" href="#" id="OAuth2Credentials._generate_refresh_request_headers-toggle" onclick="return toggle('OAuth2Credentials._generate_refresh_request_headers');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers">_generate_refresh_request_headers</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 710 | </div><div id="OAuth2Credentials._generate_refresh_request_headers-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials._generate_refresh_request_headers-expanded"><a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-docstring">"""Generate the headers that will be used in the refresh request."""</tt> </tt> |
| 711 | <a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 712 | <a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-string">'content-type'</tt><tt class="py-op">:</tt> <tt class="py-string">'application/x-www-form-urlencoded'</tt><tt class="py-op">,</tt> </tt> |
| 713 | <a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 714 | <a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> </tt> |
| 715 | <a name="L550"></a><tt class="py-lineno"> 550</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">user_agent</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> |
| 716 | <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-string">'user-agent'</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">user_agent</tt> </tt> |
| 717 | <a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> </tt> |
| 718 | <a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">headers</tt> </tt> |
| 719 | </div><a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> </tt> |
| 720 | <a name="OAuth2Credentials._refresh"></a><div id="OAuth2Credentials._refresh-def"><a name="L555"></a><tt class="py-lineno"> 555</tt> <a class="py-toggle" href="#" id="OAuth2Credentials._refresh-toggle" onclick="return toggle('OAuth2Credentials._refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#_refresh">_refresh</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http_request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 721 | </div><div id="OAuth2Credentials._refresh-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials._refresh-expanded"><a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> <tt class="py-docstring">"""Refreshes the access_token.</tt> </tt> |
| 722 | <a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 723 | <a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-docstring"> This method first checks by reading the Storage object if available.</tt> </tt> |
| 724 | <a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-docstring"> If a refresh is still needed, it holds the Storage lock until the</tt> </tt> |
| 725 | <a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-docstring"> refresh is completed.</tt> </tt> |
| 726 | <a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 727 | <a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 728 | <a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"><tt class="py-docstring"> http_request: callable, a callable that matches the method signature of</tt> </tt> |
| 729 | <a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Http.request, used to make the refresh request.</tt> </tt> |
| 730 | <a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 731 | <a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 732 | <a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"><tt class="py-docstring"> AccessTokenRefreshError: When the refresh fails.</tt> </tt> |
| 733 | <a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 734 | <a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt><tt class="py-op">:</tt> </tt> |
| 735 | <a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Method oauth2client.client.OAuth2Credentials._do_refresh_request()=oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request"><a title="oauth2client.client.OAuth2Credentials._do_refresh_request" class="py-name" href="#" onclick="return doclink('link-68', '_do_refresh_request', 'link-68');">_do_refresh_request</a></tt><tt class="py-op">(</tt><tt class="py-name">http_request</tt><tt class="py-op">)</tt> </tt> |
| 736 | <a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 737 | <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">store</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="oauth2client.client.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 738 | oauth2client.file.Storage.acquire_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 739 | oauth2client.keyring_storage.Storage.acquire_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 740 | oauth2client.multistore_file._MultiStore._Storage.acquire_lock" class="py-name" href="#" onclick="return doclink('link-69', 'acquire_lock', 'link-33');">acquire_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 741 | <a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 742 | <a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-name">new_cred</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="oauth2client.appengine.StorageByKeyName.locked_get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 743 | oauth2client.client.Storage.locked_get |
| 744 | oauth2client.django_orm.Storage.locked_get |
| 745 | oauth2client.file.Storage.locked_get |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 746 | oauth2client.keyring_storage.Storage.locked_get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 747 | oauth2client.multistore_file._MultiStore._Storage.locked_get" class="py-name" href="#" onclick="return doclink('link-70', 'locked_get', 'link-34');">locked_get</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 748 | <a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">new_cred</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">new_cred</tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> <tt class="py-keyword">and</tt> </tt> |
| 749 | <a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-name">new_cred</tt><tt class="py-op">.</tt><tt class="py-name">access_token</tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">access_token</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 750 | <a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt id="link-71" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 751 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 752 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 753 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 754 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 755 | oauth2client.multistore_file.logger |
| 756 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-71', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Updated access_token read from Storage'</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 757 | <a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Method oauth2client.client.OAuth2Credentials._updateFromCredential()=oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential"><a title="oauth2client.client.OAuth2Credentials._updateFromCredential" class="py-name" href="#" onclick="return doclink('link-72', '_updateFromCredential', 'link-72');">_updateFromCredential</a></tt><tt class="py-op">(</tt><tt class="py-name">new_cred</tt><tt class="py-op">)</tt> </tt> |
| 758 | <a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 759 | <a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="oauth2client.client.OAuth2Credentials._do_refresh_request" class="py-name" href="#" onclick="return doclink('link-73', '_do_refresh_request', 'link-68');">_do_refresh_request</a></tt><tt class="py-op">(</tt><tt class="py-name">http_request</tt><tt class="py-op">)</tt> </tt> |
| 760 | <a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt> |
| 761 | <a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="oauth2client.client.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 762 | oauth2client.file.Storage.release_lock |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 763 | oauth2client.keyring_storage.Storage.release_lock |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 764 | oauth2client.multistore_file._MultiStore._Storage.release_lock" class="py-name" href="#" onclick="return doclink('link-74', 'release_lock', 'link-35');">release_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 765 | </div><a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> </tt> |
| 766 | <a name="OAuth2Credentials._do_refresh_request"></a><div id="OAuth2Credentials._do_refresh_request-def"><a name="L584"></a><tt class="py-lineno"> 584</tt> <a class="py-toggle" href="#" id="OAuth2Credentials._do_refresh_request-toggle" onclick="return toggle('OAuth2Credentials._do_refresh_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request">_do_refresh_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http_request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 767 | </div><div id="OAuth2Credentials._do_refresh_request-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2Credentials._do_refresh_request-expanded"><a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-docstring">"""Refresh the access_token using the refresh_token.</tt> </tt> |
| 768 | <a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 769 | <a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 770 | <a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-docstring"> http_request: callable, a callable that matches the method signature of</tt> </tt> |
| 771 | <a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Http.request, used to make the refresh request.</tt> </tt> |
| 772 | <a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 773 | <a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 774 | <a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-docstring"> AccessTokenRefreshError: When the refresh fails.</tt> </tt> |
| 775 | <a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 776 | <a name="L594"></a><tt class="py-lineno"> 594</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-75" class="py-name" targets="Method oauth2client.client.AssertionCredentials._generate_refresh_request_body()=oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body,Method oauth2client.client.OAuth2Credentials._generate_refresh_request_body()=oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body"><a title="oauth2client.client.AssertionCredentials._generate_refresh_request_body |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 777 | oauth2client.client.OAuth2Credentials._generate_refresh_request_body" class="py-name" href="#" onclick="return doclink('link-75', '_generate_refresh_request_body', 'link-75');">_generate_refresh_request_body</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 778 | <a name="L595"></a><tt class="py-lineno"> 595</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 id="link-76" class="py-name" targets="Method oauth2client.client.OAuth2Credentials._generate_refresh_request_headers()=oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers"><a title="oauth2client.client.OAuth2Credentials._generate_refresh_request_headers" class="py-name" href="#" onclick="return doclink('link-76', '_generate_refresh_request_headers', 'link-76');">_generate_refresh_request_headers</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 779 | <a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> </tt> |
| 780 | <a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt id="link-77" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 781 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 782 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 783 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 784 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 785 | oauth2client.multistore_file.logger |
| 786 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-77', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Refreshing access_token'</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 787 | <a name="L598"></a><tt class="py-lineno"> 598</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">http_request</tt><tt class="py-op">(</tt> </tt> |
| 788 | <a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</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 class="py-name">headers</tt><tt class="py-op">=</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| 789 | <a name="L600"></a><tt class="py-lineno"> 600</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-op">:</tt> </tt> |
| 790 | <a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> <tt class="py-comment"># TODO(jcgregorio) Raise an error if loads fails?</tt> </tt> |
| 791 | <a name="L602"></a><tt class="py-lineno"> 602</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-78" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-78', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 792 | <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">access_token</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'access_token'</tt><tt class="py-op">]</tt> </tt> |
| 793 | <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">refresh_token</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 794 | oauth2client.appengine.OAuth2Handler.get |
| 795 | oauth2client.client.MemoryCache.get |
| 796 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-79', 'get', 'link-17');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'refresh_token'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">refresh_token</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 797 | <a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'expires_in'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 798 | <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 class="py-name">token_expiry</tt> <tt class="py-op">=</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">timedelta</tt><tt class="py-op">(</tt> </tt> |
| 799 | <a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-name">seconds</tt><tt class="py-op">=</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'expires_in'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">utcnow</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 800 | <a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 801 | <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">token_expiry</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 802 | <a name="L610"></a><tt class="py-lineno"> 610</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">store</tt><tt class="py-op">:</tt> </tt> |
| 803 | <a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="oauth2client.appengine.StorageByKeyName.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 804 | oauth2client.client.Storage.locked_put |
| 805 | oauth2client.django_orm.Storage.locked_put |
| 806 | oauth2client.file.Storage.locked_put |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 807 | oauth2client.keyring_storage.Storage.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 808 | oauth2client.multistore_file._MultiStore._Storage.locked_put" class="py-name" href="#" onclick="return doclink('link-80', 'locked_put', 'link-37');">locked_put</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 809 | <a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 810 | <a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-comment"># An {'error':...} response body means the token is expired or revoked,</tt> </tt> |
| 811 | <a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt class="py-comment"># so we flag the credentials as such.</tt> </tt> |
| 812 | <a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt id="link-81" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 813 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 814 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 815 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 816 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 817 | oauth2client.multistore_file.logger |
| 818 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-81', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Failed to retrieve access token: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 819 | <a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'Invalid response %s.'</tt> <tt class="py-op">%</tt> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'status'</tt><tt class="py-op">]</tt> </tt> |
| 820 | <a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 821 | <a name="L618"></a><tt class="py-lineno"> 618</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-82" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-82', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 822 | <a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'error'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 823 | <a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'error'</tt><tt class="py-op">]</tt> </tt> |
| 824 | <a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> |
| 825 | <a name="L622"></a><tt class="py-lineno"> 622</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">store</tt><tt class="py-op">:</tt> </tt> |
| 826 | <a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="oauth2client.appengine.StorageByKeyName.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 827 | oauth2client.client.Storage.locked_put |
| 828 | oauth2client.django_orm.Storage.locked_put |
| 829 | oauth2client.file.Storage.locked_put |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 830 | oauth2client.keyring_storage.Storage.locked_put |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 831 | oauth2client.multistore_file._MultiStore._Storage.locked_put" class="py-name" href="#" onclick="return doclink('link-83', 'locked_put', 'link-37');">locked_put</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 832 | <a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt> |
| 833 | <a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> |
| 834 | <a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-84" class="py-name" targets="Class oauth2client.client.AccessTokenRefreshError=oauth2client.client.AccessTokenRefreshError-class.html"><a title="oauth2client.client.AccessTokenRefreshError" class="py-name" href="#" onclick="return doclink('link-84', 'AccessTokenRefreshError', 'link-84');">AccessTokenRefreshError</a></tt><tt class="py-op">(</tt><tt class="py-name">error_msg</tt><tt class="py-op">)</tt> </tt> |
| 835 | </div></div><a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> </tt> |
| 836 | <a name="AccessTokenCredentials"></a><div id="AccessTokenCredentials-def"><a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> </tt> |
| 837 | <a name="L629"></a><tt class="py-lineno"> 629</tt> <a class="py-toggle" href="#" id="AccessTokenCredentials-toggle" onclick="return toggle('AccessTokenCredentials');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenCredentials-class.html">AccessTokenCredentials</a><tt class="py-op">(</tt><tt class="py-base-class">OAuth2Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 838 | </div><div id="AccessTokenCredentials-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="AccessTokenCredentials-expanded"><a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-docstring">"""Credentials object for OAuth 2.0.</tt> </tt> |
| 839 | <a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 840 | <a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"><tt class="py-docstring"> Credentials can be applied to an httplib2.Http object using the</tt> </tt> |
| 841 | <a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> authorize() method, which then signs each request from that object</tt> </tt> |
| 842 | <a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"> with the OAuth 2.0 access token. This set of credentials is for the</tt> </tt> |
| 843 | <a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> use case where you have acquired an OAuth 2.0 access_token from</tt> </tt> |
| 844 | <a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> another place such as a JavaScript client or another web</tt> </tt> |
| 845 | <a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> application, and wish to use it from Python. Because only the</tt> </tt> |
| 846 | <a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"> access_token is present it can not be refreshed and will in time</tt> </tt> |
| 847 | <a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"><tt class="py-docstring"> expire.</tt> </tt> |
| 848 | <a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 849 | <a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-docstring"> AccessTokenCredentials objects may be safely pickled and unpickled.</tt> </tt> |
| 850 | <a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 851 | <a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-docstring"> Usage:</tt> </tt> |
| 852 | <a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-docstring"> credentials = AccessTokenCredentials('<an access token>',</tt> </tt> |
| 853 | <a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"><tt class="py-docstring"> 'my-user-agent/1.0')</tt> </tt> |
| 854 | <a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-docstring"> http = httplib2.Http()</tt> </tt> |
| 855 | <a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-docstring"> http = credentials.authorize(http)</tt> </tt> |
| 856 | <a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 857 | <a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-docstring"> Exceptions:</tt> </tt> |
| 858 | <a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-docstring"> AccessTokenCredentialsExpired: raised when the access_token expires or is</tt> </tt> |
| 859 | <a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"><tt class="py-docstring"> revoked.</tt> </tt> |
| 860 | <a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 861 | <a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> </tt> |
| 862 | <a name="AccessTokenCredentials.__init__"></a><div id="AccessTokenCredentials.__init__-def"><a name="L654"></a><tt class="py-lineno"> 654</tt> <a class="py-toggle" href="#" id="AccessTokenCredentials.__init__-toggle" onclick="return toggle('AccessTokenCredentials.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenCredentials-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">access_token</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 863 | </div><div id="AccessTokenCredentials.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AccessTokenCredentials.__init__-expanded"><a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-docstring">"""Create an instance of OAuth2Credentials</tt> </tt> |
| 864 | <a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 865 | <a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-docstring"> This is one of the few types if Credentials that you should contrust,</tt> </tt> |
| 866 | <a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"><tt class="py-docstring"> Credentials objects are usually instantiated by a Flow.</tt> </tt> |
| 867 | <a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 868 | <a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 869 | <a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"><tt class="py-docstring"> access_token: string, access token.</tt> </tt> |
| 870 | <a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, The HTTP User-Agent to provide for this application.</tt> </tt> |
| 871 | <a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 872 | <a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"><tt class="py-docstring"> Notes:</tt> </tt> |
| 873 | <a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"><tt class="py-docstring"> store: callable, a callable that when passed a Credential</tt> </tt> |
| 874 | <a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"><tt class="py-docstring"> will store the credential back to where it came from.</tt> </tt> |
| 875 | <a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 876 | <a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-85" class="py-name" targets="Class oauth2client.client.AccessTokenCredentials=oauth2client.client.AccessTokenCredentials-class.html"><a title="oauth2client.client.AccessTokenCredentials" class="py-name" href="#" onclick="return doclink('link-85', 'AccessTokenCredentials', 'link-85');">AccessTokenCredentials</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name" targets="Method apiclient.errors.BatchError.__init__()=apiclient.errors.BatchError-class.html#__init__,Method apiclient.errors.HttpError.__init__()=apiclient.errors.HttpError-class.html#__init__,Method apiclient.errors.UnexpectedBodyError.__init__()=apiclient.errors.UnexpectedBodyError-class.html#__init__,Method apiclient.errors.UnexpectedMethodError.__init__()=apiclient.errors.UnexpectedMethodError-class.html#__init__,Method apiclient.http.BatchHttpRequest.__init__()=apiclient.http.BatchHttpRequest-class.html#__init__,Method apiclient.http.HttpMock.__init__()=apiclient.http.HttpMock-class.html#__init__,Method apiclient.http.HttpMockSequence.__init__()=apiclient.http.HttpMockSequence-class.html#__init__,Method apiclient.http.HttpRequest.__init__()=apiclient.http.HttpRequest-class.html#__init__,Method apiclient.http.HttpRequestMock.__init__()=apiclient.http.HttpRequestMock-class.html#__init__,Method apiclient.http.MediaDownloadProgress.__init__()=apiclient.http.MediaDownloadProgress-class.html#__init__,Method apiclient.http.MediaFileUpload.__init__()=apiclient.http.MediaFileUpload-class.html#__init__,Method apiclient.http.MediaInMemoryUpload.__init__()=apiclient.http.MediaInMemoryUpload-class.html#__init__,Method apiclient.http.MediaIoBaseDownload.__init__()=apiclient.http.MediaIoBaseDownload-class.html#__init__,Method apiclient.http.MediaIoBaseUpload.__init__()=apiclient.http.MediaIoBaseUpload-class.html#__init__,Method apiclient.http.MediaUploadProgress.__init__()=apiclient.http.MediaUploadProgress-class.html#__init__,Method apiclient.http.RequestMockBuilder.__init__()=apiclient.http.RequestMockBuilder-class.html#__init__,Method apiclient.model.JsonModel.__init__()=apiclient.model.JsonModel-class.html#__init__,Method apiclient.model.ProtocolBufferModel.__init__()=apiclient.model.ProtocolBufferModel-class.html#__init__,Method apiclient.schema.Schemas.__init__()=apiclient.schema.Schemas-class.html#__init__,Method apiclient.schema._SchemaToStruct.__init__()=apiclient.schema._SchemaToStruct-class.html#__init__,Method oauth2client.appengine.AppAssertionCredentials.__init__()=oauth2client.appengine.AppAssertionCredentials-class.html#__init__,Method oauth2client.appengine.OAuth2Decorator.__init__()=oauth2client.appengine.OAuth2Decorator-class.html#__init__,Method oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__()=oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html#__init__,Method oauth2client.appengine.StorageByKeyName.__init__()=oauth2client.appengine.StorageByKeyName-class.html#__init__,Method oauth2client.client.AccessTokenCredentials.__init__()=oauth2client.client.AccessTokenCredentials-class.html#__init__,Method oauth2client.client.AssertionCredentials.__init__()=oauth2client.client.AssertionCredentials-class.html#__init__,Method oauth2client.client.MemoryCache.__init__()=oauth2client.client.MemoryCache-class.html#__init__,Method oauth2client.client.OAuth2Credentials.__init__()=oauth2client.client.OAuth2Credentials-class.html#__init__,Method oauth2client.client.OAuth2WebServerFlow.__init__()=oauth2client.client.OAuth2WebServerFlow-class.html#__init__,Method oauth2client.client.SignedJwtAssertionCredentials.__init__()=oauth2client.client.SignedJwtAssertionCredentials-class.html#__init__,Method oauth2client.crypt.Signer.__init__()=oauth2client.crypt.Signer-class.html#__init__,Method oauth2client.crypt.Verifier.__init__()=oauth2client.crypt.Verifier-class.html#__init__,Method oauth2client.django_orm.CredentialsField.__init__()=oauth2client.django_orm.CredentialsField-class.html#__init__,Method oauth2client.django_orm.FlowField.__init__()=oauth2client.django_orm.FlowField-class.html#__init__,Method oauth2client.django_orm.Storage.__init__()=oauth2client.django_orm.Storage-class.html#__init__,Method oauth2client.file.Storage.__init__()=oauth2client.file.Storage-class.html#__init__,Method oauth2client.keyring_storage.Storage.__init__()=oauth2client.keyring_storage.Storage-class.html#__init__,Method oauth2client.locked_file.LockedFile.__init__()=oauth2client.locked_file.LockedFile-class.html#__init__,Method oauth2client.locked_file._Opener.__init__()=oauth2client.locked_file._Opener-class.html#__init__,Method oauth2client.multistore_file._MultiStore._Storage.__init__()=oauth2client.multistore_file._MultiStore._Storage-class.html#__init__,Method oauth2client.multistore_file._MultiStore.__init__()=oauth2client.multistore_file._MultiStore-class.html#__init__"><a title="apiclient.errors.BatchError.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 877 | apiclient.errors.HttpError.__init__ |
| 878 | apiclient.errors.UnexpectedBodyError.__init__ |
| 879 | apiclient.errors.UnexpectedMethodError.__init__ |
| 880 | apiclient.http.BatchHttpRequest.__init__ |
| 881 | apiclient.http.HttpMock.__init__ |
| 882 | apiclient.http.HttpMockSequence.__init__ |
| 883 | apiclient.http.HttpRequest.__init__ |
| 884 | apiclient.http.HttpRequestMock.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 885 | apiclient.http.MediaDownloadProgress.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 886 | apiclient.http.MediaFileUpload.__init__ |
| 887 | apiclient.http.MediaInMemoryUpload.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 888 | apiclient.http.MediaIoBaseDownload.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 889 | apiclient.http.MediaIoBaseUpload.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 890 | apiclient.http.MediaUploadProgress.__init__ |
| 891 | apiclient.http.RequestMockBuilder.__init__ |
| 892 | apiclient.model.JsonModel.__init__ |
| 893 | apiclient.model.ProtocolBufferModel.__init__ |
| 894 | apiclient.schema.Schemas.__init__ |
| 895 | apiclient.schema._SchemaToStruct.__init__ |
| 896 | oauth2client.appengine.AppAssertionCredentials.__init__ |
| 897 | oauth2client.appengine.OAuth2Decorator.__init__ |
| 898 | oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| 899 | oauth2client.appengine.StorageByKeyName.__init__ |
| 900 | oauth2client.client.AccessTokenCredentials.__init__ |
| 901 | oauth2client.client.AssertionCredentials.__init__ |
| 902 | oauth2client.client.MemoryCache.__init__ |
| 903 | oauth2client.client.OAuth2Credentials.__init__ |
| 904 | oauth2client.client.OAuth2WebServerFlow.__init__ |
| 905 | oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| 906 | oauth2client.crypt.Signer.__init__ |
| 907 | oauth2client.crypt.Verifier.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 908 | oauth2client.django_orm.CredentialsField.__init__ |
| 909 | oauth2client.django_orm.FlowField.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 910 | oauth2client.django_orm.Storage.__init__ |
| 911 | oauth2client.file.Storage.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 912 | oauth2client.keyring_storage.Storage.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 913 | oauth2client.locked_file.LockedFile.__init__ |
| 914 | oauth2client.locked_file._Opener.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 915 | oauth2client.multistore_file._MultiStore._Storage.__init__ |
| 916 | oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-86', '__init__', 'link-86');">__init__</a></tt><tt class="py-op">(</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 917 | <a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-name">access_token</tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 918 | <a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 919 | <a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 920 | <a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 921 | <a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 922 | <a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 923 | <a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-name">user_agent</tt><tt class="py-op">)</tt> </tt> |
| 924 | </div><a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> </tt> |
| 925 | <a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> </tt> |
| 926 | <a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 927 | <a name="AccessTokenCredentials.from_json"></a><div id="AccessTokenCredentials.from_json-def"><a name="L679"></a><tt class="py-lineno"> 679</tt> <a class="py-toggle" href="#" id="AccessTokenCredentials.from_json-toggle" onclick="return toggle('AccessTokenCredentials.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenCredentials-class.html#from_json">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> |
| 928 | </div><div id="AccessTokenCredentials.from_json-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AccessTokenCredentials.from_json-expanded"><a name="L680"></a><tt class="py-lineno"> 680</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-87" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-87', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 929 | <a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-88" class="py-name"><a title="oauth2client.client.AccessTokenCredentials" class="py-name" href="#" onclick="return doclink('link-88', 'AccessTokenCredentials', 'link-85');">AccessTokenCredentials</a></tt><tt class="py-op">(</tt> </tt> |
| 930 | <a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'access_token'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 931 | <a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'user_agent'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 932 | <a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">retval</tt> </tt> |
| 933 | </div><a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> </tt> |
| 934 | <a name="AccessTokenCredentials._refresh"></a><div id="AccessTokenCredentials._refresh-def"><a name="L686"></a><tt class="py-lineno"> 686</tt> <a class="py-toggle" href="#" id="AccessTokenCredentials._refresh-toggle" onclick="return toggle('AccessTokenCredentials._refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AccessTokenCredentials-class.html#_refresh">_refresh</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">http_request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 935 | </div><div id="AccessTokenCredentials._refresh-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AccessTokenCredentials._refresh-expanded"><a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-89" class="py-name" targets="Class oauth2client.client.AccessTokenCredentialsError=oauth2client.client.AccessTokenCredentialsError-class.html"><a title="oauth2client.client.AccessTokenCredentialsError" class="py-name" href="#" onclick="return doclink('link-89', 'AccessTokenCredentialsError', 'link-89');">AccessTokenCredentialsError</a></tt><tt class="py-op">(</tt> </tt> |
| 936 | <a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-string">"The access_token is expired or invalid and can't be refreshed."</tt><tt class="py-op">)</tt> </tt> |
| 937 | </div></div><a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> </tt> |
| 938 | <a name="AssertionCredentials"></a><div id="AssertionCredentials-def"><a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> </tt> |
| 939 | <a name="L691"></a><tt class="py-lineno"> 691</tt> <a class="py-toggle" href="#" id="AssertionCredentials-toggle" onclick="return toggle('AssertionCredentials');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.AssertionCredentials-class.html">AssertionCredentials</a><tt class="py-op">(</tt><tt class="py-base-class">OAuth2Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 940 | </div><div id="AssertionCredentials-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="AssertionCredentials-expanded"><a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-docstring">"""Abstract Credentials object used for OAuth 2.0 assertion grants.</tt> </tt> |
| 941 | <a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 942 | <a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"><tt class="py-docstring"> This credential does not require a flow to instantiate because it</tt> </tt> |
| 943 | <a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"><tt class="py-docstring"> represents a two legged flow, and therefore has all of the required</tt> </tt> |
| 944 | <a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"><tt class="py-docstring"> information to generate and refresh its own access tokens. It must</tt> </tt> |
| 945 | <a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"><tt class="py-docstring"> be subclassed to generate the appropriate assertion string.</tt> </tt> |
| 946 | <a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 947 | <a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"><tt class="py-docstring"> AssertionCredentials objects may be safely pickled and unpickled.</tt> </tt> |
| 948 | <a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 949 | <a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> </tt> |
| 950 | <a name="AssertionCredentials.__init__"></a><div id="AssertionCredentials.__init__-def"><a name="L702"></a><tt class="py-lineno"> 702</tt> <a class="py-toggle" href="#" id="AssertionCredentials.__init__-toggle" onclick="return toggle('AssertionCredentials.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AssertionCredentials-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">assertion_type</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">,</tt> </tt> |
| 951 | <a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-param">token_uri</tt><tt class="py-op">=</tt><tt class="py-string">'https://accounts.google.com/o/oauth2/token'</tt><tt class="py-op">,</tt> </tt> |
| 952 | <a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-op">**</tt><tt class="py-param">unused_kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 953 | </div><div id="AssertionCredentials.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AssertionCredentials.__init__-expanded"><a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for AssertionFlowCredentials.</tt> </tt> |
| 954 | <a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 955 | <a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 956 | <a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"><tt class="py-docstring"> assertion_type: string, assertion type that will be declared to the auth</tt> </tt> |
| 957 | <a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"><tt class="py-docstring"> server</tt> </tt> |
| 958 | <a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, The HTTP User-Agent to provide for this application.</tt> </tt> |
| 959 | <a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI for token endpoint. For convenience</tt> </tt> |
| 960 | <a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"><tt class="py-docstring"> defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt> </tt> |
| 961 | <a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 962 | <a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-90" class="py-name" targets="Class oauth2client.client.AssertionCredentials=oauth2client.client.AssertionCredentials-class.html"><a title="oauth2client.client.AssertionCredentials" class="py-name" href="#" onclick="return doclink('link-90', 'AssertionCredentials', 'link-90');">AssertionCredentials</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="apiclient.errors.BatchError.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 963 | apiclient.errors.HttpError.__init__ |
| 964 | apiclient.errors.UnexpectedBodyError.__init__ |
| 965 | apiclient.errors.UnexpectedMethodError.__init__ |
| 966 | apiclient.http.BatchHttpRequest.__init__ |
| 967 | apiclient.http.HttpMock.__init__ |
| 968 | apiclient.http.HttpMockSequence.__init__ |
| 969 | apiclient.http.HttpRequest.__init__ |
| 970 | apiclient.http.HttpRequestMock.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 971 | apiclient.http.MediaDownloadProgress.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 972 | apiclient.http.MediaFileUpload.__init__ |
| 973 | apiclient.http.MediaInMemoryUpload.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 974 | apiclient.http.MediaIoBaseDownload.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 975 | apiclient.http.MediaIoBaseUpload.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 976 | apiclient.http.MediaUploadProgress.__init__ |
| 977 | apiclient.http.RequestMockBuilder.__init__ |
| 978 | apiclient.model.JsonModel.__init__ |
| 979 | apiclient.model.ProtocolBufferModel.__init__ |
| 980 | apiclient.schema.Schemas.__init__ |
| 981 | apiclient.schema._SchemaToStruct.__init__ |
| 982 | oauth2client.appengine.AppAssertionCredentials.__init__ |
| 983 | oauth2client.appengine.OAuth2Decorator.__init__ |
| 984 | oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| 985 | oauth2client.appengine.StorageByKeyName.__init__ |
| 986 | oauth2client.client.AccessTokenCredentials.__init__ |
| 987 | oauth2client.client.AssertionCredentials.__init__ |
| 988 | oauth2client.client.MemoryCache.__init__ |
| 989 | oauth2client.client.OAuth2Credentials.__init__ |
| 990 | oauth2client.client.OAuth2WebServerFlow.__init__ |
| 991 | oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| 992 | oauth2client.crypt.Signer.__init__ |
| 993 | oauth2client.crypt.Verifier.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 994 | oauth2client.django_orm.CredentialsField.__init__ |
| 995 | oauth2client.django_orm.FlowField.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 996 | oauth2client.django_orm.Storage.__init__ |
| 997 | oauth2client.file.Storage.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 998 | oauth2client.keyring_storage.Storage.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 999 | oauth2client.locked_file.LockedFile.__init__ |
| 1000 | oauth2client.locked_file._Opener.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1001 | oauth2client.multistore_file._MultiStore._Storage.__init__ |
| 1002 | oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-91', '__init__', 'link-86');">__init__</a></tt><tt class="py-op">(</tt> </tt> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1003 | <a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1004 | <a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1005 | <a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1006 | <a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1007 | <a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1008 | <a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-name">token_uri</tt><tt class="py-op">,</tt> </tt> |
| 1009 | <a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-name">user_agent</tt><tt class="py-op">)</tt> </tt> |
| 1010 | <a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">assertion_type</tt> <tt class="py-op">=</tt> <tt class="py-name">assertion_type</tt> </tt> |
| 1011 | </div><a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> </tt> |
| 1012 | <a name="AssertionCredentials._generate_refresh_request_body"></a><div id="AssertionCredentials._generate_refresh_request_body-def"><a name="L724"></a><tt class="py-lineno"> 724</tt> <a class="py-toggle" href="#" id="AssertionCredentials._generate_refresh_request_body-toggle" onclick="return toggle('AssertionCredentials._generate_refresh_request_body');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body">_generate_refresh_request_body</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1013 | </div><div id="AssertionCredentials._generate_refresh_request_body-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AssertionCredentials._generate_refresh_request_body-expanded"><a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-name">assertion</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 oauth2client.client.AssertionCredentials._generate_assertion()=oauth2client.client.AssertionCredentials-class.html#_generate_assertion,Method oauth2client.client.SignedJwtAssertionCredentials._generate_assertion()=oauth2client.client.SignedJwtAssertionCredentials-class.html#_generate_assertion"><a title="oauth2client.client.AssertionCredentials._generate_assertion |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1014 | oauth2client.client.SignedJwtAssertionCredentials._generate_assertion" class="py-name" href="#" onclick="return doclink('link-92', '_generate_assertion', 'link-92');">_generate_assertion</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1015 | <a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> </tt> |
| 1016 | <a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt> </tt> |
| 1017 | <a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-string">'assertion_type'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">assertion_type</tt><tt class="py-op">,</tt> </tt> |
| 1018 | <a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-string">'assertion'</tt><tt class="py-op">:</tt> <tt class="py-name">assertion</tt><tt class="py-op">,</tt> </tt> |
| 1019 | <a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-string">'grant_type'</tt><tt class="py-op">:</tt> <tt class="py-string">'assertion'</tt><tt class="py-op">,</tt> </tt> |
| 1020 | <a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> <tt class="py-op">}</tt><tt class="py-op">)</tt> </tt> |
| 1021 | <a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> </tt> |
| 1022 | <a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">body</tt> </tt> |
| 1023 | </div><a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"> </tt> |
| 1024 | <a name="AssertionCredentials._generate_assertion"></a><div id="AssertionCredentials._generate_assertion-def"><a name="L735"></a><tt class="py-lineno"> 735</tt> <a class="py-toggle" href="#" id="AssertionCredentials._generate_assertion-toggle" onclick="return toggle('AssertionCredentials._generate_assertion');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.AssertionCredentials-class.html#_generate_assertion">_generate_assertion</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1025 | </div><div id="AssertionCredentials._generate_assertion-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="AssertionCredentials._generate_assertion-expanded"><a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-docstring">"""Generate the assertion string that will be used in the access token</tt> </tt> |
| 1026 | <a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"><tt class="py-docstring"> request.</tt> </tt> |
| 1027 | <a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1028 | <a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt id="link-93" class="py-name"><a title="apiclient.model._abstract |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1029 | oauth2client.client._abstract" class="py-name" href="#" onclick="return doclink('link-93', '_abstract', 'link-19');">_abstract</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1030 | </div></div><a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> </tt> |
| 1031 | <a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt id="link-94" class="py-name"><a title="oauth2client.client.HAS_OPENSSL" class="py-name" href="#" onclick="return doclink('link-94', 'HAS_OPENSSL', 'link-2');">HAS_OPENSSL</a></tt><tt class="py-op">:</tt> </tt> |
| 1032 | <a name="SignedJwtAssertionCredentials"></a><div id="SignedJwtAssertionCredentials-def"><a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-comment"># PyOpenSSL is not a prerequisite for oauth2client, so if it is missing then</tt> </tt> |
| 1033 | <a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-comment"># don't create the SignedJwtAssertionCredentials or the verify_id_token()</tt> </tt> |
| 1034 | <a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-comment"># method.</tt> </tt> |
| 1035 | <a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> </tt> |
| 1036 | <a name="L746"></a><tt class="py-lineno"> 746</tt> <a class="py-toggle" href="#" id="SignedJwtAssertionCredentials-toggle" onclick="return toggle('SignedJwtAssertionCredentials');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.SignedJwtAssertionCredentials-class.html">SignedJwtAssertionCredentials</a><tt class="py-op">(</tt><tt class="py-base-class">AssertionCredentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1037 | </div><div id="SignedJwtAssertionCredentials-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="SignedJwtAssertionCredentials-expanded"><a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-docstring">"""Credentials object used for OAuth 2.0 Signed JWT assertion grants.</tt> </tt> |
| 1038 | <a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1039 | <a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> This credential does not require a flow to instantiate because it represents</tt> </tt> |
| 1040 | <a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-docstring"> a two legged flow, and therefore has all of the required information to</tt> </tt> |
| 1041 | <a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-docstring"> generate and refresh its own access tokens.</tt> </tt> |
| 1042 | <a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1043 | <a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"><tt class="py-docstring"> SignedJwtAssertionCredentials requires PyOpenSSL and because of that it does</tt> </tt> |
| 1044 | <a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"><tt class="py-docstring"> not work on App Engine. For App Engine you may consider using</tt> </tt> |
| 1045 | <a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"><tt class="py-docstring"> AppAssertionCredentials.</tt> </tt> |
| 1046 | <a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1047 | <a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> </tt> |
| 1048 | <a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt id="link-95" class="py-name" targets="Variable oauth2client.client.SignedJwtAssertionCredentials.MAX_TOKEN_LIFETIME_SECS=oauth2client.client.SignedJwtAssertionCredentials-class.html#MAX_TOKEN_LIFETIME_SECS,Variable oauth2client.crypt.MAX_TOKEN_LIFETIME_SECS=oauth2client.crypt-module.html#MAX_TOKEN_LIFETIME_SECS"><a title="oauth2client.client.SignedJwtAssertionCredentials.MAX_TOKEN_LIFETIME_SECS |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1049 | oauth2client.crypt.MAX_TOKEN_LIFETIME_SECS" class="py-name" href="#" onclick="return doclink('link-95', 'MAX_TOKEN_LIFETIME_SECS', 'link-95');">MAX_TOKEN_LIFETIME_SECS</a></tt> <tt class="py-op">=</tt> <tt class="py-number">3600</tt> <tt class="py-comment"># 1 hour in seconds</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1050 | <a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> </tt> |
| 1051 | <a name="SignedJwtAssertionCredentials.__init__"></a><div id="SignedJwtAssertionCredentials.__init__-def"><a name="L760"></a><tt class="py-lineno"> 760</tt> <a class="py-toggle" href="#" id="SignedJwtAssertionCredentials.__init__-toggle" onclick="return toggle('SignedJwtAssertionCredentials.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.SignedJwtAssertionCredentials-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> </tt> |
| 1052 | <a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-param">service_account_name</tt><tt class="py-op">,</tt> </tt> |
| 1053 | <a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-param">private_key</tt><tt class="py-op">,</tt> </tt> |
| 1054 | <a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-param">scope</tt><tt class="py-op">,</tt> </tt> |
| 1055 | <a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-param">private_key_password</tt><tt class="py-op">=</tt><tt class="py-string">'notasecret'</tt><tt class="py-op">,</tt> </tt> |
| 1056 | <a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-param">user_agent</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1057 | <a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-param">token_uri</tt><tt class="py-op">=</tt><tt class="py-string">'https://accounts.google.com/o/oauth2/token'</tt><tt class="py-op">,</tt> </tt> |
| 1058 | <a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1059 | </div><div id="SignedJwtAssertionCredentials.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++++"></div><div id="SignedJwtAssertionCredentials.__init__-expanded"><a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for SignedJwtAssertionCredentials.</tt> </tt> |
| 1060 | <a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1061 | <a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1062 | <a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"><tt class="py-docstring"> service_account_name: string, id for account, usually an email address.</tt> </tt> |
| 1063 | <a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"><tt class="py-docstring"> private_key: string, private key in P12 format.</tt> </tt> |
| 1064 | <a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) of the credentials being</tt> </tt> |
| 1065 | <a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 1066 | <a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-docstring"> private_key_password: string, password for private_key.</tt> </tt> |
| 1067 | <a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, HTTP User-Agent to provide for this application.</tt> </tt> |
| 1068 | <a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI for token endpoint. For convenience</tt> </tt> |
| 1069 | <a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"><tt class="py-docstring"> defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt> </tt> |
| 1070 | <a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"><tt class="py-docstring"> kwargs: kwargs, Additional parameters to add to the JWT token, for</tt> </tt> |
| 1071 | <a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"><tt class="py-docstring"> example prn=joe@xample.org."""</tt> </tt> |
| 1072 | <a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> </tt> |
| 1073 | <a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-96" class="py-name" targets="Class oauth2client.client.SignedJwtAssertionCredentials=oauth2client.client.SignedJwtAssertionCredentials-class.html"><a title="oauth2client.client.SignedJwtAssertionCredentials" class="py-name" href="#" onclick="return doclink('link-96', 'SignedJwtAssertionCredentials', 'link-96');">SignedJwtAssertionCredentials</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="apiclient.errors.BatchError.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1074 | apiclient.errors.HttpError.__init__ |
| 1075 | apiclient.errors.UnexpectedBodyError.__init__ |
| 1076 | apiclient.errors.UnexpectedMethodError.__init__ |
| 1077 | apiclient.http.BatchHttpRequest.__init__ |
| 1078 | apiclient.http.HttpMock.__init__ |
| 1079 | apiclient.http.HttpMockSequence.__init__ |
| 1080 | apiclient.http.HttpRequest.__init__ |
| 1081 | apiclient.http.HttpRequestMock.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1082 | apiclient.http.MediaDownloadProgress.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1083 | apiclient.http.MediaFileUpload.__init__ |
| 1084 | apiclient.http.MediaInMemoryUpload.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1085 | apiclient.http.MediaIoBaseDownload.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1086 | apiclient.http.MediaIoBaseUpload.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1087 | apiclient.http.MediaUploadProgress.__init__ |
| 1088 | apiclient.http.RequestMockBuilder.__init__ |
| 1089 | apiclient.model.JsonModel.__init__ |
| 1090 | apiclient.model.ProtocolBufferModel.__init__ |
| 1091 | apiclient.schema.Schemas.__init__ |
| 1092 | apiclient.schema._SchemaToStruct.__init__ |
| 1093 | oauth2client.appengine.AppAssertionCredentials.__init__ |
| 1094 | oauth2client.appengine.OAuth2Decorator.__init__ |
| 1095 | oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| 1096 | oauth2client.appengine.StorageByKeyName.__init__ |
| 1097 | oauth2client.client.AccessTokenCredentials.__init__ |
| 1098 | oauth2client.client.AssertionCredentials.__init__ |
| 1099 | oauth2client.client.MemoryCache.__init__ |
| 1100 | oauth2client.client.OAuth2Credentials.__init__ |
| 1101 | oauth2client.client.OAuth2WebServerFlow.__init__ |
| 1102 | oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| 1103 | oauth2client.crypt.Signer.__init__ |
| 1104 | oauth2client.crypt.Verifier.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1105 | oauth2client.django_orm.CredentialsField.__init__ |
| 1106 | oauth2client.django_orm.FlowField.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1107 | oauth2client.django_orm.Storage.__init__ |
| 1108 | oauth2client.file.Storage.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1109 | oauth2client.keyring_storage.Storage.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1110 | oauth2client.locked_file.LockedFile.__init__ |
| 1111 | oauth2client.locked_file._Opener.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1112 | oauth2client.multistore_file._MultiStore._Storage.__init__ |
| 1113 | oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-97', '__init__', 'link-86');">__init__</a></tt><tt class="py-op">(</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1114 | <a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> <tt class="py-string">'http://oauth.net/grant_type/jwt/1.0/bearer'</tt><tt class="py-op">,</tt> </tt> |
| 1115 | <a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-name">user_agent</tt><tt class="py-op">,</tt> </tt> |
| 1116 | <a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-name">token_uri</tt><tt class="py-op">=</tt><tt class="py-name">token_uri</tt><tt class="py-op">,</tt> </tt> |
| 1117 | <a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt> |
| 1118 | <a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> </tt> |
| 1119 | <a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">list</tt><tt class="py-op">:</tt> </tt> |
| 1120 | <a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> </tt> |
| 1121 | <a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-name">scope</tt> </tt> |
| 1122 | <a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> </tt> |
| 1123 | <a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-comment"># Keep base64 encoded so it can be stored in JSON.</tt> </tt> |
| 1124 | <a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">private_key</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">private_key</tt><tt class="py-op">)</tt> </tt> |
| 1125 | <a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> </tt> |
| 1126 | <a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">private_key_password</tt> <tt class="py-op">=</tt> <tt class="py-name">private_key_password</tt> </tt> |
| 1127 | <a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">service_account_name</tt> <tt class="py-op">=</tt> <tt class="py-name">service_account_name</tt> </tt> |
| 1128 | <a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">kwargs</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt> </tt> |
| 1129 | </div><a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> </tt> |
| 1130 | <a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 1131 | <a name="SignedJwtAssertionCredentials.from_json"></a><div id="SignedJwtAssertionCredentials.from_json-def"><a name="L800"></a><tt class="py-lineno"> 800</tt> <a class="py-toggle" href="#" id="SignedJwtAssertionCredentials.from_json-toggle" onclick="return toggle('SignedJwtAssertionCredentials.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.SignedJwtAssertionCredentials-class.html#from_json">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> |
| 1132 | </div><div id="SignedJwtAssertionCredentials.from_json-collapsed" style="display:none;" pad="++++" indent="++++++++++"></div><div id="SignedJwtAssertionCredentials.from_json-expanded"><a name="L801"></a><tt class="py-lineno"> 801</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-98" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-98', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt> |
| 1133 | <a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-name">retval</tt> <tt class="py-op">=</tt> <tt id="link-99" class="py-name"><a title="oauth2client.client.SignedJwtAssertionCredentials" class="py-name" href="#" onclick="return doclink('link-99', 'SignedJwtAssertionCredentials', 'link-96');">SignedJwtAssertionCredentials</a></tt><tt class="py-op">(</tt> </tt> |
| 1134 | <a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'service_account_name'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1135 | <a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <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">data</tt><tt class="py-op">[</tt><tt class="py-string">'private_key'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 1136 | <a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'scope'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1137 | <a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-name">private_key_password</tt><tt class="py-op">=</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'private_key_password'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1138 | <a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">user_agent</tt><tt class="py-op">=</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'user_agent'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1139 | <a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-name">token_uri</tt><tt class="py-op">=</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'token_uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1140 | <a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-op">**</tt><tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'kwargs'</tt><tt class="py-op">]</tt> </tt> |
| 1141 | <a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt> |
| 1142 | <a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-name">retval</tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'invalid'</tt><tt class="py-op">]</tt> </tt> |
| 1143 | <a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> <tt class="py-name">retval</tt><tt class="py-op">.</tt><tt class="py-name">access_token</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt><tt class="py-op">[</tt><tt class="py-string">'access_token'</tt><tt class="py-op">]</tt> </tt> |
| 1144 | <a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">retval</tt> </tt> |
| 1145 | </div><a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> </tt> |
| 1146 | <a name="SignedJwtAssertionCredentials._generate_assertion"></a><div id="SignedJwtAssertionCredentials._generate_assertion-def"><a name="L815"></a><tt class="py-lineno"> 815</tt> <a class="py-toggle" href="#" id="SignedJwtAssertionCredentials._generate_assertion-toggle" onclick="return toggle('SignedJwtAssertionCredentials._generate_assertion');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.SignedJwtAssertionCredentials-class.html#_generate_assertion">_generate_assertion</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1147 | </div><div id="SignedJwtAssertionCredentials._generate_assertion-collapsed" style="display:none;" pad="++++" indent="++++++++++"></div><div id="SignedJwtAssertionCredentials._generate_assertion-expanded"><a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"> <tt class="py-docstring">"""Generate the assertion that will be used in the request."""</tt> </tt> |
| 1148 | <a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> <tt class="py-name">now</tt> <tt class="py-op">=</tt> <tt class="py-name">long</tt><tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1149 | <a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-name">payload</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 1150 | <a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"> <tt class="py-string">'aud'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt><tt class="py-op">,</tt> </tt> |
| 1151 | <a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-string">'scope'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt> |
| 1152 | <a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-string">'iat'</tt><tt class="py-op">:</tt> <tt class="py-name">now</tt><tt class="py-op">,</tt> </tt> |
| 1153 | <a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> <tt class="py-string">'exp'</tt><tt class="py-op">:</tt> <tt class="py-name">now</tt> <tt class="py-op">+</tt> <tt id="link-100" class="py-name"><a title="oauth2client.client.SignedJwtAssertionCredentials" class="py-name" href="#" onclick="return doclink('link-100', 'SignedJwtAssertionCredentials', 'link-96');">SignedJwtAssertionCredentials</a></tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="oauth2client.client.SignedJwtAssertionCredentials.MAX_TOKEN_LIFETIME_SECS |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1154 | oauth2client.crypt.MAX_TOKEN_LIFETIME_SECS" class="py-name" href="#" onclick="return doclink('link-101', 'MAX_TOKEN_LIFETIME_SECS', 'link-95');">MAX_TOKEN_LIFETIME_SECS</a></tt><tt class="py-op">,</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1155 | <a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-string">'iss'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">service_account_name</tt> </tt> |
| 1156 | <a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 1157 | <a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-name">payload</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt> |
| 1158 | <a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt id="link-102" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1159 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1160 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1161 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1162 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1163 | oauth2client.multistore_file.logger |
| 1164 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-102', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">payload</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1165 | <a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> </tt> |
| 1166 | <a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-name">private_key</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">self</tt><tt class="py-op">.</tt><tt class="py-name">private_key</tt><tt class="py-op">)</tt> </tt> |
| 1167 | <a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-103" class="py-name"><a title="oauth2client.crypt.make_signed_jwt" class="py-name" href="#" onclick="return doclink('link-103', 'make_signed_jwt', 'link-8');">make_signed_jwt</a></tt><tt class="py-op">(</tt> </tt> |
| 1168 | <a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt id="link-104" class="py-name"><a title="oauth2client.crypt.Signer" class="py-name" href="#" onclick="return doclink('link-104', 'Signer', 'link-5');">Signer</a></tt><tt class="py-op">.</tt><tt id="link-105" class="py-name" targets="Static Method oauth2client.crypt.Signer.from_string()=oauth2client.crypt.Signer-class.html#from_string,Static Method oauth2client.crypt.Verifier.from_string()=oauth2client.crypt.Verifier-class.html#from_string"><a title="oauth2client.crypt.Signer.from_string |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1169 | oauth2client.crypt.Verifier.from_string" class="py-name" href="#" onclick="return doclink('link-105', 'from_string', 'link-105');">from_string</a></tt><tt class="py-op">(</tt><tt class="py-name">private_key</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">private_key_password</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">payload</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1170 | </div></div><a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> </tt> |
| 1171 | <a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt class="py-comment"># Only used in verify_id_token(), which is always calling to the same URI</tt> </tt> |
| 1172 | <a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-comment"># for the certs.</tt> </tt> |
| 1173 | <a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> <tt id="link-106" class="py-name" targets="Variable oauth2client.client._cached_http=oauth2client.client-module.html#_cached_http"><a title="oauth2client.client._cached_http" class="py-name" href="#" onclick="return doclink('link-106', '_cached_http', 'link-106');">_cached_http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt id="link-107" class="py-name" targets="Class oauth2client.client.MemoryCache=oauth2client.client.MemoryCache-class.html"><a title="oauth2client.client.MemoryCache" class="py-name" href="#" onclick="return doclink('link-107', 'MemoryCache', 'link-107');">MemoryCache</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1174 | <a name="verify_id_token"></a><div id="verify_id_token-def"><a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> </tt> |
| 1175 | <a name="L836"></a><tt class="py-lineno"> 836</tt> <a class="py-toggle" href="#" id="verify_id_token-toggle" onclick="return toggle('verify_id_token');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#verify_id_token">verify_id_token</a><tt class="py-op">(</tt><tt class="py-param">id_token</tt><tt class="py-op">,</tt> <tt class="py-param">audience</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> |
| 1176 | <a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-param">cert_uri</tt><tt class="py-op">=</tt><tt id="link-108" class="py-name"><a title="oauth2client.client.ID_TOKEN_VERIFICATON_CERTS" class="py-name" href="#" onclick="return doclink('link-108', 'ID_TOKEN_VERIFICATON_CERTS', 'link-15');">ID_TOKEN_VERIFICATON_CERTS</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1177 | </div><div id="verify_id_token-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="verify_id_token-expanded"><a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-docstring">"""Verifies a signed JWT id_token.</tt> </tt> |
| 1178 | <a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1179 | <a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-docstring"> This function requires PyOpenSSL and because of that it does not work on</tt> </tt> |
| 1180 | <a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"><tt class="py-docstring"> App Engine. For App Engine you may consider using AppAssertionCredentials.</tt> </tt> |
| 1181 | <a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1182 | <a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1183 | <a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"><tt class="py-docstring"> id_token: string, A Signed JWT.</tt> </tt> |
| 1184 | <a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"><tt class="py-docstring"> audience: string, The audience 'aud' that the token should be for.</tt> </tt> |
| 1185 | <a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, instance to use to make the HTTP request. Callers</tt> </tt> |
| 1186 | <a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"><tt class="py-docstring"> should supply an instance that has caching enabled.</tt> </tt> |
| 1187 | <a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-docstring"> cert_uri: string, URI of the certificates in JSON format to</tt> </tt> |
| 1188 | <a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-docstring"> verify the JWT against.</tt> </tt> |
| 1189 | <a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1190 | <a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1191 | <a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-docstring"> The deserialized JSON in the JWT.</tt> </tt> |
| 1192 | <a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1193 | <a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1194 | <a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.crypt.AppIdentityError if the JWT fails to verify.</tt> </tt> |
| 1195 | <a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1196 | <a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-109" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1197 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-109', 'http', 'link-43');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1198 | <a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"> <tt id="link-110" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1199 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-110', 'http', 'link-43');">http</a></tt> <tt class="py-op">=</tt> <tt id="link-111" class="py-name"><a title="oauth2client.client._cached_http" class="py-name" href="#" onclick="return doclink('link-111', '_cached_http', 'link-106');">_cached_http</a></tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1200 | <a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> </tt> |
| 1201 | <a name="L860"></a><tt class="py-lineno"> 860</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-112" class="py-name"><a title="apiclient.http |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1202 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-112', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="apiclient.http.HttpMock.request |
| 1203 | apiclient.http.HttpMockSequence.request |
| 1204 | apiclient.model.BaseModel.request |
| 1205 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-113', 'request', 'link-44');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">cert_uri</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1206 | <a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> </tt> |
| 1207 | <a name="L862"></a><tt class="py-lineno"> 862</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-op">:</tt> </tt> |
| 1208 | <a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-name">certs</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-114', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1209 | <a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-115" class="py-name"><a title="oauth2client.crypt.verify_signed_jwt_with_certs" class="py-name" href="#" onclick="return doclink('link-115', 'verify_signed_jwt_with_certs', 'link-11');">verify_signed_jwt_with_certs</a></tt><tt class="py-op">(</tt><tt class="py-name">id_token</tt><tt class="py-op">,</tt> <tt class="py-name">certs</tt><tt class="py-op">,</tt> <tt class="py-name">audience</tt><tt class="py-op">)</tt> </tt> |
| 1210 | <a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1211 | <a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-116" class="py-name" targets="Class oauth2client.client.VerifyJwtTokenError=oauth2client.client.VerifyJwtTokenError-class.html"><a title="oauth2client.client.VerifyJwtTokenError" class="py-name" href="#" onclick="return doclink('link-116', 'VerifyJwtTokenError', 'link-116');">VerifyJwtTokenError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Status code: %d'</tt> <tt class="py-op">%</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">)</tt> </tt> |
| 1212 | </div><a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> </tt> |
| 1213 | <a name="_urlsafe_b64decode"></a><div id="_urlsafe_b64decode-def"><a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> </tt> |
| 1214 | <a name="L869"></a><tt class="py-lineno"> 869</tt> <a class="py-toggle" href="#" id="_urlsafe_b64decode-toggle" onclick="return toggle('_urlsafe_b64decode');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#_urlsafe_b64decode">_urlsafe_b64decode</a><tt class="py-op">(</tt><tt class="py-param">b64string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1215 | </div><div id="_urlsafe_b64decode-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_urlsafe_b64decode-expanded"><a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-comment"># Guard against unicode strings, which base64 can't handle.</tt> </tt> |
| 1216 | <a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-name">b64string</tt> <tt class="py-op">=</tt> <tt class="py-name">b64string</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'ascii'</tt><tt class="py-op">)</tt> </tt> |
| 1217 | <a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-name">padded</tt> <tt class="py-op">=</tt> <tt class="py-name">b64string</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">4</tt> <tt class="py-op">-</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">b64string</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-number">4</tt><tt class="py-op">)</tt> </tt> |
| 1218 | <a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">base64</tt><tt class="py-op">.</tt><tt class="py-name">urlsafe_b64decode</tt><tt class="py-op">(</tt><tt class="py-name">padded</tt><tt class="py-op">)</tt> </tt> |
| 1219 | </div><a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> </tt> |
| 1220 | <a name="_extract_id_token"></a><div id="_extract_id_token-def"><a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> </tt> |
| 1221 | <a name="L876"></a><tt class="py-lineno"> 876</tt> <a class="py-toggle" href="#" id="_extract_id_token-toggle" onclick="return toggle('_extract_id_token');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#_extract_id_token">_extract_id_token</a><tt class="py-op">(</tt><tt class="py-param">id_token</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1222 | </div><div id="_extract_id_token-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_extract_id_token-expanded"><a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-docstring">"""Extract the JSON payload from a JWT.</tt> </tt> |
| 1223 | <a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1224 | <a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> Does the extraction w/o checking the signature.</tt> </tt> |
| 1225 | <a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1226 | <a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1227 | <a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"><tt class="py-docstring"> id_token: string, OAuth 2.0 id_token.</tt> </tt> |
| 1228 | <a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1229 | <a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1230 | <a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"><tt class="py-docstring"> object, The deserialized JSON payload.</tt> </tt> |
| 1231 | <a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1232 | <a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-name">segments</tt> <tt class="py-op">=</tt> <tt class="py-name">id_token</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> |
| 1233 | <a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> </tt> |
| 1234 | <a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">segments</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">3</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1235 | <a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-117" class="py-name"><a title="oauth2client.client.VerifyJwtTokenError" class="py-name" href="#" onclick="return doclink('link-117', 'VerifyJwtTokenError', 'link-116');">VerifyJwtTokenError</a></tt><tt class="py-op">(</tt> </tt> |
| 1236 | <a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-string">'Wrong number of segments in token: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">id_token</tt><tt class="py-op">)</tt> </tt> |
| 1237 | <a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> </tt> |
| 1238 | <a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-118', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt id="link-119" class="py-name" targets="Function oauth2client.client._urlsafe_b64decode()=oauth2client.client-module.html#_urlsafe_b64decode,Function oauth2client.crypt._urlsafe_b64decode()=oauth2client.crypt-module.html#_urlsafe_b64decode"><a title="oauth2client.client._urlsafe_b64decode |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1239 | oauth2client.crypt._urlsafe_b64decode" class="py-name" href="#" onclick="return doclink('link-119', '_urlsafe_b64decode', 'link-119');">_urlsafe_b64decode</a></tt><tt class="py-op">(</tt><tt class="py-name">segments</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> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1240 | </div><a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> </tt> |
| 1241 | <a name="_parse_exchange_token_response"></a><div id="_parse_exchange_token_response-def"><a name="L895"></a><tt class="py-lineno"> 895</tt> <a class="py-toggle" href="#" id="_parse_exchange_token_response-toggle" onclick="return toggle('_parse_exchange_token_response');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#_parse_exchange_token_response">_parse_exchange_token_response</a><tt class="py-op">(</tt><tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1242 | </div><div id="_parse_exchange_token_response-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_parse_exchange_token_response-expanded"><a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-docstring">"""Parses response of an exchange token request.</tt> </tt> |
| 1243 | <a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1244 | <a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"><tt class="py-docstring"> Most providers return JSON but some (e.g. Facebook) return a</tt> </tt> |
| 1245 | <a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-docstring"> url-encoded string.</tt> </tt> |
| 1246 | <a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1247 | <a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1248 | <a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"><tt class="py-docstring"> content: The body of a response</tt> </tt> |
| 1249 | <a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1250 | <a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1251 | <a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"><tt class="py-docstring"> Content as a dictionary object. Note that the dict could be empty,</tt> </tt> |
| 1252 | <a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-docstring"> i.e. {}. That basically indicates a failure.</tt> </tt> |
| 1253 | <a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1254 | <a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt> |
| 1255 | <a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 1256 | <a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-120', 'loads', 'link-26');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1257 | <a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">StandardError</tt><tt class="py-op">:</tt> </tt> |
| 1258 | <a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-comment"># different JSON libs raise different exceptions,</tt> </tt> |
| 1259 | <a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-comment"># so we just do a catch-all here</tt> </tt> |
| 1260 | <a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">resp</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">parse_qsl</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1261 | <a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> </tt> |
| 1262 | <a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-comment"># some providers respond with 'expires', others with 'expires_in'</tt> </tt> |
| 1263 | <a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">resp</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'expires'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">:</tt> </tt> |
| 1264 | <a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">[</tt><tt class="py-string">'expires_in'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-string">'expires'</tt><tt class="py-op">)</tt> </tt> |
| 1265 | <a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> </tt> |
| 1266 | <a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt> </tt> |
| 1267 | </div><a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"> </tt> |
| 1268 | <a name="credentials_from_code"></a><div id="credentials_from_code-def"><a name="L922"></a><tt class="py-lineno"> 922</tt> <a class="py-toggle" href="#" id="credentials_from_code-toggle" onclick="return toggle('credentials_from_code');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#credentials_from_code">credentials_from_code</a><tt class="py-op">(</tt><tt class="py-param">client_id</tt><tt class="py-op">,</tt> <tt class="py-param">client_secret</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">code</tt><tt class="py-op">,</tt> </tt> |
| 1269 | <a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"> <tt class="py-param">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-string">'postmessage'</tt><tt class="py-op">,</tt> </tt> |
| 1270 | <a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> <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-param">user_agent</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1271 | <a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"> <tt class="py-param">token_uri</tt><tt class="py-op">=</tt><tt class="py-string">'https://accounts.google.com/o/oauth2/token'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1272 | </div><div id="credentials_from_code-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="credentials_from_code-expanded"><a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-docstring">"""Exchanges an authorization code for an OAuth2Credentials object.</tt> </tt> |
| 1273 | <a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1274 | <a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1275 | <a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-docstring"> client_id: string, client identifier.</tt> </tt> |
| 1276 | <a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> client_secret: string, client secret.</tt> </tt> |
| 1277 | <a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) to request.</tt> </tt> |
| 1278 | <a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"><tt class="py-docstring"> code: string, An authroization code, most likely passed down from</tt> </tt> |
| 1279 | <a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"><tt class="py-docstring"> the client</tt> </tt> |
| 1280 | <a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"><tt class="py-docstring"> redirect_uri: string, this is generally set to 'postmessage' to match the</tt> </tt> |
| 1281 | <a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"><tt class="py-docstring"> redirect_uri that the client specified</tt> </tt> |
| 1282 | <a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, optional http instance to use to do the fetch</tt> </tt> |
| 1283 | <a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI for token endpoint. For convenience</tt> </tt> |
| 1284 | <a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"><tt class="py-docstring"> defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt> </tt> |
| 1285 | <a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1286 | <a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"><tt class="py-docstring"> An OAuth2Credentials object.</tt> </tt> |
| 1287 | <a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1288 | <a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1289 | <a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"> FlowExchangeError if the authorization code cannot be exchanged for an</tt> </tt> |
| 1290 | <a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-docstring"> access token</tt> </tt> |
| 1291 | <a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1292 | <a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt class="py-name">flow</tt> <tt class="py-op">=</tt> <tt id="link-121" class="py-name" targets="Class oauth2client.client.OAuth2WebServerFlow=oauth2client.client.OAuth2WebServerFlow-class.html"><a title="oauth2client.client.OAuth2WebServerFlow" class="py-name" href="#" onclick="return doclink('link-121', 'OAuth2WebServerFlow', 'link-121');">OAuth2WebServerFlow</a></tt><tt class="py-op">(</tt><tt class="py-name">client_id</tt><tt class="py-op">,</tt> <tt class="py-name">client_secret</tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">user_agent</tt><tt class="py-op">,</tt> </tt> |
| 1293 | <a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> <tt class="py-string">'https://accounts.google.com/o/oauth2/auth'</tt><tt class="py-op">,</tt> </tt> |
| 1294 | <a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"> <tt class="py-name">token_uri</tt><tt class="py-op">)</tt> </tt> |
| 1295 | <a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"> </tt> |
| 1296 | <a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"> <tt class="py-comment"># We primarily make this call to set up the redirect_uri in the flow object</tt> </tt> |
| 1297 | <a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-name">uriThatWeDontReallyUse</tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name" targets="Method oauth2client.client.OAuth2WebServerFlow.step1_get_authorize_url()=oauth2client.client.OAuth2WebServerFlow-class.html#step1_get_authorize_url"><a title="oauth2client.client.OAuth2WebServerFlow.step1_get_authorize_url" class="py-name" href="#" onclick="return doclink('link-122', 'step1_get_authorize_url', 'link-122');">step1_get_authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-name">redirect_uri</tt><tt class="py-op">)</tt> </tt> |
| 1298 | <a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"> <tt id="link-123" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-123', 'credentials', 'link-38');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name" targets="Method oauth2client.client.OAuth2WebServerFlow.step2_exchange()=oauth2client.client.OAuth2WebServerFlow-class.html#step2_exchange"><a title="oauth2client.client.OAuth2WebServerFlow.step2_exchange" class="py-name" href="#" onclick="return doclink('link-124', 'step2_exchange', 'link-124');">step2_exchange</a></tt><tt class="py-op">(</tt><tt class="py-name">code</tt><tt class="py-op">,</tt> <tt id="link-125" class="py-name"><a title="apiclient.http |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1299 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-125', 'http', 'link-43');">http</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1300 | <a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-126" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-126', 'credentials', 'link-38');">credentials</a></tt> </tt> |
| 1301 | </div><a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> </tt> |
| 1302 | <a name="credentials_from_clientsecrets_and_code"></a><div id="credentials_from_clientsecrets_and_code-def"><a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> </tt> |
| 1303 | <a name="L956"></a><tt class="py-lineno"> 956</tt> <a class="py-toggle" href="#" id="credentials_from_clientsecrets_and_code-toggle" onclick="return toggle('credentials_from_clientsecrets_and_code');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#credentials_from_clientsecrets_and_code">credentials_from_clientsecrets_and_code</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">code</tt><tt class="py-op">,</tt> </tt> |
| 1304 | <a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-param">message</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1305 | <a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-param">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-string">'postmessage'</tt><tt class="py-op">,</tt> </tt> |
| 1306 | <a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1307 | <a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1308 | </div><div id="credentials_from_clientsecrets_and_code-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="credentials_from_clientsecrets_and_code-expanded"><a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns OAuth2Credentials from a clientsecrets file and an auth code.</tt> </tt> |
| 1309 | <a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1310 | <a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> Will create the right kind of Flow based on the contents of the clientsecrets</tt> </tt> |
| 1311 | <a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> file or will raise InvalidClientSecretsError for unknown types of Flows.</tt> </tt> |
| 1312 | <a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1313 | <a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1314 | <a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, File name of clientsecrets.</tt> </tt> |
| 1315 | <a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) to request.</tt> </tt> |
| 1316 | <a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> code: string, An authroization code, most likely passed down from</tt> </tt> |
| 1317 | <a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> the client</tt> </tt> |
| 1318 | <a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> message: string, A friendly string to display to the user if the</tt> </tt> |
| 1319 | <a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets file is missing or invalid. If message is provided then</tt> </tt> |
| 1320 | <a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> sys.exit will be called in the case of an error. If message in not</tt> </tt> |
| 1321 | <a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> provided then clientsecrets.InvalidClientSecretsError will be raised.</tt> </tt> |
| 1322 | <a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-docstring"> redirect_uri: string, this is generally set to 'postmessage' to match the</tt> </tt> |
| 1323 | <a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-docstring"> redirect_uri that the client specified</tt> </tt> |
| 1324 | <a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, optional http instance to use to do the fetch</tt> </tt> |
| 1325 | <a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"><tt class="py-docstring"> cache: An optional cache service client that implements get() and set() </tt> </tt> |
| 1326 | <a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"><tt class="py-docstring"> methods. See clientsecrets.loadfile() for details.</tt> </tt> |
| 1327 | <a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1328 | <a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1329 | <a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"><tt class="py-docstring"> An OAuth2Credentials object.</tt> </tt> |
| 1330 | <a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1331 | <a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1332 | <a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"><tt class="py-docstring"> FlowExchangeError if the authorization code cannot be exchanged for an</tt> </tt> |
| 1333 | <a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"><tt class="py-docstring"> access token</tt> </tt> |
| 1334 | <a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"><tt class="py-docstring"> UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.</tt> </tt> |
| 1335 | <a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets.InvalidClientSecretsError if the clientsecrets file is</tt> </tt> |
| 1336 | <a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"><tt class="py-docstring"> invalid.</tt> </tt> |
| 1337 | <a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1338 | <a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-name">flow</tt> <tt class="py-op">=</tt> <tt id="link-127" class="py-name" targets="Function oauth2client.client.flow_from_clientsecrets()=oauth2client.client-module.html#flow_from_clientsecrets"><a title="oauth2client.client.flow_from_clientsecrets" class="py-name" href="#" onclick="return doclink('link-127', 'flow_from_clientsecrets', 'link-127');">flow_from_clientsecrets</a></tt><tt class="py-op">(</tt><tt id="link-128" 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 |
| 1339 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-128', 'filename', 'link-128');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">=</tt><tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-name">cache</tt><tt class="py-op">=</tt><tt class="py-name">cache</tt><tt class="py-op">)</tt> </tt> |
| 1340 | <a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-comment"># We primarily make this call to set up the redirect_uri in the flow object</tt> </tt> |
| 1341 | <a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-name">uriThatWeDontReallyUse</tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="oauth2client.client.OAuth2WebServerFlow.step1_get_authorize_url" class="py-name" href="#" onclick="return doclink('link-129', 'step1_get_authorize_url', 'link-122');">step1_get_authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-name">redirect_uri</tt><tt class="py-op">)</tt> </tt> |
| 1342 | <a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt id="link-130" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-130', 'credentials', 'link-38');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="oauth2client.client.OAuth2WebServerFlow.step2_exchange" class="py-name" href="#" onclick="return doclink('link-131', 'step2_exchange', 'link-124');">step2_exchange</a></tt><tt class="py-op">(</tt><tt class="py-name">code</tt><tt class="py-op">,</tt> <tt id="link-132" class="py-name"><a title="apiclient.http |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1343 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-132', 'http', 'link-43');">http</a></tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1344 | <a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-133" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="return doclink('link-133', 'credentials', 'link-38');">credentials</a></tt> </tt> |
| 1345 | </div><a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> </tt> |
| 1346 | <a name="OAuth2WebServerFlow"></a><div id="OAuth2WebServerFlow-def"><a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> </tt> |
| 1347 | <a name="L998"></a><tt class="py-lineno"> 998</tt> <a class="py-toggle" href="#" id="OAuth2WebServerFlow-toggle" onclick="return toggle('OAuth2WebServerFlow');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.client.OAuth2WebServerFlow-class.html">OAuth2WebServerFlow</a><tt class="py-op">(</tt><tt class="py-base-class">Flow</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1348 | </div><div id="OAuth2WebServerFlow-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="OAuth2WebServerFlow-expanded"><a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-docstring">"""Does the Web Server Flow for OAuth 2.0.</tt> </tt> |
| 1349 | <a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1350 | <a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-docstring"> OAuth2Credentials objects may be safely pickled and unpickled.</tt> </tt> |
| 1351 | <a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1352 | <a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> </tt> |
| 1353 | <a name="OAuth2WebServerFlow.__init__"></a><div id="OAuth2WebServerFlow.__init__-def"><a name="L1004"></a><tt class="py-lineno">1004</tt> <a class="py-toggle" href="#" id="OAuth2WebServerFlow.__init__-toggle" onclick="return toggle('OAuth2WebServerFlow.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2WebServerFlow-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">client_id</tt><tt class="py-op">,</tt> <tt class="py-param">client_secret</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 1354 | <a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-param">auth_uri</tt><tt class="py-op">=</tt><tt class="py-string">'https://accounts.google.com/o/oauth2/auth'</tt><tt class="py-op">,</tt> </tt> |
| 1355 | <a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-param">token_uri</tt><tt class="py-op">=</tt><tt class="py-string">'https://accounts.google.com/o/oauth2/token'</tt><tt class="py-op">,</tt> </tt> |
| 1356 | <a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1357 | </div><div id="OAuth2WebServerFlow.__init__-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2WebServerFlow.__init__-expanded"><a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for OAuth2WebServerFlow.</tt> </tt> |
| 1358 | <a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1359 | <a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1360 | <a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"><tt class="py-docstring"> client_id: string, client identifier.</tt> </tt> |
| 1361 | <a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-docstring"> client_secret: string client secret.</tt> </tt> |
| 1362 | <a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) of the credentials being</tt> </tt> |
| 1363 | <a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 1364 | <a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, HTTP User-Agent to provide for this application.</tt> </tt> |
| 1365 | <a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-docstring"> auth_uri: string, URI for authorization endpoint. For convenience</tt> </tt> |
| 1366 | <a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"><tt class="py-docstring"> defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt> </tt> |
| 1367 | <a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI for token endpoint. For convenience</tt> </tt> |
| 1368 | <a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"><tt class="py-docstring"> defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt> </tt> |
| 1369 | <a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"><tt class="py-docstring"> **kwargs: dict, The keyword arguments are all optional and required</tt> </tt> |
| 1370 | <a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-docstring"> parameters for the OAuth calls.</tt> </tt> |
| 1371 | <a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1372 | <a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt> <tt class="py-op">=</tt> <tt class="py-name">client_id</tt> </tt> |
| 1373 | <a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_secret</tt> <tt class="py-op">=</tt> <tt class="py-name">client_secret</tt> </tt> |
| 1374 | <a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">list</tt><tt class="py-op">:</tt> </tt> |
| 1375 | <a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> </tt> |
| 1376 | <a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-name">scope</tt> </tt> |
| 1377 | <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">user_agent</tt> <tt class="py-op">=</tt> <tt class="py-name">user_agent</tt> </tt> |
| 1378 | <a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">auth_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">auth_uri</tt> </tt> |
| 1379 | <a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">token_uri</tt> </tt> |
| 1380 | <a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 1381 | <a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-string">'access_type'</tt><tt class="py-op">:</tt> <tt class="py-string">'offline'</tt><tt class="py-op">,</tt> </tt> |
| 1382 | <a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 1383 | <a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt> |
| 1384 | <a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1385 | </div><a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> </tt> |
| 1386 | <a name="OAuth2WebServerFlow.step1_get_authorize_url"></a><div id="OAuth2WebServerFlow.step1_get_authorize_url-def"><a name="L1037"></a><tt class="py-lineno">1037</tt> <a class="py-toggle" href="#" id="OAuth2WebServerFlow.step1_get_authorize_url-toggle" onclick="return toggle('OAuth2WebServerFlow.step1_get_authorize_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2WebServerFlow-class.html#step1_get_authorize_url">step1_get_authorize_url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">redirect_uri</tt><tt class="py-op">=</tt><tt id="link-134" class="py-name"><a title="oauth2client.client.OOB_CALLBACK_URN" class="py-name" href="#" onclick="return doclink('link-134', 'OOB_CALLBACK_URN', 'link-16');">OOB_CALLBACK_URN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1387 | </div><div id="OAuth2WebServerFlow.step1_get_authorize_url-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2WebServerFlow.step1_get_authorize_url-expanded"><a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a URI to redirect to the provider.</tt> </tt> |
| 1388 | <a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1389 | <a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1390 | <a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-docstring"> redirect_uri: string, Either the string 'urn:ietf:wg:oauth:2.0:oob' for</tt> </tt> |
| 1391 | <a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"> a non-web-based application, or a URI that handles the callback from</tt> </tt> |
| 1392 | <a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-docstring"> the authorization server.</tt> </tt> |
| 1393 | <a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1394 | <a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"><tt class="py-docstring"> If redirect_uri is 'urn:ietf:wg:oauth:2.0:oob' then pass in the</tt> </tt> |
| 1395 | <a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt class="py-docstring"> generated verification code to step2_exchange,</tt> </tt> |
| 1396 | <a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt class="py-docstring"> otherwise pass in the query parameters received</tt> </tt> |
| 1397 | <a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"><tt class="py-docstring"> at the callback uri to step2_exchange.</tt> </tt> |
| 1398 | <a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1399 | <a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> </tt> |
| 1400 | <a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">redirect_uri</tt> </tt> |
| 1401 | <a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 1402 | <a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"> <tt class="py-string">'response_type'</tt><tt class="py-op">:</tt> <tt class="py-string">'code'</tt><tt class="py-op">,</tt> </tt> |
| 1403 | <a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt><tt class="py-op">,</tt> </tt> |
| 1404 | <a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-string">'redirect_uri'</tt><tt class="py-op">:</tt> <tt class="py-name">redirect_uri</tt><tt class="py-op">,</tt> </tt> |
| 1405 | <a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-string">'scope'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt> |
| 1406 | <a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 1407 | <a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt> |
| 1408 | <a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">list</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 class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">auth_uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1409 | <a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">query</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">parse_qsl</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-comment"># 4 is the index of the query part</tt> </tt> |
| 1410 | <a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">)</tt> </tt> |
| 1411 | <a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> </tt> |
| 1412 | </div><a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> </tt> |
| 1413 | <a name="OAuth2WebServerFlow.step2_exchange"></a><div id="OAuth2WebServerFlow.step2_exchange-def"><a name="L1064"></a><tt class="py-lineno">1064</tt> <a class="py-toggle" href="#" id="OAuth2WebServerFlow.step2_exchange-toggle" onclick="return toggle('OAuth2WebServerFlow.step2_exchange');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client.OAuth2WebServerFlow-class.html#step2_exchange">step2_exchange</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">code</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> |
| 1414 | </div><div id="OAuth2WebServerFlow.step2_exchange-collapsed" style="display:none;" pad="++++" indent="++++++"></div><div id="OAuth2WebServerFlow.step2_exchange-expanded"><a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-docstring">"""Exhanges a code for OAuth2Credentials.</tt> </tt> |
| 1415 | <a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1416 | <a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1417 | <a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"><tt class="py-docstring"> code: string or dict, either the code as a string, or a dictionary</tt> </tt> |
| 1418 | <a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"><tt class="py-docstring"> of the query parameters to the redirect_uri, which contains</tt> </tt> |
| 1419 | <a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"><tt class="py-docstring"> the code.</tt> </tt> |
| 1420 | <a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"> http: httplib2.Http, optional http instance to use to do the fetch</tt> </tt> |
| 1421 | <a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1422 | <a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1423 | <a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> An OAuth2Credentials object that can be used to authorize requests.</tt> </tt> |
| 1424 | <a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1425 | <a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1426 | <a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-docstring"> FlowExchangeError if a problem occured exchanging the code for a</tt> </tt> |
| 1427 | <a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"><tt class="py-docstring"> refresh_token.</tt> </tt> |
| 1428 | <a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1429 | <a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> </tt> |
| 1430 | <a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">code</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">code</tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1431 | <a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'code'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">code</tt><tt class="py-op">:</tt> </tt> |
| 1432 | <a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'error'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">code</tt><tt class="py-op">:</tt> </tt> |
| 1433 | <a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-name">code</tt><tt class="py-op">[</tt><tt class="py-string">'error'</tt><tt class="py-op">]</tt> </tt> |
| 1434 | <a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1435 | <a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'No code was supplied in the query parameters.'</tt> </tt> |
| 1436 | <a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-135" class="py-name" targets="Class oauth2client.client.FlowExchangeError=oauth2client.client.FlowExchangeError-class.html"><a title="oauth2client.client.FlowExchangeError" class="py-name" href="#" onclick="return doclink('link-135', 'FlowExchangeError', 'link-135');">FlowExchangeError</a></tt><tt class="py-op">(</tt><tt class="py-name">error_msg</tt><tt class="py-op">)</tt> </tt> |
| 1437 | <a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1438 | <a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-name">code</tt> <tt class="py-op">=</tt> <tt class="py-name">code</tt><tt class="py-op">[</tt><tt class="py-string">'code'</tt><tt class="py-op">]</tt> </tt> |
| 1439 | <a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> </tt> |
| 1440 | <a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">body</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-op">{</tt> </tt> |
| 1441 | <a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-string">'grant_type'</tt><tt class="py-op">:</tt> <tt class="py-string">'authorization_code'</tt><tt class="py-op">,</tt> </tt> |
| 1442 | <a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt><tt class="py-op">,</tt> </tt> |
| 1443 | <a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_secret</tt><tt class="py-op">,</tt> </tt> |
| 1444 | <a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-string">'code'</tt><tt class="py-op">:</tt> <tt class="py-name">code</tt><tt class="py-op">,</tt> </tt> |
| 1445 | <a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-string">'redirect_uri'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">redirect_uri</tt><tt class="py-op">,</tt> </tt> |
| 1446 | <a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> <tt class="py-string">'scope'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt> |
| 1447 | <a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-op">}</tt><tt class="py-op">)</tt> </tt> |
| 1448 | <a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 1449 | <a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-string">'content-type'</tt><tt class="py-op">:</tt> <tt class="py-string">'application/x-www-form-urlencoded'</tt><tt class="py-op">,</tt> </tt> |
| 1450 | <a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 1451 | <a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> </tt> |
| 1452 | <a name="L1103"></a><tt class="py-lineno">1103</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">user_agent</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> |
| 1453 | <a name="L1104"></a><tt class="py-lineno">1104</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">self</tt><tt class="py-op">.</tt><tt class="py-name">user_agent</tt> </tt> |
| 1454 | <a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> </tt> |
| 1455 | <a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-136" class="py-name"><a title="apiclient.http |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1456 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-136', 'http', 'link-43');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1457 | <a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="apiclient.http |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1458 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-137', 'http', 'link-43');">http</a></tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1459 | <a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> </tt> |
| 1460 | <a name="L1109"></a><tt class="py-lineno">1109</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-138" class="py-name"><a title="apiclient.http |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1461 | oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-138', 'http', 'link-43');">http</a></tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1462 | apiclient.http.HttpMockSequence.request |
| 1463 | apiclient.model.BaseModel.request |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1464 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-139', 'request', 'link-44');">request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt><tt class="py-op">,</tt> <tt class="py-name">method</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 | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1465 | <a name="L1110"></a><tt class="py-lineno">1110</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> |
| 1466 | <a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt id="link-140" class="py-name" targets="Function oauth2client.client._parse_exchange_token_response()=oauth2client.client-module.html#_parse_exchange_token_response"><a title="oauth2client.client._parse_exchange_token_response" class="py-name" href="#" onclick="return doclink('link-140', '_parse_exchange_token_response', 'link-140');">_parse_exchange_token_response</a></tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| 1467 | <a name="L1112"></a><tt class="py-lineno">1112</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">'access_token'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 1468 | <a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-name">access_token</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'access_token'</tt><tt class="py-op">]</tt> </tt> |
| 1469 | <a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-name">refresh_token</tt> <tt class="py-op">=</tt> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1470 | oauth2client.appengine.OAuth2Handler.get |
| 1471 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1472 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-141', 'get', 'link-17');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'refresh_token'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1473 | <a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"> <tt class="py-name">token_expiry</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 1474 | <a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'expires_in'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 1475 | <a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> <tt class="py-name">token_expiry</tt> <tt class="py-op">=</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">utcnow</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">datetime</tt><tt class="py-op">.</tt><tt class="py-name">timedelta</tt><tt class="py-op">(</tt> </tt> |
| 1476 | <a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"> <tt class="py-name">seconds</tt><tt class="py-op">=</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'expires_in'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1477 | <a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"> </tt> |
| 1478 | <a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'id_token'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 1479 | <a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'id_token'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-142" class="py-name" targets="Function oauth2client.client._extract_id_token()=oauth2client.client-module.html#_extract_id_token"><a title="oauth2client.client._extract_id_token" class="py-name" href="#" onclick="return doclink('link-142', '_extract_id_token', 'link-142');">_extract_id_token</a></tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'id_token'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1480 | <a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> </tt> |
| 1481 | <a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt id="link-143" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1482 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1483 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1484 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1485 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1486 | oauth2client.multistore_file.logger |
| 1487 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-143', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Successfully retrieved access token: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1488 | <a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-144" class="py-name"><a title="oauth2client.client.OAuth2Credentials" class="py-name" href="#" onclick="return doclink('link-144', 'OAuth2Credentials', 'link-64');">OAuth2Credentials</a></tt><tt class="py-op">(</tt><tt class="py-name">access_token</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_id</tt><tt class="py-op">,</tt> </tt> |
| 1489 | <a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">client_secret</tt><tt class="py-op">,</tt> <tt class="py-name">refresh_token</tt><tt class="py-op">,</tt> <tt class="py-name">token_expiry</tt><tt class="py-op">,</tt> </tt> |
| 1490 | <a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token_uri</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">user_agent</tt><tt class="py-op">,</tt> </tt> |
| 1491 | <a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt class="py-name">id_token</tt><tt class="py-op">=</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1492 | oauth2client.appengine.OAuth2Handler.get |
| 1493 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1494 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-145', 'get', 'link-17');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'id_token'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1495 | <a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1496 | <a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> <tt id="link-146" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1497 | oauth2client.appengine.logger |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1498 | oauth2client.client.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 1499 | oauth2client.crypt.logger |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1500 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1501 | oauth2client.multistore_file.logger |
| 1502 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-146', 'logger', 'link-13');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Failed to retrieve access token: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1503 | <a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'error'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> </tt> |
| 1504 | <a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"> <tt class="py-comment"># you never know what those providers got to say</tt> </tt> |
| 1505 | <a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-name">unicode</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">[</tt><tt class="py-string">'error'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1506 | <a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1507 | <a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"> <tt class="py-name">error_msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'Invalid response: %s.'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt class="py-name">status</tt><tt class="py-op">)</tt> </tt> |
| 1508 | <a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-147" class="py-name"><a title="oauth2client.client.FlowExchangeError" class="py-name" href="#" onclick="return doclink('link-147', 'FlowExchangeError', 'link-135');">FlowExchangeError</a></tt><tt class="py-op">(</tt><tt class="py-name">error_msg</tt><tt class="py-op">)</tt> </tt> |
| 1509 | </div></div><a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> </tt> |
| 1510 | <a name="flow_from_clientsecrets"></a><div id="flow_from_clientsecrets-def"><a name="L1137"></a><tt class="py-lineno">1137</tt> <a class="py-toggle" href="#" id="flow_from_clientsecrets-toggle" onclick="return toggle('flow_from_clientsecrets');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.client-module.html#flow_from_clientsecrets">flow_from_clientsecrets</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">cache</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1511 | </div><div id="flow_from_clientsecrets-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="flow_from_clientsecrets-expanded"><a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a Flow from a clientsecrets file.</tt> </tt> |
| 1512 | <a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1513 | <a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"><tt class="py-docstring"> Will create the right kind of Flow based on the contents of the clientsecrets</tt> </tt> |
| 1514 | <a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"><tt class="py-docstring"> file or will raise InvalidClientSecretsError for unknown types of Flows.</tt> </tt> |
| 1515 | <a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1516 | <a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1517 | <a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, File name of client secrets.</tt> </tt> |
| 1518 | <a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) to request.</tt> </tt> |
| 1519 | <a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"><tt class="py-docstring"> message: string, A friendly string to display to the user if the</tt> </tt> |
| 1520 | <a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets file is missing or invalid. If message is provided then</tt> </tt> |
| 1521 | <a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"><tt class="py-docstring"> sys.exit will be called in the case of an error. If message in not</tt> </tt> |
| 1522 | <a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"><tt class="py-docstring"> provided then clientsecrets.InvalidClientSecretsError will be raised.</tt> </tt> |
| 1523 | <a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"><tt class="py-docstring"> cache: An optional cache service client that implements get() and set() </tt> </tt> |
| 1524 | <a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"><tt class="py-docstring"> methods. See clientsecrets.loadfile() for details.</tt> </tt> |
| 1525 | <a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1526 | <a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1527 | <a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"><tt class="py-docstring"> A Flow object.</tt> </tt> |
| 1528 | <a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1529 | <a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 1530 | <a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-docstring"> UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.</tt> </tt> |
| 1531 | <a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets.InvalidClientSecretsError if the clientsecrets file is</tt> </tt> |
| 1532 | <a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"> invalid.</tt> </tt> |
| 1533 | <a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1534 | <a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-keyword">try</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">client_type</tt><tt class="py-op">,</tt> <tt class="py-name">client_info</tt> <tt class="py-op">=</tt> <tt id="link-148" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-148', 'clientsecrets', 'link-0');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-149" class="py-name" targets="Function oauth2client.clientsecrets.loadfile()=oauth2client.clientsecrets-module.html#loadfile"><a title="oauth2client.clientsecrets.loadfile" class="py-name" href="#" onclick="return doclink('link-149', 'loadfile', 'link-149');">loadfile</a></tt><tt class="py-op">(</tt><tt id="link-150" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename |
| 1536 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-150', 'filename', 'link-128');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">cache</tt><tt class="py-op">=</tt><tt class="py-name">cache</tt><tt class="py-op">)</tt> </tt> |
| 1537 | <a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">client_type</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt id="link-151" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-151', 'clientsecrets', 'link-0');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-152" class="py-name" targets="Variable oauth2client.clientsecrets.TYPE_WEB=oauth2client.clientsecrets-module.html#TYPE_WEB"><a title="oauth2client.clientsecrets.TYPE_WEB" class="py-name" href="#" onclick="return doclink('link-152', 'TYPE_WEB', 'link-152');">TYPE_WEB</a></tt><tt class="py-op">,</tt> <tt id="link-153" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-153', 'clientsecrets', 'link-0');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-154" class="py-name" targets="Variable oauth2client.clientsecrets.TYPE_INSTALLED=oauth2client.clientsecrets-module.html#TYPE_INSTALLED"><a title="oauth2client.clientsecrets.TYPE_INSTALLED" class="py-name" href="#" onclick="return doclink('link-154', 'TYPE_INSTALLED', 'link-154');">TYPE_INSTALLED</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt> |
| 1538 | <a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-155" class="py-name"><a title="oauth2client.client.OAuth2WebServerFlow" class="py-name" href="#" onclick="return doclink('link-155', 'OAuth2WebServerFlow', 'link-121');">OAuth2WebServerFlow</a></tt><tt class="py-op">(</tt> </tt> |
| 1539 | <a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-name">client_info</tt><tt class="py-op">[</tt><tt class="py-string">'client_id'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1540 | <a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-name">client_info</tt><tt class="py-op">[</tt><tt class="py-string">'client_secret'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1541 | <a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt> |
| 1542 | <a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-comment"># user_agent</tt> </tt> |
| 1543 | <a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-name">client_info</tt><tt class="py-op">[</tt><tt class="py-string">'auth_uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt> |
| 1544 | <a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-name">client_info</tt><tt class="py-op">[</tt><tt class="py-string">'token_uri'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1545 | <a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-156" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-156', 'clientsecrets', 'link-0');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-157" class="py-name" targets="Class oauth2client.appengine.InvalidClientSecretsError=oauth2client.appengine.InvalidClientSecretsError-class.html,Class oauth2client.clientsecrets.InvalidClientSecretsError=oauth2client.clientsecrets.InvalidClientSecretsError-class.html"><a title="oauth2client.appengine.InvalidClientSecretsError |
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 1546 | oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-157', 'InvalidClientSecretsError', 'link-157');">InvalidClientSecretsError</a></tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame] | 1547 | <a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">message</tt><tt class="py-op">:</tt> </tt> |
| 1548 | <a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">)</tt> </tt> |
| 1549 | <a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1550 | <a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt> |
| 1551 | <a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1552 | <a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-158" class="py-name" targets="Class oauth2client.client.UnknownClientSecretsFlowError=oauth2client.client.UnknownClientSecretsFlowError-class.html"><a title="oauth2client.client.UnknownClientSecretsFlowError" class="py-name" href="#" onclick="return doclink('link-158', 'UnknownClientSecretsFlowError', 'link-158');">UnknownClientSecretsFlowError</a></tt><tt class="py-op">(</tt> </tt> |
| 1553 | <a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> <tt class="py-string">'This OAuth 2.0 flow is unsupported: "%s"'</tt> <tt class="py-op">*</tt> <tt class="py-name">client_type</tt><tt class="py-op">)</tt> </tt> |
| 1554 | </div><a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> </tt><script type="text/javascript"> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1555 | <!-- |
| 1556 | expandto(location.href); |
| 1557 | // --> |
| 1558 | </script> |
| 1559 | </pre> |
| 1560 | <br /> |
| 1561 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 1562 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 1563 | bgcolor="#a0c0ff" cellspacing="0"> |
| 1564 | <tr valign="middle"> |
| 1565 | |
| 1566 | <!-- Tree link --> |
| 1567 | <th> <a |
| 1568 | href="module-tree.html">Trees</a> </th> |
| 1569 | |
| 1570 | <!-- Index link --> |
| 1571 | <th> <a |
| 1572 | href="identifier-index.html">Indices</a> </th> |
| 1573 | |
| 1574 | <!-- Help link --> |
| 1575 | <th> <a |
| 1576 | href="help.html">Help</a> </th> |
| 1577 | |
| 1578 | <th class="navbar" width="100%"></th> |
| 1579 | </tr> |
| 1580 | </table> |
| 1581 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 1582 | <tr> |
| 1583 | <td align="left" class="footer"> |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1584 | Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:32 2012 |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1585 | </td> |
| 1586 | <td align="right" class="footer"> |
| 1587 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 1588 | >http://epydoc.sourceforge.net</a> |
| 1589 | </td> |
| 1590 | </tr> |
| 1591 | </table> |
| 1592 | |
| 1593 | <script type="text/javascript"> |
| 1594 | <!-- |
| 1595 | // Private objects are initially displayed (because if |
| 1596 | // javascript is turned off then we want them to be |
| 1597 | // visible); but by default, we want to hide them. So hide |
| 1598 | // them unless we have a cookie that says to show them. |
| 1599 | checkCookie(); |
| 1600 | // --> |
| 1601 | </script> |
| 1602 | </body> |
| 1603 | </html> |