| 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.appengine</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 appengine |
| 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.appengine-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.appengine-module.html">Module oauth2client.appengine</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">"""Utilities for Google App Engine</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">Utilities for making it easier to use OAuth 2.0 on Google App Engine.</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> |
| Joe Gregorio | 0cd347a | 2012-08-30 08:22:27 -0400 | [diff] [blame] | 78 | <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">cgi</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">httplib2</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">logging</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">os</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">pickle</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">time</tt> </tt> |
| 84 | <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> </tt> |
| 85 | <a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Module oauth2client.appengine=oauth2client.appengine-module.html"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-0', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt class="py-name">api</tt> <tt class="py-keyword">import</tt> <tt class="py-name">app_identity</tt> </tt> |
| 86 | <a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-1', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt class="py-name">api</tt> <tt class="py-keyword">import</tt> <tt class="py-name">memcache</tt> </tt> |
| 87 | <a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-2', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt class="py-name">api</tt> <tt class="py-keyword">import</tt> <tt class="py-name">users</tt> </tt> |
| 88 | <a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-3', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Package apiclient.ext=apiclient.ext-module.html"><a title="apiclient.ext" class="py-name" href="#" onclick="return doclink('link-4', 'ext', 'link-4');">ext</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">db</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 89 | <a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-5', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="apiclient.ext" class="py-name" href="#" onclick="return doclink('link-6', 'ext', 'link-4');">ext</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">webapp</tt> </tt> |
| 90 | <a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-7', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="apiclient.ext" class="py-name" href="#" onclick="return doclink('link-8', 'ext', 'link-4');">ext</a></tt><tt class="py-op">.</tt><tt class="py-name">webapp</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Module oauth2client.util=oauth2client.util-module.html"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-9', 'util', 'link-9');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">login_required</tt> </tt> |
| 91 | <a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-10', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="apiclient.ext" class="py-name" href="#" onclick="return doclink('link-11', 'ext', 'link-4');">ext</a></tt><tt class="py-op">.</tt><tt class="py-name">webapp</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-12', 'util', 'link-9');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">run_wsgi_app</tt> </tt> |
| 92 | <a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-13" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-13', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-14" class="py-name" targets="Variable oauth2client.GOOGLE_AUTH_URI=oauth2client-module.html#GOOGLE_AUTH_URI"><a title="oauth2client.GOOGLE_AUTH_URI" class="py-name" href="#" onclick="return doclink('link-14', 'GOOGLE_AUTH_URI', 'link-14');">GOOGLE_AUTH_URI</a></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-15" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-15', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-16" class="py-name" targets="Variable oauth2client.GOOGLE_REVOKE_URI=oauth2client-module.html#GOOGLE_REVOKE_URI"><a title="oauth2client.GOOGLE_REVOKE_URI" class="py-name" href="#" onclick="return doclink('link-16', 'GOOGLE_REVOKE_URI', 'link-16');">GOOGLE_REVOKE_URI</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-17" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-17', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-18" class="py-name" targets="Variable oauth2client.GOOGLE_TOKEN_URI=oauth2client-module.html#GOOGLE_TOKEN_URI"><a title="oauth2client.GOOGLE_TOKEN_URI" class="py-name" href="#" onclick="return doclink('link-18', 'GOOGLE_TOKEN_URI', 'link-18');">GOOGLE_TOKEN_URI</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-19" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-19', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-20" class="py-name" targets="Module oauth2client.clientsecrets=oauth2client.clientsecrets-module.html"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-20', 'clientsecrets', 'link-20');">clientsecrets</a></tt> </tt> |
| 96 | <a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-21" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-21', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-22" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-22', 'util', 'link-9');">util</a></tt> </tt> |
| 97 | <a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-23" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-23', 'oauth2client', 'link-13');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-24" class="py-name" targets="Module oauth2client.xsrfutil=oauth2client.xsrfutil-module.html"><a title="oauth2client.xsrfutil" class="py-name" href="#" onclick="return doclink('link-24', 'xsrfutil', 'link-24');">xsrfutil</a></tt> </tt> |
| 98 | <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-25" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-25', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-26', 'anyjson', 'link-26');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt> |
| 99 | <a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-27" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-27', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Module oauth2client.client=oauth2client.client-module.html"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-28', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-29" 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-29', 'AccessTokenRefreshError', 'link-29');">AccessTokenRefreshError</a></tt> </tt> |
| 100 | <a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-30" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-30', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-31', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-32" 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-32', 'AssertionCredentials', 'link-32');">AssertionCredentials</a></tt> </tt> |
| 101 | <a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-33" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-33', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-34', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-35" 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-35', 'Credentials', 'link-35');">Credentials</a></tt> </tt> |
| 102 | <a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-36" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-36', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-37', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-38" class="py-name" targets="Class oauth2client.client.Flow=oauth2client.client.Flow-class.html"><a title="oauth2client.client.Flow" class="py-name" href="#" onclick="return doclink('link-38', 'Flow', 'link-38');">Flow</a></tt> </tt> |
| 103 | <a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-39" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-39', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-40', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-41" 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-41', 'OAuth2WebServerFlow', 'link-41');">OAuth2WebServerFlow</a></tt> </tt> |
| 104 | <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-42" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-42', 'oauth2client', 'link-13');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-43', 'client', 'link-28');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-44" class="py-name" targets="Class oauth2client.client.Storage=oauth2client.client.Storage-class.html,Class oauth2client.django_orm.Storage=oauth2client.django_orm.Storage-class.html,Class oauth2client.file.Storage=oauth2client.file.Storage-class.html,Class oauth2client.keyring_storage.Storage=oauth2client.keyring_storage.Storage-class.html"><a title="oauth2client.client.Storage |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 105 | oauth2client.django_orm.Storage |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 106 | oauth2client.file.Storage |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 107 | oauth2client.keyring_storage.Storage" class="py-name" href="#" onclick="return doclink('link-44', 'Storage', 'link-44');">Storage</a></tt> </tt> |
| 108 | <a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> </tt> |
| 109 | <a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-comment"># TODO(dhermes): Resolve import issue.</tt> </tt> |
| 110 | <a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-comment"># This is a temporary fix for a Google internal issue.</tt> </tt> |
| 111 | <a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 112 | <a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="oauth2client.appengine" class="py-name" href="#" onclick="return doclink('link-45', 'appengine', 'link-0');">appengine</a></tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="apiclient.ext" class="py-name" href="#" onclick="return doclink('link-46', 'ext', 'link-4');">ext</a></tt> <tt class="py-keyword">import</tt> <tt id="link-47" class="py-name" targets="Variable oauth2client.appengine.ndb=oauth2client.appengine-module.html#ndb"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-47', 'ndb', 'link-47');">ndb</a></tt> </tt> |
| 113 | <a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt> |
| 114 | <a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt id="link-48" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-48', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 115 | <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt> |
| 116 | <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> </tt> |
| 117 | <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt id="link-49" 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.gce.logger=oauth2client.gce-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] | 118 | oauth2client.appengine.logger |
| 119 | oauth2client.client.logger |
| 120 | oauth2client.crypt.logger |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 121 | oauth2client.gce.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 122 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 123 | oauth2client.multistore_file.logger |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 124 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-49', 'logger', 'link-49');">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> |
| 125 | <a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> </tt> |
| 126 | <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt id="link-50" class="py-name" targets="Variable oauth2client.appengine.OAUTH2CLIENT_NAMESPACE=oauth2client.appengine-module.html#OAUTH2CLIENT_NAMESPACE"><a title="oauth2client.appengine.OAUTH2CLIENT_NAMESPACE" class="py-name" href="#" onclick="return doclink('link-50', 'OAUTH2CLIENT_NAMESPACE', 'link-50');">OAUTH2CLIENT_NAMESPACE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'oauth2client#ns'</tt> </tt> |
| 127 | <a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> </tt> |
| 128 | <a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt id="link-51" class="py-name" targets="Variable oauth2client.appengine.XSRF_MEMCACHE_ID=oauth2client.appengine-module.html#XSRF_MEMCACHE_ID"><a title="oauth2client.appengine.XSRF_MEMCACHE_ID" class="py-name" href="#" onclick="return doclink('link-51', 'XSRF_MEMCACHE_ID', 'link-51');">XSRF_MEMCACHE_ID</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'xsrf_secret_key'</tt> </tt> |
| 129 | <a name="_safe_html"></a><div id="_safe_html-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> </tt> |
| 130 | <a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt> |
| 131 | <a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="_safe_html-toggle" onclick="return toggle('_safe_html');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#_safe_html">_safe_html</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 132 | </div><div id="_safe_html-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_safe_html-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-docstring">"""Escape text to make it safe to display.</tt> </tt> |
| 133 | <a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 134 | <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 135 | <a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> s: string, The text to escape.</tt> </tt> |
| 136 | <a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 137 | <a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 138 | <a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> The escaped text as a string.</tt> </tt> |
| 139 | <a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 140 | <a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cgi</tt><tt class="py-op">.</tt><tt class="py-name">escape</tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">,</tt> <tt class="py-name">quote</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">"'"</tt><tt class="py-op">,</tt> <tt class="py-string">'&#39;'</tt><tt class="py-op">)</tt> </tt> |
| 141 | </div><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> </tt> |
| 142 | <a name="InvalidClientSecretsError"></a><div id="InvalidClientSecretsError-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> </tt> |
| 143 | <a name="L78"></a><tt class="py-lineno"> 78</tt> <a class="py-toggle" href="#" id="InvalidClientSecretsError-toggle" onclick="return toggle('InvalidClientSecretsError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.InvalidClientSecretsError-class.html">InvalidClientSecretsError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 144 | </div><div id="InvalidClientSecretsError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidClientSecretsError-expanded"><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-docstring">"""The client_secrets.json file is malformed or missing required fields."""</tt> </tt> |
| 145 | </div><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt> |
| 146 | <a name="InvalidXsrfTokenError"></a><div id="InvalidXsrfTokenError-def"><a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt> |
| 147 | <a name="L82"></a><tt class="py-lineno"> 82</tt> <a class="py-toggle" href="#" id="InvalidXsrfTokenError-toggle" onclick="return toggle('InvalidXsrfTokenError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.InvalidXsrfTokenError-class.html">InvalidXsrfTokenError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 148 | </div><div id="InvalidXsrfTokenError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidXsrfTokenError-expanded"><a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-docstring">"""The XSRF token is invalid or expired."""</tt> </tt> |
| 149 | </div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt> |
| 150 | <a name="SiteXsrfSecretKey"></a><div id="SiteXsrfSecretKey-def"><a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt> |
| 151 | <a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="SiteXsrfSecretKey-toggle" onclick="return toggle('SiteXsrfSecretKey');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.SiteXsrfSecretKey-class.html">SiteXsrfSecretKey</a><tt class="py-op">(</tt><tt class="py-base-class">db</tt><tt class="py-op">.</tt><tt class="py-base-class">Model</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 152 | </div><div id="SiteXsrfSecretKey-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="SiteXsrfSecretKey-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""Storage for the sites XSRF secret key.</tt> </tt> |
| 153 | <a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 154 | <a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> There will only be one instance stored of this model, the one used for the</tt> </tt> |
| 155 | <a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> site.</tt> </tt> |
| 156 | <a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 157 | <a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt id="link-52" class="py-name" targets="Variable oauth2client.appengine.SiteXsrfSecretKey.secret=oauth2client.appengine.SiteXsrfSecretKey-class.html#secret,Variable oauth2client.appengine.SiteXsrfSecretKeyNDB.secret=oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html#secret"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 158 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-52', 'secret', 'link-52');">secret</a></tt> <tt class="py-op">=</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">StringProperty</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 159 | </div><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> </tt> |
| 160 | <a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt id="link-53" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-53', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 161 | <a name="SiteXsrfSecretKeyNDB"></a><div id="SiteXsrfSecretKeyNDB-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <a class="py-toggle" href="#" id="SiteXsrfSecretKeyNDB-toggle" onclick="return toggle('SiteXsrfSecretKeyNDB');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html">SiteXsrfSecretKeyNDB</a><tt class="py-op">(</tt><tt class="py-base-class">ndb</tt><tt class="py-op">.</tt><tt class="py-base-class">Model</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 162 | </div><div id="SiteXsrfSecretKeyNDB-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="SiteXsrfSecretKeyNDB-expanded"><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-docstring">"""NDB Model for storage for the sites XSRF secret key.</tt> </tt> |
| 163 | <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 164 | <a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> Since this model uses the same kind as SiteXsrfSecretKey, it can be used</tt> </tt> |
| 165 | <a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> interchangeably. This simply provides an NDB model for interacting with the</tt> </tt> |
| 166 | <a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> same data the DB model interacts with.</tt> </tt> |
| 167 | <a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 168 | <a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> There should only be one instance stored of this model, the one used for the</tt> </tt> |
| 169 | <a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> site.</tt> </tt> |
| 170 | <a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 171 | <a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt id="link-54" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 172 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-54', 'secret', 'link-52');">secret</a></tt> <tt class="py-op">=</tt> <tt id="link-55" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-55', 'ndb', 'link-47');">ndb</a></tt><tt class="py-op">.</tt><tt class="py-name">StringProperty</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 173 | <a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt> |
| 174 | <a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 175 | <a name="SiteXsrfSecretKeyNDB._get_kind"></a><div id="SiteXsrfSecretKeyNDB._get_kind-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="SiteXsrfSecretKeyNDB._get_kind-toggle" onclick="return toggle('SiteXsrfSecretKeyNDB._get_kind');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html#_get_kind">_get_kind</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 176 | </div><div id="SiteXsrfSecretKeyNDB._get_kind-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="SiteXsrfSecretKeyNDB._get_kind-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the kind name for this class."""</tt> </tt> |
| 177 | <a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'SiteXsrfSecretKey'</tt> </tt> |
| 178 | </div></div><a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> </tt> |
| 179 | <a name="_generate_new_xsrf_secret_key"></a><div id="_generate_new_xsrf_secret_key-def"><a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> </tt> |
| 180 | <a name="L113"></a><tt class="py-lineno">113</tt> <a class="py-toggle" href="#" id="_generate_new_xsrf_secret_key-toggle" onclick="return toggle('_generate_new_xsrf_secret_key');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#_generate_new_xsrf_secret_key">_generate_new_xsrf_secret_key</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 181 | </div><div id="_generate_new_xsrf_secret_key-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_generate_new_xsrf_secret_key-expanded"><a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns a random XSRF secret key.</tt> </tt> |
| 182 | <a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 183 | <a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">urandom</tt><tt class="py-op">(</tt><tt class="py-number">16</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">"hex"</tt><tt class="py-op">)</tt> </tt> |
| 184 | </div><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> </tt> |
| 185 | <a name="xsrf_secret_key"></a><div id="xsrf_secret_key-def"><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> </tt> |
| 186 | <a name="L119"></a><tt class="py-lineno">119</tt> <a class="py-toggle" href="#" id="xsrf_secret_key-toggle" onclick="return toggle('xsrf_secret_key');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#xsrf_secret_key">xsrf_secret_key</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 187 | </div><div id="xsrf_secret_key-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="xsrf_secret_key-expanded"><a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the secret key for use for XSRF protection.</tt> </tt> |
| 188 | <a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 189 | <a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> If the Site entity does not have a secret key, this method will also create</tt> </tt> |
| 190 | <a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> one and persist it.</tt> </tt> |
| 191 | <a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 192 | <a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 193 | <a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> The secret key.</tt> </tt> |
| 194 | <a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 195 | <a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt id="link-56" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 196 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-56', 'secret', 'link-52');">secret</a></tt> <tt class="py-op">=</tt> <tt class="py-name">memcache</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name" targets="Method apiclient.schema.Schemas.get()=apiclient.schema.Schemas-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 |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 197 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 198 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-57', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt id="link-58" class="py-name"><a title="oauth2client.appengine.XSRF_MEMCACHE_ID" class="py-name" href="#" onclick="return doclink('link-58', 'XSRF_MEMCACHE_ID', 'link-51');">XSRF_MEMCACHE_ID</a></tt><tt class="py-op">,</tt> <tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt id="link-59" class="py-name"><a title="oauth2client.appengine.OAUTH2CLIENT_NAMESPACE" class="py-name" href="#" onclick="return doclink('link-59', 'OAUTH2CLIENT_NAMESPACE', 'link-50');">OAUTH2CLIENT_NAMESPACE</a></tt><tt class="py-op">)</tt> </tt> |
| 199 | <a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-60" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 200 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-60', 'secret', 'link-52');">secret</a></tt><tt class="py-op">:</tt> </tt> |
| 201 | <a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-comment"># Load the one and only instance of SiteXsrfSecretKey.</tt> </tt> |
| 202 | <a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt id="link-61" class="py-name" targets="Module apiclient.model=apiclient.model-module.html"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-61', 'model', 'link-61');">model</a></tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name" targets="Class oauth2client.appengine.SiteXsrfSecretKey=oauth2client.appengine.SiteXsrfSecretKey-class.html"><a title="oauth2client.appengine.SiteXsrfSecretKey" class="py-name" href="#" onclick="return doclink('link-62', 'SiteXsrfSecretKey', 'link-62');">SiteXsrfSecretKey</a></tt><tt class="py-op">.</tt><tt class="py-name">get_or_insert</tt><tt class="py-op">(</tt><tt class="py-name">key_name</tt><tt class="py-op">=</tt><tt class="py-string">'site'</tt><tt class="py-op">)</tt> </tt> |
| 203 | <a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-63" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-63', 'model', 'link-61');">model</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 204 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-64', 'secret', 'link-52');">secret</a></tt><tt class="py-op">:</tt> </tt> |
| 205 | <a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt id="link-65" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-65', 'model', 'link-61');">model</a></tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 206 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-66', 'secret', 'link-52');">secret</a></tt> <tt class="py-op">=</tt> <tt id="link-67" class="py-name" targets="Function oauth2client.appengine._generate_new_xsrf_secret_key()=oauth2client.appengine-module.html#_generate_new_xsrf_secret_key"><a title="oauth2client.appengine._generate_new_xsrf_secret_key" class="py-name" href="#" onclick="return doclink('link-67', '_generate_new_xsrf_secret_key', 'link-67');">_generate_new_xsrf_secret_key</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 207 | <a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt id="link-68" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-68', 'model', 'link-61');">model</a></tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Method oauth2client.client.Storage.put()=oauth2client.client.Storage-class.html#put"><a title="oauth2client.client.Storage.put" class="py-name" href="#" onclick="return doclink('link-69', 'put', 'link-69');">put</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 208 | <a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt id="link-70" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 209 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-70', 'secret', 'link-52');">secret</a></tt> <tt class="py-op">=</tt> <tt id="link-71" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-71', 'model', 'link-61');">model</a></tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 210 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-72', 'secret', 'link-52');">secret</a></tt> </tt> |
| 211 | <a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-name">memcache</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name" targets="Method apiclient.http.BatchHttpRequest.add()=apiclient.http.BatchHttpRequest-class.html#add"><a title="apiclient.http.BatchHttpRequest.add" class="py-name" href="#" onclick="return doclink('link-73', 'add', 'link-73');">add</a></tt><tt class="py-op">(</tt><tt id="link-74" class="py-name"><a title="oauth2client.appengine.XSRF_MEMCACHE_ID" class="py-name" href="#" onclick="return doclink('link-74', 'XSRF_MEMCACHE_ID', 'link-51');">XSRF_MEMCACHE_ID</a></tt><tt class="py-op">,</tt> <tt id="link-75" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 212 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-75', 'secret', 'link-52');">secret</a></tt><tt class="py-op">,</tt> <tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt id="link-76" class="py-name"><a title="oauth2client.appengine.OAUTH2CLIENT_NAMESPACE" class="py-name" href="#" onclick="return doclink('link-76', 'OAUTH2CLIENT_NAMESPACE', 'link-50');">OAUTH2CLIENT_NAMESPACE</a></tt><tt class="py-op">)</tt> </tt> |
| 213 | <a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt> |
| 214 | <a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-77" class="py-name"><a title="oauth2client.appengine.SiteXsrfSecretKey.secret |
| 215 | oauth2client.appengine.SiteXsrfSecretKeyNDB.secret" class="py-name" href="#" onclick="return doclink('link-77', 'secret', 'link-52');">secret</a></tt><tt class="py-op">)</tt> </tt> |
| 216 | </div><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> </tt> |
| 217 | <a name="AppAssertionCredentials"></a><div id="AppAssertionCredentials-def"><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt> |
| 218 | <a name="L141"></a><tt class="py-lineno">141</tt> <a class="py-toggle" href="#" id="AppAssertionCredentials-toggle" onclick="return toggle('AppAssertionCredentials');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.AppAssertionCredentials-class.html">AppAssertionCredentials</a><tt class="py-op">(</tt><tt class="py-base-class">AssertionCredentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 219 | </div><div id="AppAssertionCredentials-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="AppAssertionCredentials-expanded"><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-docstring">"""Credentials object for App Engine Assertion Grants</tt> </tt> |
| 220 | <a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 221 | <a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> This object will allow an App Engine application to identify itself to Google</tt> </tt> |
| 222 | <a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> and other OAuth 2.0 servers that can verify assertions. It can be used for the</tt> </tt> |
| 223 | <a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> purpose of accessing data stored under an account assigned to the App Engine</tt> </tt> |
| 224 | <a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> application itself.</tt> </tt> |
| 225 | <a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 226 | <a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> This credential does not require a flow to instantiate because it represents</tt> </tt> |
| 227 | <a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> a two legged flow, and therefore has all of the required information to</tt> </tt> |
| 228 | <a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> generate and refresh its own access tokens.</tt> </tt> |
| 229 | <a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 230 | <a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 231 | <a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name" targets="Function oauth2client.util.positional()=oauth2client.util-module.html#positional"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-78', 'positional', 'link-78');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt> |
| 232 | <a name="AppAssertionCredentials.__init__"></a><div id="AppAssertionCredentials.__init__-def"><a name="L155"></a><tt class="py-lineno">155</tt> <a class="py-toggle" href="#" id="AppAssertionCredentials.__init__-toggle" onclick="return toggle('AppAssertionCredentials.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.AppAssertionCredentials-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">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 233 | </div><div id="AppAssertionCredentials.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="AppAssertionCredentials.__init__-expanded"><a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for AppAssertionCredentials</tt> </tt> |
| 234 | <a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 235 | <a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 236 | <a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or iterable of strings, scope(s) of the credentials being</tt> </tt> |
| 237 | <a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 238 | <a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 239 | <a name="L162"></a><tt class="py-lineno">162</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 id="link-79" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-79', 'util', 'link-9');">util</a></tt><tt class="py-op">.</tt><tt id="link-80" class="py-name" targets="Function oauth2client.util.scopes_to_string()=oauth2client.util-module.html#scopes_to_string"><a title="oauth2client.util.scopes_to_string" class="py-name" href="#" onclick="return doclink('link-80', 'scopes_to_string', 'link-80');">scopes_to_string</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> </tt> |
| 240 | <a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> </tt> |
| 241 | <a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-comment"># Assertion type is no longer used, but still in the parent class signature.</tt> </tt> |
| 242 | <a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-81" class="py-name" targets="Class oauth2client.appengine.AppAssertionCredentials=oauth2client.appengine.AppAssertionCredentials-class.html,Class oauth2client.gce.AppAssertionCredentials=oauth2client.gce.AppAssertionCredentials-class.html"><a title="oauth2client.appengine.AppAssertionCredentials |
| 243 | oauth2client.gce.AppAssertionCredentials" class="py-name" href="#" onclick="return doclink('link-81', 'AppAssertionCredentials', 'link-81');">AppAssertionCredentials</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-82" class="py-name" targets="Method apiclient.discovery.Resource.__init__()=apiclient.discovery.Resource-class.html#__init__,Method apiclient.discovery.ResourceMethodParameters.__init__()=apiclient.discovery.ResourceMethodParameters-class.html#__init__,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.http._StreamSlice.__init__()=apiclient.http._StreamSlice-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.push.Channel.__init__()=apiclient.push.Channel-class.html#__init__,Method apiclient.push.Headers.__init__()=apiclient.push.Headers-class.html#__init__,Method apiclient.push.Subscription.__init__()=apiclient.push.Subscription-class.html#__init__,Method apiclient.push.WebhookChannel.__init__()=apiclient.push.WebhookChannel-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.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.gce.AppAssertionCredentials.__init__()=oauth2client.gce.AppAssertionCredentials-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.discovery.Resource.__init__ |
| 244 | apiclient.discovery.ResourceMethodParameters.__init__ |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 245 | apiclient.errors.BatchError.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 246 | apiclient.errors.HttpError.__init__ |
| 247 | apiclient.errors.UnexpectedBodyError.__init__ |
| 248 | apiclient.errors.UnexpectedMethodError.__init__ |
| 249 | apiclient.http.BatchHttpRequest.__init__ |
| 250 | apiclient.http.HttpMock.__init__ |
| 251 | apiclient.http.HttpMockSequence.__init__ |
| 252 | apiclient.http.HttpRequest.__init__ |
| 253 | apiclient.http.HttpRequestMock.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 254 | apiclient.http.MediaDownloadProgress.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 255 | apiclient.http.MediaFileUpload.__init__ |
| 256 | apiclient.http.MediaInMemoryUpload.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 257 | apiclient.http.MediaIoBaseDownload.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 258 | apiclient.http.MediaIoBaseUpload.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 259 | apiclient.http.MediaUploadProgress.__init__ |
| 260 | apiclient.http.RequestMockBuilder.__init__ |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 261 | apiclient.http._StreamSlice.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 262 | apiclient.model.JsonModel.__init__ |
| 263 | apiclient.model.ProtocolBufferModel.__init__ |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 264 | apiclient.push.Channel.__init__ |
| 265 | apiclient.push.Headers.__init__ |
| 266 | apiclient.push.Subscription.__init__ |
| 267 | apiclient.push.WebhookChannel.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 268 | apiclient.schema.Schemas.__init__ |
| 269 | apiclient.schema._SchemaToStruct.__init__ |
| 270 | oauth2client.appengine.AppAssertionCredentials.__init__ |
| 271 | oauth2client.appengine.OAuth2Decorator.__init__ |
| 272 | oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| 273 | oauth2client.appengine.StorageByKeyName.__init__ |
| 274 | oauth2client.client.AccessTokenCredentials.__init__ |
| 275 | oauth2client.client.AssertionCredentials.__init__ |
| 276 | oauth2client.client.MemoryCache.__init__ |
| 277 | oauth2client.client.OAuth2Credentials.__init__ |
| 278 | oauth2client.client.OAuth2WebServerFlow.__init__ |
| 279 | oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 280 | oauth2client.django_orm.CredentialsField.__init__ |
| 281 | oauth2client.django_orm.FlowField.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 282 | oauth2client.django_orm.Storage.__init__ |
| 283 | oauth2client.file.Storage.__init__ |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 284 | oauth2client.gce.AppAssertionCredentials.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 285 | oauth2client.keyring_storage.Storage.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 286 | oauth2client.locked_file.LockedFile.__init__ |
| 287 | oauth2client.locked_file._Opener.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 288 | oauth2client.multistore_file._MultiStore._Storage.__init__ |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 289 | oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-82', '__init__', 'link-82');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt> |
| 290 | </div><a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> </tt> |
| 291 | <a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 292 | <a name="AppAssertionCredentials.from_json"></a><div id="AppAssertionCredentials.from_json-def"><a name="L168"></a><tt class="py-lineno">168</tt> <a class="py-toggle" href="#" id="AppAssertionCredentials.from_json-toggle" onclick="return toggle('AppAssertionCredentials.from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.AppAssertionCredentials-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">json</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 293 | </div><div id="AppAssertionCredentials.from_json-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="AppAssertionCredentials.from_json-expanded"><a name="L169"></a><tt class="py-lineno">169</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-83" 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-83', 'loads', 'link-83');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">json</tt><tt class="py-op">)</tt> </tt> |
| 294 | <a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-84" class="py-name"><a title="oauth2client.appengine.AppAssertionCredentials |
| 295 | oauth2client.gce.AppAssertionCredentials" class="py-name" href="#" onclick="return doclink('link-84', 'AppAssertionCredentials', 'link-81');">AppAssertionCredentials</a></tt><tt class="py-op">(</tt><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> |
| 296 | </div><a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> </tt> |
| 297 | <a name="AppAssertionCredentials._refresh"></a><div id="AppAssertionCredentials._refresh-def"><a name="L172"></a><tt class="py-lineno">172</tt> <a class="py-toggle" href="#" id="AppAssertionCredentials._refresh-toggle" onclick="return toggle('AppAssertionCredentials._refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.AppAssertionCredentials-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> |
| 298 | </div><div id="AppAssertionCredentials._refresh-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="AppAssertionCredentials._refresh-expanded"><a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-docstring">"""Refreshes the access_token.</tt> </tt> |
| 299 | <a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 300 | <a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> Since the underlying App Engine app_identity implementation does its own</tt> </tt> |
| 301 | <a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"> caching we can skip all the storage hoops and just to a refresh using the</tt> </tt> |
| 302 | <a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> API.</tt> </tt> |
| 303 | <a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 304 | <a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 305 | <a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"><tt class="py-docstring"> http_request: callable, a callable that matches the method signature of</tt> </tt> |
| 306 | <a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"><tt class="py-docstring"> httplib2.Http.request, used to make the refresh request.</tt> </tt> |
| 307 | <a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 308 | <a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 309 | <a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-docstring"> AccessTokenRefreshError: When the refresh fails.</tt> </tt> |
| 310 | <a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 311 | <a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 312 | <a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-name">scopes</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 class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 313 | <a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">app_identity</tt><tt class="py-op">.</tt><tt class="py-name">get_access_token</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">)</tt> </tt> |
| 314 | <a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">app_identity</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name" targets="Class apiclient.errors.Error=apiclient.errors.Error-class.html,Class oauth2client.client.Error=oauth2client.client.Error-class.html,Class oauth2client.clientsecrets.Error=oauth2client.clientsecrets.Error-class.html,Class oauth2client.multistore_file.Error=oauth2client.multistore_file.Error-class.html"><a title="apiclient.errors.Error |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 315 | oauth2client.client.Error |
| 316 | oauth2client.clientsecrets.Error |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 317 | oauth2client.multistore_file.Error" class="py-name" href="#" onclick="return doclink('link-85', 'Error', 'link-85');">Error</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt> |
| 318 | <a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-86" class="py-name"><a title="oauth2client.client.AccessTokenRefreshError" class="py-name" href="#" onclick="return doclink('link-86', 'AccessTokenRefreshError', 'link-29');">AccessTokenRefreshError</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 319 | <a name="L191"></a><tt class="py-lineno">191</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">token</tt> </tt> |
| 320 | </div></div><a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> </tt> |
| 321 | <a name="FlowProperty"></a><div id="FlowProperty-def"><a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> </tt> |
| 322 | <a name="L194"></a><tt class="py-lineno">194</tt> <a class="py-toggle" href="#" id="FlowProperty-toggle" onclick="return toggle('FlowProperty');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.FlowProperty-class.html">FlowProperty</a><tt class="py-op">(</tt><tt class="py-base-class">db</tt><tt class="py-op">.</tt><tt class="py-base-class">Property</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 323 | </div><div id="FlowProperty-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="FlowProperty-expanded"><a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-docstring">"""App Engine datastore Property for Flow.</tt> </tt> |
| 324 | <a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 325 | <a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"> Utility property that allows easy storage and retrieval of an</tt> </tt> |
| 326 | <a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.Flow"""</tt> </tt> |
| 327 | <a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> </tt> |
| 328 | <a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-comment"># Tell what the user type is.</tt> </tt> |
| 329 | <a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt id="link-87" class="py-name" targets="Variable oauth2client.appengine.CredentialsProperty.data_type=oauth2client.appengine.CredentialsProperty-class.html#data_type,Variable oauth2client.appengine.FlowProperty.data_type=oauth2client.appengine.FlowProperty-class.html#data_type"><a title="oauth2client.appengine.CredentialsProperty.data_type |
| 330 | oauth2client.appengine.FlowProperty.data_type" class="py-name" href="#" onclick="return doclink('link-87', 'data_type', 'link-87');">data_type</a></tt> <tt class="py-op">=</tt> <tt id="link-88" class="py-name"><a title="oauth2client.client.Flow" class="py-name" href="#" onclick="return doclink('link-88', 'Flow', 'link-38');">Flow</a></tt> </tt> |
| 331 | <a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> </tt> |
| 332 | <a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-comment"># For writing to datastore.</tt> </tt> |
| 333 | <a name="FlowProperty.get_value_for_datastore"></a><div id="FlowProperty.get_value_for_datastore-def"><a name="L204"></a><tt class="py-lineno">204</tt> <a class="py-toggle" href="#" id="FlowProperty.get_value_for_datastore-toggle" onclick="return toggle('FlowProperty.get_value_for_datastore');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore">get_value_for_datastore</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">model_instance</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 334 | </div><div id="FlowProperty.get_value_for_datastore-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="FlowProperty.get_value_for_datastore-expanded"><a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-name">flow</tt> <tt class="py-op">=</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-89" class="py-name" targets="Class oauth2client.appengine.FlowProperty=oauth2client.appengine.FlowProperty-class.html"><a title="oauth2client.appengine.FlowProperty" class="py-name" href="#" onclick="return doclink('link-89', 'FlowProperty', 'link-89');">FlowProperty</a></tt><tt class="py-op">,</tt> </tt> |
| 335 | <a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name" targets="Method oauth2client.appengine.CredentialsProperty.get_value_for_datastore()=oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore,Method oauth2client.appengine.FlowProperty.get_value_for_datastore()=oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore"><a title="oauth2client.appengine.CredentialsProperty.get_value_for_datastore |
| 336 | oauth2client.appengine.FlowProperty.get_value_for_datastore" class="py-name" href="#" onclick="return doclink('link-90', 'get_value_for_datastore', 'link-90');">get_value_for_datastore</a></tt><tt class="py-op">(</tt><tt class="py-name">model_instance</tt><tt class="py-op">)</tt> </tt> |
| 337 | <a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">Blob</tt><tt class="py-op">(</tt><tt class="py-name">pickle</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">flow</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 338 | </div><a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> </tt> |
| 339 | <a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-comment"># For reading from datastore.</tt> </tt> |
| 340 | <a name="FlowProperty.make_value_from_datastore"></a><div id="FlowProperty.make_value_from_datastore-def"><a name="L210"></a><tt class="py-lineno">210</tt> <a class="py-toggle" href="#" id="FlowProperty.make_value_from_datastore-toggle" onclick="return toggle('FlowProperty.make_value_from_datastore');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.FlowProperty-class.html#make_value_from_datastore">make_value_from_datastore</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 341 | </div><div id="FlowProperty.make_value_from_datastore-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="FlowProperty.make_value_from_datastore-expanded"><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 342 | <a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> |
| 343 | <a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">pickle</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="oauth2client.clientsecrets.loads" class="py-name" href="#" onclick="return doclink('link-91', 'loads', 'link-83');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| 344 | </div><a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> </tt> |
| 345 | <a name="FlowProperty.validate"></a><div id="FlowProperty.validate-def"><a name="L215"></a><tt class="py-lineno">215</tt> <a class="py-toggle" href="#" id="FlowProperty.validate-toggle" onclick="return toggle('FlowProperty.validate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.FlowProperty-class.html#validate">validate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 346 | </div><div id="FlowProperty.validate-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="FlowProperty.validate-expanded"><a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-92" class="py-name"><a title="oauth2client.client.Flow" class="py-name" href="#" onclick="return doclink('link-92', 'Flow', 'link-38');">Flow</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 347 | <a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">BadValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Property %s must be convertible '</tt> </tt> |
| 348 | <a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-string">'to a FlowThreeLegged instance (%s)'</tt> <tt class="py-op">%</tt> </tt> |
| 349 | <a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 350 | <a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-93" class="py-name"><a title="oauth2client.appengine.FlowProperty" class="py-name" href="#" onclick="return doclink('link-93', 'FlowProperty', 'link-89');">FlowProperty</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-94" class="py-name" targets="Method oauth2client.appengine.CredentialsProperty.validate()=oauth2client.appengine.CredentialsProperty-class.html#validate,Method oauth2client.appengine.FlowProperty.validate()=oauth2client.appengine.FlowProperty-class.html#validate"><a title="oauth2client.appengine.CredentialsProperty.validate |
| 351 | oauth2client.appengine.FlowProperty.validate" class="py-name" href="#" onclick="return doclink('link-94', 'validate', 'link-94');">validate</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| 352 | </div><a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> </tt> |
| 353 | <a name="FlowProperty.empty"></a><div id="FlowProperty.empty-def"><a name="L222"></a><tt class="py-lineno">222</tt> <a class="py-toggle" href="#" id="FlowProperty.empty-toggle" onclick="return toggle('FlowProperty.empty');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.FlowProperty-class.html#empty">empty</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 354 | </div><div id="FlowProperty.empty-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="FlowProperty.empty-expanded"><a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt class="py-name">value</tt> </tt> |
| 355 | </div></div><a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> </tt> |
| 356 | <a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> </tt> |
| 357 | <a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt id="link-95" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-95', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 358 | <a name="FlowNDBProperty"></a><div id="FlowNDBProperty-def"><a name="L227"></a><tt class="py-lineno">227</tt> <a class="py-toggle" href="#" id="FlowNDBProperty-toggle" onclick="return toggle('FlowNDBProperty');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.FlowNDBProperty-class.html">FlowNDBProperty</a><tt class="py-op">(</tt><tt class="py-base-class">ndb</tt><tt class="py-op">.</tt><tt class="py-base-class">PickleProperty</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 359 | </div><div id="FlowNDBProperty-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="FlowNDBProperty-expanded"><a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-docstring">"""App Engine NDB datastore Property for Flow.</tt> </tt> |
| 360 | <a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 361 | <a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"><tt class="py-docstring"> Serves the same purpose as the DB FlowProperty, but for NDB models. Since</tt> </tt> |
| 362 | <a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"><tt class="py-docstring"> PickleProperty inherits from BlobProperty, the underlying representation of</tt> </tt> |
| 363 | <a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"> the data in the datastore will be the same as in the DB case.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 364 | <a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 365 | <a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> Utility property that allows easy storage and retrieval of an</tt> </tt> |
| 366 | <a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.Flow</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 367 | <a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 368 | <a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> </tt> |
| 369 | <a name="FlowNDBProperty._validate"></a><div id="FlowNDBProperty._validate-def"><a name="L238"></a><tt class="py-lineno">238</tt> <a class="py-toggle" href="#" id="FlowNDBProperty._validate-toggle" onclick="return toggle('FlowNDBProperty._validate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.FlowNDBProperty-class.html#_validate">_validate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 370 | </div><div id="FlowNDBProperty._validate-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="FlowNDBProperty._validate-expanded"><a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-docstring">"""Validates a value as a proper Flow object.</tt> </tt> |
| 371 | <a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 372 | <a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 373 | <a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> value: A value to be set on the property.</tt> </tt> |
| 374 | <a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 375 | <a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 376 | <a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> TypeError if the value is not an instance of Flow.</tt> </tt> |
| 377 | <a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 378 | <a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt id="link-96" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 379 | oauth2client.appengine.logger |
| 380 | oauth2client.client.logger |
| 381 | oauth2client.crypt.logger |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 382 | oauth2client.gce.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 383 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 384 | oauth2client.multistore_file.logger |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 385 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-96', 'logger', 'link-49');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'validate: Got type %s'</tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 386 | <a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-97" class="py-name"><a title="oauth2client.client.Flow" class="py-name" href="#" onclick="return doclink('link-97', 'Flow', 'link-38');">Flow</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 387 | <a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Property %s must be convertible to a flow '</tt> </tt> |
| 388 | <a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-string">'instance; received: %s.'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 389 | </div></div><a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> </tt> |
| 390 | <a name="CredentialsProperty"></a><div id="CredentialsProperty-def"><a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> </tt> |
| 391 | <a name="L253"></a><tt class="py-lineno">253</tt> <a class="py-toggle" href="#" id="CredentialsProperty-toggle" onclick="return toggle('CredentialsProperty');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsProperty-class.html">CredentialsProperty</a><tt class="py-op">(</tt><tt class="py-base-class">db</tt><tt class="py-op">.</tt><tt class="py-base-class">Property</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 392 | </div><div id="CredentialsProperty-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CredentialsProperty-expanded"><a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-docstring">"""App Engine datastore Property for Credentials.</tt> </tt> |
| 393 | <a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 394 | <a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"><tt class="py-docstring"> Utility property that allows easy storage and retrieval of</tt> </tt> |
| 395 | <a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"> oath2client.Credentials</tt> </tt> |
| 396 | <a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 397 | <a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> </tt> |
| 398 | <a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-comment"># Tell what the user type is.</tt> </tt> |
| 399 | <a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt id="link-98" class="py-name"><a title="oauth2client.appengine.CredentialsProperty.data_type |
| 400 | oauth2client.appengine.FlowProperty.data_type" class="py-name" href="#" onclick="return doclink('link-98', 'data_type', 'link-87');">data_type</a></tt> <tt class="py-op">=</tt> <tt id="link-99" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-99', 'Credentials', 'link-35');">Credentials</a></tt> </tt> |
| 401 | <a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> </tt> |
| 402 | <a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-comment"># For writing to datastore.</tt> </tt> |
| 403 | <a name="CredentialsProperty.get_value_for_datastore"></a><div id="CredentialsProperty.get_value_for_datastore-def"><a name="L264"></a><tt class="py-lineno">264</tt> <a class="py-toggle" href="#" id="CredentialsProperty.get_value_for_datastore-toggle" onclick="return toggle('CredentialsProperty.get_value_for_datastore');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsProperty-class.html#get_value_for_datastore">get_value_for_datastore</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">model_instance</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 404 | </div><div id="CredentialsProperty.get_value_for_datastore-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="CredentialsProperty.get_value_for_datastore-expanded"><a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 405 | oauth2client.appengine.logger |
| 406 | oauth2client.client.logger |
| 407 | oauth2client.crypt.logger |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 408 | oauth2client.gce.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 409 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 410 | oauth2client.multistore_file.logger |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 411 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-100', 'logger', 'link-49');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"get: Got type "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">model_instance</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 412 | <a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-name">cred</tt> <tt class="py-op">=</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-101" class="py-name" targets="Class oauth2client.appengine.CredentialsProperty=oauth2client.appengine.CredentialsProperty-class.html"><a title="oauth2client.appengine.CredentialsProperty" class="py-name" href="#" onclick="return doclink('link-101', 'CredentialsProperty', 'link-101');">CredentialsProperty</a></tt><tt class="py-op">,</tt> </tt> |
| 413 | <a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="oauth2client.appengine.CredentialsProperty.get_value_for_datastore |
| 414 | oauth2client.appengine.FlowProperty.get_value_for_datastore" class="py-name" href="#" onclick="return doclink('link-102', 'get_value_for_datastore', 'link-90');">get_value_for_datastore</a></tt><tt class="py-op">(</tt><tt class="py-name">model_instance</tt><tt class="py-op">)</tt> </tt> |
| 415 | <a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cred</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 416 | <a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-name">cred</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt> |
| 417 | <a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 418 | <a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-name">cred</tt> <tt class="py-op">=</tt> <tt class="py-name">cred</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name" targets="Method apiclient.http.HttpRequest.to_json()=apiclient.http.HttpRequest-class.html#to_json,Method apiclient.http.MediaFileUpload.to_json()=apiclient.http.MediaFileUpload-class.html#to_json,Method apiclient.http.MediaIoBaseUpload.to_json()=apiclient.http.MediaIoBaseUpload-class.html#to_json,Method apiclient.http.MediaUpload.to_json()=apiclient.http.MediaUpload-class.html#to_json,Method oauth2client.client.Credentials.to_json()=oauth2client.client.Credentials-class.html#to_json,Method oauth2client.client.OAuth2Credentials.to_json()=oauth2client.client.OAuth2Credentials-class.html#to_json"><a title="apiclient.http.HttpRequest.to_json |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 419 | apiclient.http.MediaFileUpload.to_json |
| 420 | apiclient.http.MediaIoBaseUpload.to_json |
| 421 | apiclient.http.MediaUpload.to_json |
| 422 | oauth2client.client.Credentials.to_json |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 423 | oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-103', 'to_json', 'link-103');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 424 | <a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">Blob</tt><tt class="py-op">(</tt><tt class="py-name">cred</tt><tt class="py-op">)</tt> </tt> |
| 425 | </div><a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> </tt> |
| 426 | <a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-comment"># For reading from datastore.</tt> </tt> |
| 427 | <a name="CredentialsProperty.make_value_from_datastore"></a><div id="CredentialsProperty.make_value_from_datastore-def"><a name="L275"></a><tt class="py-lineno">275</tt> <a class="py-toggle" href="#" id="CredentialsProperty.make_value_from_datastore-toggle" onclick="return toggle('CredentialsProperty.make_value_from_datastore');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsProperty-class.html#make_value_from_datastore">make_value_from_datastore</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 428 | </div><div id="CredentialsProperty.make_value_from_datastore-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="CredentialsProperty.make_value_from_datastore-expanded"><a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt id="link-104" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 429 | oauth2client.appengine.logger |
| 430 | oauth2client.client.logger |
| 431 | oauth2client.crypt.logger |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 432 | oauth2client.gce.logger |
| Joe Gregorio | e7a0c47 | 2012-07-12 11:46:04 -0400 | [diff] [blame] | 433 | oauth2client.locked_file.logger |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 434 | oauth2client.multistore_file.logger |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 435 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-104', 'logger', 'link-49');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"make: Got type "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 436 | <a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 437 | <a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> |
| 438 | <a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt> |
| 439 | <a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> |
| 440 | <a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 441 | <a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt id="link-105" class="py-name" targets="Variable oauth2client.appengine.CredentialsModel.credentials=oauth2client.appengine.CredentialsModel-class.html#credentials,Variable oauth2client.appengine.CredentialsNDBModel.credentials=oauth2client.appengine.CredentialsNDBModel-class.html#credentials"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 442 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-105', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-106" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-106', 'Credentials', 'link-35');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-107" class="py-name" targets="Class Method apiclient.http.MediaUpload.new_from_json()=apiclient.http.MediaUpload-class.html#new_from_json,Class Method oauth2client.client.Credentials.new_from_json()=oauth2client.client.Credentials-class.html#new_from_json"><a title="apiclient.http.MediaUpload.new_from_json |
| 443 | oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick="return doclink('link-107', 'new_from_json', 'link-107');">new_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| 444 | <a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt> |
| 445 | <a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt id="link-108" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 446 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-108', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 447 | <a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-109" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 448 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-109', 'credentials', 'link-105');">credentials</a></tt> </tt> |
| 449 | </div><a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> </tt> |
| 450 | <a name="CredentialsProperty.validate"></a><div id="CredentialsProperty.validate-def"><a name="L287"></a><tt class="py-lineno">287</tt> <a class="py-toggle" href="#" id="CredentialsProperty.validate-toggle" onclick="return toggle('CredentialsProperty.validate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsProperty-class.html#validate">validate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 451 | </div><div id="CredentialsProperty.validate-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="CredentialsProperty.validate-expanded"><a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-110" class="py-name"><a title="oauth2client.appengine.CredentialsProperty" class="py-name" href="#" onclick="return doclink('link-110', 'CredentialsProperty', 'link-101');">CredentialsProperty</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-111" class="py-name"><a title="oauth2client.appengine.CredentialsProperty.validate |
| 452 | oauth2client.appengine.FlowProperty.validate" class="py-name" href="#" onclick="return doclink('link-111', 'validate', 'link-94');">validate</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| 453 | <a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt id="link-112" class="py-name"><a title="apiclient.discovery.logger |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 454 | oauth2client.appengine.logger |
| 455 | oauth2client.client.logger |
| 456 | oauth2client.crypt.logger |
| 457 | oauth2client.gce.logger |
| 458 | oauth2client.locked_file.logger |
| 459 | oauth2client.multistore_file.logger |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 460 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-112', 'logger', 'link-49');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"validate: Got type "</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 461 | <a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-113" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-113', 'Credentials', 'link-35');">Credentials</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 462 | <a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">BadValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Property %s must be convertible '</tt> </tt> |
| 463 | <a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-string">'to a Credentials instance (%s)'</tt> <tt class="py-op">%</tt> </tt> |
| 464 | <a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 465 | <a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-comment">#if value is not None and not isinstance(value, Credentials):</tt> </tt> |
| 466 | <a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-comment"># return None</tt> </tt> |
| 467 | <a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt> |
| 468 | </div></div><a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> </tt> |
| 469 | <a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> </tt> |
| 470 | <a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt id="link-114" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-114', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 471 | <a name="CredentialsNDBProperty"></a><div id="CredentialsNDBProperty-def"><a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-comment"># TODO(dhermes): Turn this into a JsonProperty and overhaul the Credentials</tt> </tt> |
| 472 | <a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> <tt class="py-comment"># and subclass mechanics to use new_from_dict, to_dict,</tt> </tt> |
| 473 | <a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-comment"># from_dict, etc.</tt> </tt> |
| 474 | <a name="L303"></a><tt class="py-lineno">303</tt> <a class="py-toggle" href="#" id="CredentialsNDBProperty-toggle" onclick="return toggle('CredentialsNDBProperty');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBProperty-class.html">CredentialsNDBProperty</a><tt class="py-op">(</tt><tt class="py-base-class">ndb</tt><tt class="py-op">.</tt><tt class="py-base-class">BlobProperty</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 475 | </div><div id="CredentialsNDBProperty-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="CredentialsNDBProperty-expanded"><a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-docstring">"""App Engine NDB datastore Property for Credentials.</tt> </tt> |
| 476 | <a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 477 | <a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"><tt class="py-docstring"> Serves the same purpose as the DB CredentialsProperty, but for NDB models.</tt> </tt> |
| 478 | <a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"><tt class="py-docstring"> Since CredentialsProperty stores data as a blob and this inherits from</tt> </tt> |
| 479 | <a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"> BlobProperty, the data in the datastore will be the same as in the DB case.</tt> </tt> |
| 480 | <a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 481 | <a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"> Utility property that allows easy storage and retrieval of Credentials and</tt> </tt> |
| 482 | <a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> subclasses.</tt> </tt> |
| 483 | <a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 484 | <a name="CredentialsNDBProperty._validate"></a><div id="CredentialsNDBProperty._validate-def"><a name="L313"></a><tt class="py-lineno">313</tt> <a class="py-toggle" href="#" id="CredentialsNDBProperty._validate-toggle" onclick="return toggle('CredentialsNDBProperty._validate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBProperty-class.html#_validate">_validate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 485 | </div><div id="CredentialsNDBProperty._validate-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="CredentialsNDBProperty._validate-expanded"><a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-docstring">"""Validates a value as a proper credentials object.</tt> </tt> |
| 486 | <a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 487 | <a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 488 | <a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"><tt class="py-docstring"> value: A value to be set on the property.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 489 | <a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 490 | <a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 491 | <a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> TypeError if the value is not an instance of Credentials.</tt> </tt> |
| 492 | <a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 493 | <a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt id="link-115" class="py-name"><a title="apiclient.discovery.logger |
| 494 | oauth2client.appengine.logger |
| 495 | oauth2client.client.logger |
| 496 | oauth2client.crypt.logger |
| 497 | oauth2client.gce.logger |
| 498 | oauth2client.locked_file.logger |
| 499 | oauth2client.multistore_file.logger |
| 500 | oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-115', 'logger', 'link-49');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'validate: Got type %s'</tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 501 | <a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-116" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-116', 'Credentials', 'link-35');">Credentials</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 502 | <a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Property %s must be convertible to a credentials '</tt> </tt> |
| 503 | <a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> <tt class="py-string">'instance; received: %s.'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 504 | </div><a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> </tt> |
| 505 | <a name="CredentialsNDBProperty._to_base_type"></a><div id="CredentialsNDBProperty._to_base_type-def"><a name="L327"></a><tt class="py-lineno">327</tt> <a class="py-toggle" href="#" id="CredentialsNDBProperty._to_base_type-toggle" onclick="return toggle('CredentialsNDBProperty._to_base_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBProperty-class.html#_to_base_type">_to_base_type</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 506 | </div><div id="CredentialsNDBProperty._to_base_type-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="CredentialsNDBProperty._to_base_type-expanded"><a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts our validated value to a JSON serialized string.</tt> </tt> |
| 507 | <a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 508 | <a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 509 | <a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"> value: A value to be set in the datastore.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 510 | <a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 511 | <a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 512 | <a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"><tt class="py-docstring"> A JSON serialized version of the credential, else '' if value is None.</tt> </tt> |
| 513 | <a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 514 | <a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 515 | <a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt> |
| 516 | <a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 517 | <a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="apiclient.http.HttpRequest.to_json |
| 518 | apiclient.http.MediaFileUpload.to_json |
| 519 | apiclient.http.MediaIoBaseUpload.to_json |
| 520 | apiclient.http.MediaUpload.to_json |
| 521 | oauth2client.client.Credentials.to_json |
| 522 | oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-117', 'to_json', 'link-103');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 523 | </div><a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> </tt> |
| 524 | <a name="CredentialsNDBProperty._from_base_type"></a><div id="CredentialsNDBProperty._from_base_type-def"><a name="L341"></a><tt class="py-lineno">341</tt> <a class="py-toggle" href="#" id="CredentialsNDBProperty._from_base_type-toggle" onclick="return toggle('CredentialsNDBProperty._from_base_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBProperty-class.html#_from_base_type">_from_base_type</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 525 | </div><div id="CredentialsNDBProperty._from_base_type-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="CredentialsNDBProperty._from_base_type-expanded"><a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-docstring">"""Converts our stored JSON string back to the desired type.</tt> </tt> |
| 526 | <a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 527 | <a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 528 | <a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"><tt class="py-docstring"> value: A value from the datastore to be converted to the desired type.</tt> </tt> |
| 529 | <a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 530 | <a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 531 | <a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"><tt class="py-docstring"> A deserialized Credentials (or subclass) object, else None if the</tt> </tt> |
| 532 | <a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"><tt class="py-docstring"> value can't be parsed.</tt> </tt> |
| 533 | <a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 534 | <a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">value</tt><tt class="py-op">:</tt> </tt> |
| 535 | <a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> |
| 536 | <a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 537 | <a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> <tt class="py-comment"># Uses the from_json method of the implied class of value</tt> </tt> |
| 538 | <a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt id="link-118" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 539 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-118', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-119" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-119', 'Credentials', 'link-35');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="apiclient.http.MediaUpload.new_from_json |
| 540 | oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick="return doclink('link-120', 'new_from_json', 'link-107');">new_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| 541 | <a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt> |
| 542 | <a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt id="link-121" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 543 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-121', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 544 | <a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-122" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 545 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-122', 'credentials', 'link-105');">credentials</a></tt> </tt> |
| 546 | </div></div><a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> </tt> |
| 547 | <a name="StorageByKeyName"></a><div id="StorageByKeyName-def"><a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> </tt> |
| 548 | <a name="L361"></a><tt class="py-lineno">361</tt> <a class="py-toggle" href="#" id="StorageByKeyName-toggle" onclick="return toggle('StorageByKeyName');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-class.html">StorageByKeyName</a><tt class="py-op">(</tt><tt class="py-base-class">Storage</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 549 | </div><div id="StorageByKeyName-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="StorageByKeyName-expanded"><a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-docstring">"""Store and retrieve a credential to and from the App Engine datastore.</tt> </tt> |
| 550 | <a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 551 | <a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"><tt class="py-docstring"> This Storage helper presumes the Credentials have been stored as a</tt> </tt> |
| 552 | <a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"><tt class="py-docstring"> CredentialsProperty or CredentialsNDBProperty on a datastore model class, and</tt> </tt> |
| 553 | <a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"><tt class="py-docstring"> that entities are stored by key_name.</tt> </tt> |
| 554 | <a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 555 | <a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> </tt> |
| 556 | <a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-123', 'positional', 'link-78');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt> |
| 557 | <a name="StorageByKeyName.__init__"></a><div id="StorageByKeyName.__init__-def"><a name="L370"></a><tt class="py-lineno">370</tt> <a class="py-toggle" href="#" id="StorageByKeyName.__init__-toggle" onclick="return toggle('StorageByKeyName.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-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">model</tt><tt class="py-op">,</tt> <tt class="py-param">key_name</tt><tt class="py-op">,</tt> <tt class="py-param">property_name</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> |
| 558 | </div><div id="StorageByKeyName.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName.__init__-expanded"><a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for Storage.</tt> </tt> |
| 559 | <a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 560 | <a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 561 | <a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"><tt class="py-docstring"> model: db.Model or ndb.Model, model class</tt> </tt> |
| 562 | <a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"><tt class="py-docstring"> key_name: string, key name for the entity that has the credentials</tt> </tt> |
| 563 | <a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"><tt class="py-docstring"> property_name: string, name of the property that is a CredentialsProperty</tt> </tt> |
| 564 | <a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"><tt class="py-docstring"> or CredentialsNDBProperty.</tt> </tt> |
| 565 | <a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"><tt class="py-docstring"> cache: memcache, a write-through cache to put in front of the datastore.</tt> </tt> |
| 566 | <a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-docstring"> If the model you are using is an NDB model, using a cache will be</tt> </tt> |
| 567 | <a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"> redundant since the model uses an instance cache and memcache for you.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 568 | <a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 569 | <a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt> <tt class="py-op">=</tt> <tt id="link-124" class="py-name"><a title="apiclient.model" class="py-name" href="#" onclick="return doclink('link-124', 'model', 'link-61');">model</a></tt> </tt> |
| 570 | <a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt> <tt class="py-op">=</tt> <tt class="py-name">key_name</tt> </tt> |
| 571 | <a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_property_name</tt> <tt class="py-op">=</tt> <tt class="py-name">property_name</tt> </tt> |
| 572 | <a name="L385"></a><tt class="py-lineno">385</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">cache</tt> </tt> |
| 573 | </div><a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> </tt> |
| 574 | <a name="StorageByKeyName._is_ndb"></a><div id="StorageByKeyName._is_ndb-def"><a name="L387"></a><tt class="py-lineno">387</tt> <a class="py-toggle" href="#" id="StorageByKeyName._is_ndb-toggle" onclick="return toggle('StorageByKeyName._is_ndb');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-class.html#_is_ndb">_is_ndb</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 575 | </div><div id="StorageByKeyName._is_ndb-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName._is_ndb-expanded"><a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> <tt class="py-docstring">"""Determine whether the model of the instance is an NDB model.</tt> </tt> |
| 576 | <a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 577 | <a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 578 | <a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"><tt class="py-docstring"> Boolean indicating whether or not the model is an NDB or DB model.</tt> </tt> |
| 579 | <a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 580 | <a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"> <tt class="py-comment"># issubclass will fail if one of the arguments is not a class, only need</tt> </tt> |
| 581 | <a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"> <tt class="py-comment"># worry about new-style classes since ndb and db models are new-style</tt> </tt> |
| 582 | <a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 583 | <a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-125" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-125', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt id="link-126" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-126', 'ndb', 'link-47');">ndb</a></tt><tt class="py-op">.</tt><tt id="link-127" class="py-name" targets="Class apiclient.model.Model=apiclient.model.Model-class.html"><a title="apiclient.model.Model" class="py-name" href="#" onclick="return doclink('link-127', 'Model', 'link-127');">Model</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 584 | <a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt> |
| 585 | <a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="apiclient.model.Model" class="py-name" href="#" onclick="return doclink('link-128', 'Model', 'link-127');">Model</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 586 | <a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt> |
| 587 | <a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> </tt> |
| 588 | <a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Model class not an NDB or DB model: %s.'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 589 | </div><a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> </tt> |
| 590 | <a name="StorageByKeyName._get_entity"></a><div id="StorageByKeyName._get_entity-def"><a name="L403"></a><tt class="py-lineno">403</tt> <a class="py-toggle" href="#" id="StorageByKeyName._get_entity-toggle" onclick="return toggle('StorageByKeyName._get_entity');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-class.html#_get_entity">_get_entity</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 591 | </div><div id="StorageByKeyName._get_entity-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName._get_entity-expanded"><a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieve entity from datastore.</tt> </tt> |
| 592 | <a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 593 | <a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"><tt class="py-docstring"> Uses a different model method for db or ndb models.</tt> </tt> |
| 594 | <a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 595 | <a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 596 | <a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"><tt class="py-docstring"> Instance of the model corresponding to the current storage object</tt> </tt> |
| 597 | <a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"><tt class="py-docstring"> and stored using the key name of the storage object.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 598 | <a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 599 | <a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName._is_ndb()=oauth2client.appengine.StorageByKeyName-class.html#_is_ndb"><a title="oauth2client.appengine.StorageByKeyName._is_ndb" class="py-name" href="#" onclick="return doclink('link-129', '_is_ndb', 'link-129');">_is_ndb</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 600 | <a name="L413"></a><tt class="py-lineno">413</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">_model</tt><tt class="py-op">.</tt><tt class="py-name">get_by_id</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 601 | <a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 602 | <a name="L415"></a><tt class="py-lineno">415</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">_model</tt><tt class="py-op">.</tt><tt class="py-name">get_by_key_name</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt> </tt> |
| 603 | </div><a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> </tt> |
| 604 | <a name="StorageByKeyName._delete_entity"></a><div id="StorageByKeyName._delete_entity-def"><a name="L417"></a><tt class="py-lineno">417</tt> <a class="py-toggle" href="#" id="StorageByKeyName._delete_entity-toggle" onclick="return toggle('StorageByKeyName._delete_entity');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-class.html#_delete_entity">_delete_entity</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 605 | </div><div id="StorageByKeyName._delete_entity-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName._delete_entity-expanded"><a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete entity from datastore.</tt> </tt> |
| 606 | <a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 607 | <a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"><tt class="py-docstring"> Attempts to delete using the key_name stored on the object, whether or not</tt> </tt> |
| 608 | <a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"><tt class="py-docstring"> the given key is in the datastore.</tt> </tt> |
| 609 | <a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 610 | <a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="oauth2client.appengine.StorageByKeyName._is_ndb" class="py-name" href="#" onclick="return doclink('link-130', '_is_ndb', 'link-129');">_is_ndb</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 611 | <a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"> <tt id="link-131" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-131', 'ndb', 'link-47');">ndb</a></tt><tt class="py-op">.</tt><tt class="py-name">Key</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name" targets="Method oauth2client.client.MemoryCache.delete()=oauth2client.client.MemoryCache-class.html#delete,Method oauth2client.client.Storage.delete()=oauth2client.client.Storage-class.html#delete"><a title="oauth2client.client.MemoryCache.delete |
| 612 | oauth2client.client.Storage.delete" class="py-name" href="#" onclick="return doclink('link-132', 'delete', 'link-132');">delete</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 613 | <a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 614 | <a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-name">entity_key</tt> <tt class="py-op">=</tt> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt class="py-name">Key</tt><tt class="py-op">.</tt><tt class="py-name">from_path</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">.</tt><tt class="py-name">kind</tt><tt class="py-op">(</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">_key_name</tt><tt class="py-op">)</tt> </tt> |
| 615 | <a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-name">db</tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="oauth2client.client.MemoryCache.delete |
| 616 | oauth2client.client.Storage.delete" class="py-name" href="#" onclick="return doclink('link-133', 'delete', 'link-132');">delete</a></tt><tt class="py-op">(</tt><tt class="py-name">entity_key</tt><tt class="py-op">)</tt> </tt> |
| 617 | </div><a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> </tt> |
| 618 | <a name="StorageByKeyName.locked_get"></a><div id="StorageByKeyName.locked_get-def"><a name="L429"></a><tt class="py-lineno">429</tt> <a class="py-toggle" href="#" id="StorageByKeyName.locked_get-toggle" onclick="return toggle('StorageByKeyName.locked_get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-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> |
| 619 | </div><div id="StorageByKeyName.locked_get-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName.locked_get-expanded"><a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieve Credential from datastore.</tt> </tt> |
| 620 | <a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 621 | <a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 622 | <a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.Credentials</tt> </tt> |
| 623 | <a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 624 | <a name="L435"></a><tt class="py-lineno">435</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">_cache</tt><tt class="py-op">:</tt> </tt> |
| 625 | <a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> <tt class="py-name">json</tt> <tt class="py-op">=</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-134" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 626 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 627 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-134', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt> </tt> |
| 628 | <a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">json</tt><tt class="py-op">:</tt> </tt> |
| 629 | <a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-135" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-135', 'Credentials', 'link-35');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="apiclient.http.MediaUpload.new_from_json |
| 630 | oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick="return doclink('link-136', 'new_from_json', 'link-107');">new_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">json</tt><tt class="py-op">)</tt> </tt> |
| 631 | <a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"> </tt> |
| 632 | <a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 633 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-137', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 634 | <a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-138" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName._get_entity()=oauth2client.appengine.StorageByKeyName-class.html#_get_entity"><a title="oauth2client.appengine.StorageByKeyName._get_entity" class="py-name" href="#" onclick="return doclink('link-138', '_get_entity', 'link-138');">_get_entity</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 635 | <a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">entity</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> |
| 636 | <a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"> <tt id="link-139" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 637 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-139', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_property_name</tt><tt class="py-op">)</tt> </tt> |
| 638 | <a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-140" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 639 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-140', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-141" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 640 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-141', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">,</tt> <tt class="py-string">'set_store'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 641 | <a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"> <tt id="link-142" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 642 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-142', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name" targets="Method oauth2client.client.OAuth2Credentials.set_store()=oauth2client.client.OAuth2Credentials-class.html#set_store"><a title="oauth2client.client.OAuth2Credentials.set_store" class="py-name" href="#" onclick="return doclink('link-143', 'set_store', 'link-143');">set_store</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| 643 | <a name="L446"></a><tt class="py-lineno">446</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">_cache</tt><tt class="py-op">:</tt> </tt> |
| 644 | <a name="L447"></a><tt class="py-lineno">447</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 id="link-144" class="py-name" targets="Method oauth2client.client.MemoryCache.set()=oauth2client.client.MemoryCache-class.html#set"><a title="oauth2client.client.MemoryCache.set" class="py-name" href="#" onclick="return doclink('link-144', 'set', 'link-144');">set</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">,</tt> <tt id="link-145" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 645 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-145', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="apiclient.http.HttpRequest.to_json |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 646 | apiclient.http.MediaFileUpload.to_json |
| 647 | apiclient.http.MediaIoBaseUpload.to_json |
| 648 | apiclient.http.MediaUpload.to_json |
| 649 | oauth2client.client.Credentials.to_json |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 650 | oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-146', 'to_json', 'link-103');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 651 | <a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> </tt> |
| 652 | <a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-147" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 653 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-147', 'credentials', 'link-105');">credentials</a></tt> </tt> |
| 654 | </div><a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> </tt> |
| 655 | <a name="StorageByKeyName.locked_put"></a><div id="StorageByKeyName.locked_put-def"><a name="L451"></a><tt class="py-lineno">451</tt> <a class="py-toggle" href="#" id="StorageByKeyName.locked_put-toggle" onclick="return toggle('StorageByKeyName.locked_put');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-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> |
| 656 | </div><div id="StorageByKeyName.locked_put-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName.locked_put-expanded"><a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> <tt class="py-docstring">"""Write a Credentials to the datastore.</tt> </tt> |
| 657 | <a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 658 | <a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 659 | <a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"><tt class="py-docstring"> credentials: Credentials, the credentials to store.</tt> </tt> |
| 660 | <a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 661 | <a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"> <tt class="py-name">entity</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_model</tt><tt class="py-op">.</tt><tt class="py-name">get_or_insert</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt> </tt> |
| 662 | <a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"> <tt class="py-name">setattr</tt><tt class="py-op">(</tt><tt class="py-name">entity</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_property_name</tt><tt class="py-op">,</tt> <tt id="link-148" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 663 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-148', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">)</tt> </tt> |
| 664 | <a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"> <tt class="py-name">entity</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="oauth2client.client.Storage.put" class="py-name" href="#" onclick="return doclink('link-149', 'put', 'link-69');">put</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 665 | <a name="L460"></a><tt class="py-lineno">460</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">_cache</tt><tt class="py-op">:</tt> </tt> |
| 666 | <a name="L461"></a><tt class="py-lineno">461</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 id="link-150" class="py-name"><a title="oauth2client.client.MemoryCache.set" class="py-name" href="#" onclick="return doclink('link-150', 'set', 'link-144');">set</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">,</tt> <tt id="link-151" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 667 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-151', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="apiclient.http.HttpRequest.to_json |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 668 | apiclient.http.MediaFileUpload.to_json |
| 669 | apiclient.http.MediaIoBaseUpload.to_json |
| 670 | apiclient.http.MediaUpload.to_json |
| 671 | oauth2client.client.Credentials.to_json |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 672 | oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-152', 'to_json', 'link-103');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 673 | </div><a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"> </tt> |
| 674 | <a name="StorageByKeyName.locked_delete"></a><div id="StorageByKeyName.locked_delete-def"><a name="L463"></a><tt class="py-lineno">463</tt> <a class="py-toggle" href="#" id="StorageByKeyName.locked_delete-toggle" onclick="return toggle('StorageByKeyName.locked_delete');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.StorageByKeyName-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> |
| 675 | </div><div id="StorageByKeyName.locked_delete-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="StorageByKeyName.locked_delete-expanded"><a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete Credential from datastore."""</tt> </tt> |
| 676 | <a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> </tt> |
| 677 | <a name="L466"></a><tt class="py-lineno">466</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">_cache</tt><tt class="py-op">:</tt> </tt> |
| 678 | <a name="L467"></a><tt class="py-lineno">467</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 id="link-153" class="py-name"><a title="oauth2client.client.MemoryCache.delete |
| 679 | oauth2client.client.Storage.delete" class="py-name" href="#" onclick="return doclink('link-153', 'delete', 'link-132');">delete</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key_name</tt><tt class="py-op">)</tt> </tt> |
| 680 | <a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"> </tt> |
| 681 | <a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name" targets="Method oauth2client.appengine.StorageByKeyName._delete_entity()=oauth2client.appengine.StorageByKeyName-class.html#_delete_entity"><a title="oauth2client.appengine.StorageByKeyName._delete_entity" class="py-name" href="#" onclick="return doclink('link-154', '_delete_entity', 'link-154');">_delete_entity</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 682 | </div></div><a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"> </tt> |
| 683 | <a name="CredentialsModel"></a><div id="CredentialsModel-def"><a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"> </tt> |
| 684 | <a name="L472"></a><tt class="py-lineno">472</tt> <a class="py-toggle" href="#" id="CredentialsModel-toggle" onclick="return toggle('CredentialsModel');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsModel-class.html">CredentialsModel</a><tt class="py-op">(</tt><tt class="py-base-class">db</tt><tt class="py-op">.</tt><tt class="py-base-class">Model</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 685 | </div><div id="CredentialsModel-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CredentialsModel-expanded"><a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"> <tt class="py-docstring">"""Storage for OAuth 2.0 Credentials</tt> </tt> |
| 686 | <a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 687 | <a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"><tt class="py-docstring"> Storage of the model is keyed by the user.user_id().</tt> </tt> |
| 688 | <a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 689 | <a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"> <tt id="link-155" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 690 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-155', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-156" class="py-name"><a title="oauth2client.appengine.CredentialsProperty" class="py-name" href="#" onclick="return doclink('link-156', 'CredentialsProperty', 'link-101');">CredentialsProperty</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 691 | </div><a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"> </tt> |
| 692 | <a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"> </tt> |
| 693 | <a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"><tt class="py-keyword">if</tt> <tt id="link-157" class="py-name"><a title="oauth2client.appengine.ndb" class="py-name" href="#" onclick="return doclink('link-157', 'ndb', 'link-47');">ndb</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 694 | <a name="CredentialsNDBModel"></a><div id="CredentialsNDBModel-def"><a name="L481"></a><tt class="py-lineno">481</tt> <a class="py-toggle" href="#" id="CredentialsNDBModel-toggle" onclick="return toggle('CredentialsNDBModel');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBModel-class.html">CredentialsNDBModel</a><tt class="py-op">(</tt><tt class="py-base-class">ndb</tt><tt class="py-op">.</tt><tt class="py-base-class">Model</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 695 | </div><div id="CredentialsNDBModel-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="CredentialsNDBModel-expanded"><a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"> <tt class="py-docstring">"""NDB Model for storage of OAuth 2.0 Credentials</tt> </tt> |
| 696 | <a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 697 | <a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"><tt class="py-docstring"> Since this model uses the same kind as CredentialsModel and has a property</tt> </tt> |
| 698 | <a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"><tt class="py-docstring"> which can serialize and deserialize Credentials correctly, it can be used</tt> </tt> |
| 699 | <a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"><tt class="py-docstring"> interchangeably with a CredentialsModel to access, insert and delete the</tt> </tt> |
| 700 | <a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"><tt class="py-docstring"> same entities. This simply provides an NDB model for interacting with the</tt> </tt> |
| 701 | <a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"><tt class="py-docstring"> same data the DB model interacts with.</tt> </tt> |
| 702 | <a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 703 | <a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"><tt class="py-docstring"> Storage of the model is keyed by the user.user_id().</tt> </tt> |
| 704 | <a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 705 | <a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"> <tt id="link-158" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 706 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-158', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-159" class="py-name" targets="Class oauth2client.appengine.CredentialsNDBProperty=oauth2client.appengine.CredentialsNDBProperty-class.html"><a title="oauth2client.appengine.CredentialsNDBProperty" class="py-name" href="#" onclick="return doclink('link-159', 'CredentialsNDBProperty', 'link-159');">CredentialsNDBProperty</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 707 | <a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"> </tt> |
| 708 | <a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| 709 | <a name="CredentialsNDBModel._get_kind"></a><div id="CredentialsNDBModel._get_kind-def"><a name="L495"></a><tt class="py-lineno">495</tt> <a class="py-toggle" href="#" id="CredentialsNDBModel._get_kind-toggle" onclick="return toggle('CredentialsNDBModel._get_kind');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.CredentialsNDBModel-class.html#_get_kind">_get_kind</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 710 | </div><div id="CredentialsNDBModel._get_kind-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="CredentialsNDBModel._get_kind-expanded"><a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the kind name for this class."""</tt> </tt> |
| 711 | <a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'CredentialsModel'</tt> </tt> |
| 712 | </div></div><a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"> </tt> |
| 713 | <a name="_build_state_value"></a><div id="_build_state_value-def"><a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"> </tt> |
| 714 | <a name="L500"></a><tt class="py-lineno">500</tt> <a class="py-toggle" href="#" id="_build_state_value-toggle" onclick="return toggle('_build_state_value');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#_build_state_value">_build_state_value</a><tt class="py-op">(</tt><tt class="py-param">request_handler</tt><tt class="py-op">,</tt> <tt class="py-param">user</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 715 | </div><div id="_build_state_value-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_build_state_value-expanded"><a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"> <tt class="py-docstring">"""Composes the value for the 'state' parameter.</tt> </tt> |
| 716 | <a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 717 | <a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"><tt class="py-docstring"> Packs the current request URI and an XSRF token into an opaque string that</tt> </tt> |
| 718 | <a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"><tt class="py-docstring"> can be passed to the authentication server via the 'state' parameter.</tt> </tt> |
| 719 | <a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 720 | <a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 721 | <a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"><tt class="py-docstring"> request_handler: webapp.RequestHandler, The request.</tt> </tt> |
| 722 | <a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"><tt class="py-docstring"> user: google.appengine.api.users.User, The current user.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 723 | <a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 724 | <a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 725 | <a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"><tt class="py-docstring"> The state value as a string.</tt> </tt> |
| 726 | <a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 727 | <a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name" targets="Method apiclient.http.HttpMock.request()=apiclient.http.HttpMock-class.html#request,Method apiclient.http.HttpMockSequence.request()=apiclient.http.HttpMockSequence-class.html#request,Method apiclient.model.BaseModel.request()=apiclient.model.BaseModel-class.html#request,Method apiclient.model.Model.request()=apiclient.model.Model-class.html#request"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 728 | apiclient.http.HttpMockSequence.request |
| 729 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 730 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-160', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">url</tt> </tt> |
| 731 | <a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"> <tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt id="link-161" class="py-name"><a title="oauth2client.xsrfutil" class="py-name" href="#" onclick="return doclink('link-161', 'xsrfutil', 'link-24');">xsrfutil</a></tt><tt class="py-op">.</tt><tt id="link-162" class="py-name" targets="Function oauth2client.xsrfutil.generate_token()=oauth2client.xsrfutil-module.html#generate_token"><a title="oauth2client.xsrfutil.generate_token" class="py-name" href="#" onclick="return doclink('link-162', 'generate_token', 'link-162');">generate_token</a></tt><tt class="py-op">(</tt><tt id="link-163" class="py-name" targets="Function oauth2client.appengine.xsrf_secret_key()=oauth2client.appengine-module.html#xsrf_secret_key"><a title="oauth2client.appengine.xsrf_secret_key" class="py-name" href="#" onclick="return doclink('link-163', 'xsrf_secret_key', 'link-163');">xsrf_secret_key</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">.</tt><tt class="py-name">user_id</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 732 | <a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"> <tt class="py-name">action_id</tt><tt class="py-op">=</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 733 | <a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">uri</tt> <tt class="py-op">+</tt> <tt class="py-string">':'</tt> <tt class="py-op">+</tt> <tt class="py-name">token</tt> </tt> |
| 734 | </div><a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"> </tt> |
| 735 | <a name="_parse_state_value"></a><div id="_parse_state_value-def"><a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"> </tt> |
| 736 | <a name="L519"></a><tt class="py-lineno">519</tt> <a class="py-toggle" href="#" id="_parse_state_value-toggle" onclick="return toggle('_parse_state_value');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#_parse_state_value">_parse_state_value</a><tt class="py-op">(</tt><tt class="py-param">state</tt><tt class="py-op">,</tt> <tt class="py-param">user</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 737 | </div><div id="_parse_state_value-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_parse_state_value-expanded"><a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"> <tt class="py-docstring">"""Parse the value of the 'state' parameter.</tt> </tt> |
| 738 | <a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 739 | <a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"><tt class="py-docstring"> Parses the value and validates the XSRF token in the state parameter.</tt> </tt> |
| 740 | <a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 741 | <a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 742 | <a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"><tt class="py-docstring"> state: string, The value of the state parameter.</tt> </tt> |
| 743 | <a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"><tt class="py-docstring"> user: google.appengine.api.users.User, The current user.</tt> </tt> |
| 744 | <a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 745 | <a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| 746 | <a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"><tt class="py-docstring"> InvalidXsrfTokenError: if the XSRF token is invalid.</tt> </tt> |
| 747 | <a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 748 | <a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 749 | <a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"><tt class="py-docstring"> The redirect URI.</tt> </tt> |
| 750 | <a name="L533"></a><tt class="py-lineno">533</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 751 | <a name="L534"></a><tt class="py-lineno">534</tt> <tt class="py-line"> <tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">state</tt><tt class="py-op">.</tt><tt class="py-name">rsplit</tt><tt class="py-op">(</tt><tt class="py-string">':'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt> |
| 752 | <a name="L535"></a><tt class="py-lineno">535</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-164" class="py-name"><a title="oauth2client.xsrfutil" class="py-name" href="#" onclick="return doclink('link-164', 'xsrfutil', 'link-24');">xsrfutil</a></tt><tt class="py-op">.</tt><tt id="link-165" class="py-name" targets="Function oauth2client.xsrfutil.validate_token()=oauth2client.xsrfutil-module.html#validate_token"><a title="oauth2client.xsrfutil.validate_token" class="py-name" href="#" onclick="return doclink('link-165', 'validate_token', 'link-165');">validate_token</a></tt><tt class="py-op">(</tt><tt id="link-166" class="py-name"><a title="oauth2client.appengine.xsrf_secret_key" class="py-name" href="#" onclick="return doclink('link-166', 'xsrf_secret_key', 'link-163');">xsrf_secret_key</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">.</tt><tt class="py-name">user_id</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 753 | <a name="L536"></a><tt class="py-lineno">536</tt> <tt class="py-line"> <tt class="py-name">action_id</tt><tt class="py-op">=</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 754 | <a name="L537"></a><tt class="py-lineno">537</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-167" class="py-name" targets="Class oauth2client.appengine.InvalidXsrfTokenError=oauth2client.appengine.InvalidXsrfTokenError-class.html"><a title="oauth2client.appengine.InvalidXsrfTokenError" class="py-name" href="#" onclick="return doclink('link-167', 'InvalidXsrfTokenError', 'link-167');">InvalidXsrfTokenError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 755 | <a name="L538"></a><tt class="py-lineno">538</tt> <tt class="py-line"> </tt> |
| 756 | <a name="L539"></a><tt class="py-lineno">539</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">uri</tt> </tt> |
| 757 | </div><a name="L540"></a><tt class="py-lineno">540</tt> <tt class="py-line"> </tt> |
| 758 | <a name="OAuth2Decorator"></a><div id="OAuth2Decorator-def"><a name="L541"></a><tt class="py-lineno">541</tt> <tt class="py-line"> </tt> |
| 759 | <a name="L542"></a><tt class="py-lineno">542</tt> <a class="py-toggle" href="#" id="OAuth2Decorator-toggle" onclick="return toggle('OAuth2Decorator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html">OAuth2Decorator</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 760 | </div><div id="OAuth2Decorator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="OAuth2Decorator-expanded"><a name="L543"></a><tt class="py-lineno">543</tt> <tt class="py-line"> <tt class="py-docstring">"""Utility for making OAuth 2.0 easier.</tt> </tt> |
| 761 | <a name="L544"></a><tt class="py-lineno">544</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 762 | <a name="L545"></a><tt class="py-lineno">545</tt> <tt class="py-line"><tt class="py-docstring"> Instantiate and then use with oauth_required or oauth_aware</tt> </tt> |
| 763 | <a name="L546"></a><tt class="py-lineno">546</tt> <tt class="py-line"><tt class="py-docstring"> as decorators on webapp.RequestHandler methods.</tt> </tt> |
| 764 | <a name="L547"></a><tt class="py-lineno">547</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 765 | <a name="L548"></a><tt class="py-lineno">548</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 766 | <a name="L549"></a><tt class="py-lineno">549</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 767 | <a name="L550"></a><tt class="py-lineno">550</tt> <tt class="py-line"><tt class="py-docstring"> decorator = OAuth2Decorator(</tt> </tt> |
| 768 | <a name="L551"></a><tt class="py-lineno">551</tt> <tt class="py-line"><tt class="py-docstring"> client_id='837...ent.com',</tt> </tt> |
| 769 | <a name="L552"></a><tt class="py-lineno">552</tt> <tt class="py-line"><tt class="py-docstring"> client_secret='Qh...wwI',</tt> </tt> |
| 770 | <a name="L553"></a><tt class="py-lineno">553</tt> <tt class="py-line"><tt class="py-docstring"> scope='https://www.googleapis.com/auth/plus')</tt> </tt> |
| 771 | <a name="L554"></a><tt class="py-lineno">554</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 772 | <a name="L555"></a><tt class="py-lineno">555</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 773 | <a name="L556"></a><tt class="py-lineno">556</tt> <tt class="py-line"><tt class="py-docstring"> class MainHandler(webapp.RequestHandler):</tt> </tt> |
| 774 | <a name="L557"></a><tt class="py-lineno">557</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 775 | <a name="L558"></a><tt class="py-lineno">558</tt> <tt class="py-line"><tt class="py-docstring"> @decorator.oauth_required</tt> </tt> |
| 776 | <a name="L559"></a><tt class="py-lineno">559</tt> <tt class="py-line"><tt class="py-docstring"> def get(self):</tt> </tt> |
| 777 | <a name="L560"></a><tt class="py-lineno">560</tt> <tt class="py-line"><tt class="py-docstring"> http = decorator.http()</tt> </tt> |
| 778 | <a name="L561"></a><tt class="py-lineno">561</tt> <tt class="py-line"><tt class="py-docstring"> # http is authorized with the user's Credentials and can be used</tt> </tt> |
| 779 | <a name="L562"></a><tt class="py-lineno">562</tt> <tt class="py-line"><tt class="py-docstring"> # in API calls</tt> </tt> |
| 780 | <a name="L563"></a><tt class="py-lineno">563</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 781 | <a name="L564"></a><tt class="py-lineno">564</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 782 | <a name="L565"></a><tt class="py-lineno">565</tt> <tt class="py-line"> </tt> |
| 783 | <a name="L566"></a><tt class="py-lineno">566</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-168', 'positional', 'link-78');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt> |
| 784 | <a name="OAuth2Decorator.__init__"></a><div id="OAuth2Decorator.__init__-def"><a name="L567"></a><tt class="py-lineno">567</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.__init__-toggle" onclick="return toggle('OAuth2Decorator.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-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> |
| 785 | <a name="L568"></a><tt class="py-lineno">568</tt> <tt class="py-line"> <tt class="py-param">auth_uri</tt><tt class="py-op">=</tt><tt id="link-169" class="py-name"><a title="oauth2client.GOOGLE_AUTH_URI" class="py-name" href="#" onclick="return doclink('link-169', 'GOOGLE_AUTH_URI', 'link-14');">GOOGLE_AUTH_URI</a></tt><tt class="py-op">,</tt> </tt> |
| 786 | <a name="L569"></a><tt class="py-lineno">569</tt> <tt class="py-line"> <tt class="py-param">token_uri</tt><tt class="py-op">=</tt><tt id="link-170" class="py-name"><a title="oauth2client.GOOGLE_TOKEN_URI" class="py-name" href="#" onclick="return doclink('link-170', 'GOOGLE_TOKEN_URI', 'link-18');">GOOGLE_TOKEN_URI</a></tt><tt class="py-op">,</tt> </tt> |
| 787 | <a name="L570"></a><tt class="py-lineno">570</tt> <tt class="py-line"> <tt class="py-param">revoke_uri</tt><tt class="py-op">=</tt><tt id="link-171" class="py-name"><a title="oauth2client.GOOGLE_REVOKE_URI" class="py-name" href="#" onclick="return doclink('link-171', 'GOOGLE_REVOKE_URI', 'link-16');">GOOGLE_REVOKE_URI</a></tt><tt class="py-op">,</tt> </tt> |
| 788 | <a name="L571"></a><tt class="py-lineno">571</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> |
| 789 | <a name="L572"></a><tt class="py-lineno">572</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> |
| 790 | <a name="L573"></a><tt class="py-lineno">573</tt> <tt class="py-line"> <tt class="py-param">callback_path</tt><tt class="py-op">=</tt><tt class="py-string">'/oauth2callback'</tt><tt class="py-op">,</tt> </tt> |
| 791 | <a name="L574"></a><tt class="py-lineno">574</tt> <tt class="py-line"> <tt class="py-param">token_response_param</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt> |
| 792 | <a name="L575"></a><tt class="py-lineno">575</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> |
| 793 | </div><div id="OAuth2Decorator.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.__init__-expanded"><a name="L576"></a><tt class="py-lineno">576</tt> <tt class="py-line"> </tt> |
| 794 | <a name="L577"></a><tt class="py-lineno">577</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor for OAuth2Decorator</tt> </tt> |
| 795 | <a name="L578"></a><tt class="py-lineno">578</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 796 | <a name="L579"></a><tt class="py-lineno">579</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 797 | <a name="L580"></a><tt class="py-lineno">580</tt> <tt class="py-line"><tt class="py-docstring"> client_id: string, client identifier.</tt> </tt> |
| 798 | <a name="L581"></a><tt class="py-lineno">581</tt> <tt class="py-line"><tt class="py-docstring"> client_secret: string client secret.</tt> </tt> |
| 799 | <a name="L582"></a><tt class="py-lineno">582</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or iterable of strings, scope(s) of the credentials being</tt> </tt> |
| 800 | <a name="L583"></a><tt class="py-lineno">583</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 801 | <a name="L584"></a><tt class="py-lineno">584</tt> <tt class="py-line"><tt class="py-docstring"> auth_uri: string, URI for authorization endpoint. For convenience</tt> </tt> |
| 802 | <a name="L585"></a><tt class="py-lineno">585</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> |
| 803 | <a name="L586"></a><tt class="py-lineno">586</tt> <tt class="py-line"><tt class="py-docstring"> token_uri: string, URI for token endpoint. For convenience</tt> </tt> |
| 804 | <a name="L587"></a><tt class="py-lineno">587</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> |
| 805 | <a name="L588"></a><tt class="py-lineno">588</tt> <tt class="py-line"><tt class="py-docstring"> revoke_uri: string, URI for revoke endpoint. For convenience</tt> </tt> |
| 806 | <a name="L589"></a><tt class="py-lineno">589</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> |
| 807 | <a name="L590"></a><tt class="py-lineno">590</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: string, User agent of your application, default to None.</tt> </tt> |
| 808 | <a name="L591"></a><tt class="py-lineno">591</tt> <tt class="py-line"><tt class="py-docstring"> message: Message to display if there are problems with the OAuth 2.0</tt> </tt> |
| 809 | <a name="L592"></a><tt class="py-lineno">592</tt> <tt class="py-line"><tt class="py-docstring"> configuration. The message may contain HTML and will be presented on the</tt> </tt> |
| 810 | <a name="L593"></a><tt class="py-lineno">593</tt> <tt class="py-line"><tt class="py-docstring"> web interface for any method that uses the decorator.</tt> </tt> |
| 811 | <a name="L594"></a><tt class="py-lineno">594</tt> <tt class="py-line"><tt class="py-docstring"> callback_path: string, The absolute path to use as the callback URI. Note</tt> </tt> |
| 812 | <a name="L595"></a><tt class="py-lineno">595</tt> <tt class="py-line"><tt class="py-docstring"> that this must match up with the URI given when registering the</tt> </tt> |
| 813 | <a name="L596"></a><tt class="py-lineno">596</tt> <tt class="py-line"><tt class="py-docstring"> application in the APIs Console.</tt> </tt> |
| 814 | <a name="L597"></a><tt class="py-lineno">597</tt> <tt class="py-line"><tt class="py-docstring"> token_response_param: string. If provided, the full JSON response</tt> </tt> |
| 815 | <a name="L598"></a><tt class="py-lineno">598</tt> <tt class="py-line"><tt class="py-docstring"> to the access token request will be encoded and included in this query</tt> </tt> |
| 816 | <a name="L599"></a><tt class="py-lineno">599</tt> <tt class="py-line"><tt class="py-docstring"> parameter in the callback URI. This is useful with providers (e.g.</tt> </tt> |
| 817 | <a name="L600"></a><tt class="py-lineno">600</tt> <tt class="py-line"><tt class="py-docstring"> wordpress.com) that include extra fields that the client may want.</tt> </tt> |
| 818 | <a name="L601"></a><tt class="py-lineno">601</tt> <tt class="py-line"><tt class="py-docstring"> **kwargs: dict, Keyword arguments are be passed along as kwargs to the</tt> </tt> |
| 819 | <a name="L602"></a><tt class="py-lineno">602</tt> <tt class="py-line"><tt class="py-docstring"> OAuth2WebServerFlow constructor.</tt> </tt> |
| 820 | <a name="L603"></a><tt class="py-lineno">603</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 821 | <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">flow</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 822 | <a name="L605"></a><tt class="py-lineno">605</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 823 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-172', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> |
| 824 | <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">_client_id</tt> <tt class="py-op">=</tt> <tt class="py-name">client_id</tt> </tt> |
| 825 | <a name="L607"></a><tt class="py-lineno">607</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_client_secret</tt> <tt class="py-op">=</tt> <tt class="py-name">client_secret</tt> </tt> |
| 826 | <a name="L608"></a><tt class="py-lineno">608</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_scope</tt> <tt class="py-op">=</tt> <tt id="link-173" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-173', 'util', 'link-9');">util</a></tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="oauth2client.util.scopes_to_string" class="py-name" href="#" onclick="return doclink('link-174', 'scopes_to_string', 'link-80');">scopes_to_string</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt> </tt> |
| 827 | <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">_auth_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">auth_uri</tt> </tt> |
| 828 | <a name="L610"></a><tt class="py-lineno">610</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> |
| 829 | <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">_revoke_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">revoke_uri</tt> </tt> |
| 830 | <a name="L612"></a><tt class="py-lineno">612</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> |
| 831 | <a name="L613"></a><tt class="py-lineno">613</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> |
| 832 | <a name="L614"></a><tt class="py-lineno">614</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt> <tt class="py-op">=</tt> <tt class="py-name">message</tt> </tt> |
| 833 | <a name="L615"></a><tt class="py-lineno">615</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_in_error</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> |
| 834 | <a name="L616"></a><tt class="py-lineno">616</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback_path</tt> <tt class="py-op">=</tt> <tt id="link-175" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator.callback_path()=oauth2client.appengine.OAuth2Decorator-class.html#callback_path"><a title="oauth2client.appengine.OAuth2Decorator.callback_path" class="py-name" href="#" onclick="return doclink('link-175', 'callback_path', 'link-175');">callback_path</a></tt> </tt> |
| 835 | <a name="L617"></a><tt class="py-lineno">617</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_token_response_param</tt> <tt class="py-op">=</tt> <tt class="py-name">token_response_param</tt> </tt> |
| 836 | </div><a name="L618"></a><tt class="py-lineno">618</tt> <tt class="py-line"> </tt> |
| 837 | <a name="OAuth2Decorator._display_error_message"></a><div id="OAuth2Decorator._display_error_message-def"><a name="L619"></a><tt class="py-lineno">619</tt> <a class="py-toggle" href="#" id="OAuth2Decorator._display_error_message-toggle" onclick="return toggle('OAuth2Decorator._display_error_message');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#_display_error_message">_display_error_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_handler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 838 | </div><div id="OAuth2Decorator._display_error_message-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator._display_error_message-expanded"><a name="L620"></a><tt class="py-lineno">620</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name" targets="Method apiclient.model.BaseModel.response()=apiclient.model.BaseModel-class.html#response,Method apiclient.model.Model.response()=apiclient.model.Model-class.html#response"><a title="apiclient.model.BaseModel.response |
| 839 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-176', 'response', 'link-176');">response</a></tt><tt class="py-op">.</tt><tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name" targets="Method apiclient.push.Headers.write()=apiclient.push.Headers-class.html#write"><a title="apiclient.push.Headers.write" class="py-name" href="#" onclick="return doclink('link-177', 'write', 'link-177');">write</a></tt><tt class="py-op">(</tt><tt class="py-string">'<html><body>'</tt><tt class="py-op">)</tt> </tt> |
| 840 | <a name="L621"></a><tt class="py-lineno">621</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="apiclient.model.BaseModel.response |
| 841 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-178', 'response', 'link-176');">response</a></tt><tt class="py-op">.</tt><tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-179" class="py-name"><a title="apiclient.push.Headers.write" class="py-name" href="#" onclick="return doclink('link-179', 'write', 'link-177');">write</a></tt><tt class="py-op">(</tt><tt id="link-180" class="py-name" targets="Function oauth2client.appengine._safe_html()=oauth2client.appengine-module.html#_safe_html"><a title="oauth2client.appengine._safe_html" class="py-name" href="#" onclick="return doclink('link-180', '_safe_html', 'link-180');">_safe_html</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 842 | <a name="L622"></a><tt class="py-lineno">622</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-181" class="py-name"><a title="apiclient.model.BaseModel.response |
| 843 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-181', 'response', 'link-176');">response</a></tt><tt class="py-op">.</tt><tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-182" class="py-name"><a title="apiclient.push.Headers.write" class="py-name" href="#" onclick="return doclink('link-182', 'write', 'link-177');">write</a></tt><tt class="py-op">(</tt><tt class="py-string">'</body></html>'</tt><tt class="py-op">)</tt> </tt> |
| 844 | </div><a name="L623"></a><tt class="py-lineno">623</tt> <tt class="py-line"> </tt> |
| 845 | <a name="OAuth2Decorator.oauth_required"></a><div id="OAuth2Decorator.oauth_required-def"><a name="L624"></a><tt class="py-lineno">624</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.oauth_required-toggle" onclick="return toggle('OAuth2Decorator.oauth_required');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#oauth_required">oauth_required</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 846 | </div><div id="OAuth2Decorator.oauth_required-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.oauth_required-expanded"><a name="L625"></a><tt class="py-lineno">625</tt> <tt class="py-line"> <tt class="py-docstring">"""Decorator that starts the OAuth 2.0 dance.</tt> </tt> |
| 847 | <a name="L626"></a><tt class="py-lineno">626</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 848 | <a name="L627"></a><tt class="py-lineno">627</tt> <tt class="py-line"><tt class="py-docstring"> Starts the OAuth dance for the logged in user if they haven't already</tt> </tt> |
| 849 | <a name="L628"></a><tt class="py-lineno">628</tt> <tt class="py-line"><tt class="py-docstring"> granted access for this application.</tt> </tt> |
| 850 | <a name="L629"></a><tt class="py-lineno">629</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 851 | <a name="L630"></a><tt class="py-lineno">630</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 852 | <a name="L631"></a><tt class="py-lineno">631</tt> <tt class="py-line"><tt class="py-docstring"> method: callable, to be decorated method of a webapp.RequestHandler</tt> </tt> |
| 853 | <a name="L632"></a><tt class="py-lineno">632</tt> <tt class="py-line"><tt class="py-docstring"> instance.</tt> </tt> |
| 854 | <a name="L633"></a><tt class="py-lineno">633</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 855 | <a name="L634"></a><tt class="py-lineno">634</tt> <tt class="py-line"> </tt> |
| 856 | <a name="L635"></a><tt class="py-lineno">635</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">check_oauth</tt><tt class="py-op">(</tt><tt class="py-param">request_handler</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 857 | <a name="L636"></a><tt class="py-lineno">636</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">_in_error</tt><tt class="py-op">:</tt> </tt> |
| 858 | <a name="L637"></a><tt class="py-lineno">637</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator._display_error_message()=oauth2client.appengine.OAuth2Decorator-class.html#_display_error_message"><a title="oauth2client.appengine.OAuth2Decorator._display_error_message" class="py-name" href="#" onclick="return doclink('link-183', '_display_error_message', 'link-183');">_display_error_message</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">)</tt> </tt> |
| 859 | <a name="L638"></a><tt class="py-lineno">638</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt> |
| 860 | <a name="L639"></a><tt class="py-lineno">639</tt> <tt class="py-line"> </tt> |
| 861 | <a name="L640"></a><tt class="py-lineno">640</tt> <tt class="py-line"> <tt class="py-name">user</tt> <tt class="py-op">=</tt> <tt class="py-name">users</tt><tt class="py-op">.</tt><tt class="py-name">get_current_user</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 862 | <a name="L641"></a><tt class="py-lineno">641</tt> <tt class="py-line"> <tt class="py-comment"># Don't use @login_decorator as this could be used in a POST request.</tt> </tt> |
| 863 | <a name="L642"></a><tt class="py-lineno">642</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">user</tt><tt class="py-op">:</tt> </tt> |
| 864 | <a name="L643"></a><tt class="py-lineno">643</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt class="py-name">redirect</tt><tt class="py-op">(</tt><tt class="py-name">users</tt><tt class="py-op">.</tt><tt class="py-name">create_login_url</tt><tt class="py-op">(</tt> </tt> |
| 865 | <a name="L644"></a><tt class="py-lineno">644</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-184" class="py-name"><a title="apiclient.http.HttpMock.request |
| 866 | apiclient.http.HttpMockSequence.request |
| 867 | apiclient.model.BaseModel.request |
| 868 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-184', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 869 | <a name="L645"></a><tt class="py-lineno">645</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt> |
| 870 | <a name="L646"></a><tt class="py-lineno">646</tt> <tt class="py-line"> </tt> |
| 871 | <a name="L647"></a><tt class="py-lineno">647</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-185" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator._create_flow()=oauth2client.appengine.OAuth2Decorator-class.html#_create_flow"><a title="oauth2client.appengine.OAuth2Decorator._create_flow" class="py-name" href="#" onclick="return doclink('link-185', '_create_flow', 'link-185');">_create_flow</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">)</tt> </tt> |
| 872 | <a name="L648"></a><tt class="py-lineno">648</tt> <tt class="py-line"> </tt> |
| 873 | <a name="L649"></a><tt class="py-lineno">649</tt> <tt class="py-line"> <tt class="py-comment"># Store the request URI in 'state' so we can use it later</tt> </tt> |
| 874 | <a name="L650"></a><tt class="py-lineno">650</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">flow</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'state'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-186" class="py-name" targets="Function oauth2client.appengine._build_state_value()=oauth2client.appengine-module.html#_build_state_value"><a title="oauth2client.appengine._build_state_value" class="py-name" href="#" onclick="return doclink('link-186', '_build_state_value', 'link-186');">_build_state_value</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">)</tt> </tt> |
| 875 | <a name="L651"></a><tt class="py-lineno">651</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 876 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-187', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-188" class="py-name" targets="Class oauth2client.appengine.StorageByKeyName=oauth2client.appengine.StorageByKeyName-class.html"><a title="oauth2client.appengine.StorageByKeyName" class="py-name" href="#" onclick="return doclink('link-188', 'StorageByKeyName', 'link-188');">StorageByKeyName</a></tt><tt class="py-op">(</tt> </tt> |
| 877 | <a name="L652"></a><tt class="py-lineno">652</tt> <tt class="py-line"> <tt id="link-189" class="py-name" targets="Class oauth2client.appengine.CredentialsModel=oauth2client.appengine.CredentialsModel-class.html"><a title="oauth2client.appengine.CredentialsModel" class="py-name" href="#" onclick="return doclink('link-189', 'CredentialsModel', 'link-189');">CredentialsModel</a></tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">.</tt><tt class="py-name">user_id</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 878 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 879 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-190', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 880 | <a name="L653"></a><tt class="py-lineno">653</tt> <tt class="py-line"> </tt> |
| 881 | <a name="L654"></a><tt class="py-lineno">654</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 id="link-191" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator.has_credentials()=oauth2client.appengine.OAuth2Decorator-class.html#has_credentials"><a title="oauth2client.appengine.OAuth2Decorator.has_credentials" class="py-name" href="#" onclick="return doclink('link-191', 'has_credentials', 'link-191');">has_credentials</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 882 | <a name="L655"></a><tt class="py-lineno">655</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt class="py-name">redirect</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-192" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator.authorize_url()=oauth2client.appengine.OAuth2Decorator-class.html#authorize_url"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-192', 'authorize_url', 'link-192');">authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 883 | <a name="L656"></a><tt class="py-lineno">656</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> |
| 884 | <a name="L657"></a><tt class="py-lineno">657</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">method</tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt> |
| 885 | <a name="L658"></a><tt class="py-lineno">658</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-193" class="py-name"><a title="oauth2client.client.AccessTokenRefreshError" class="py-name" href="#" onclick="return doclink('link-193', 'AccessTokenRefreshError', 'link-29');">AccessTokenRefreshError</a></tt><tt class="py-op">:</tt> </tt> |
| 886 | <a name="L659"></a><tt class="py-lineno">659</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt class="py-name">redirect</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-194', 'authorize_url', 'link-192');">authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 887 | </div><a name="L660"></a><tt class="py-lineno">660</tt> <tt class="py-line"> </tt> |
| 888 | <a name="L661"></a><tt class="py-lineno">661</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">check_oauth</tt> </tt> |
| 889 | </div><a name="L662"></a><tt class="py-lineno">662</tt> <tt class="py-line"> </tt> |
| 890 | <a name="OAuth2Decorator._create_flow"></a><div id="OAuth2Decorator._create_flow-def"><a name="L663"></a><tt class="py-lineno">663</tt> <a class="py-toggle" href="#" id="OAuth2Decorator._create_flow-toggle" onclick="return toggle('OAuth2Decorator._create_flow');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#_create_flow">_create_flow</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">request_handler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 891 | </div><div id="OAuth2Decorator._create_flow-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator._create_flow-expanded"><a name="L664"></a><tt class="py-lineno">664</tt> <tt class="py-line"> <tt class="py-docstring">"""Create the Flow object.</tt> </tt> |
| 892 | <a name="L665"></a><tt class="py-lineno">665</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 893 | <a name="L666"></a><tt class="py-lineno">666</tt> <tt class="py-line"><tt class="py-docstring"> The Flow is calculated lazily since we don't know where this app is</tt> </tt> |
| 894 | <a name="L667"></a><tt class="py-lineno">667</tt> <tt class="py-line"><tt class="py-docstring"> running until it receives a request, at which point redirect_uri can be</tt> </tt> |
| 895 | <a name="L668"></a><tt class="py-lineno">668</tt> <tt class="py-line"><tt class="py-docstring"> calculated and then the Flow object can be constructed.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 896 | <a name="L669"></a><tt class="py-lineno">669</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 897 | <a name="L670"></a><tt class="py-lineno">670</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 898 | <a name="L671"></a><tt class="py-lineno">671</tt> <tt class="py-line"><tt class="py-docstring"> request_handler: webapp.RequestHandler, the request handler.</tt> </tt> |
| 899 | <a name="L672"></a><tt class="py-lineno">672</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 900 | <a name="L673"></a><tt class="py-lineno">673</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">flow</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| 901 | <a name="L674"></a><tt class="py-lineno">674</tt> <tt class="py-line"> <tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-195" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 902 | apiclient.http.HttpMockSequence.request |
| 903 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 904 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-195', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">relative_url</tt><tt class="py-op">(</tt> </tt> |
| 905 | <a name="L675"></a><tt class="py-lineno">675</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callback_path</tt><tt class="py-op">)</tt> <tt class="py-comment"># Usually /oauth2callback</tt> </tt> |
| 906 | <a name="L676"></a><tt class="py-lineno">676</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">flow</tt> <tt class="py-op">=</tt> <tt id="link-196" class="py-name"><a title="oauth2client.client.OAuth2WebServerFlow" class="py-name" href="#" onclick="return doclink('link-196', 'OAuth2WebServerFlow', 'link-41');">OAuth2WebServerFlow</a></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 class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_client_secret</tt><tt class="py-op">,</tt> </tt> |
| 907 | <a name="L677"></a><tt class="py-lineno">677</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">redirect_uri</tt><tt class="py-op">=</tt><tt class="py-name">redirect_uri</tt><tt class="py-op">,</tt> </tt> |
| 908 | <a name="L678"></a><tt class="py-lineno">678</tt> <tt class="py-line"> <tt class="py-name">user_agent</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> |
| 909 | <a name="L679"></a><tt class="py-lineno">679</tt> <tt class="py-line"> <tt class="py-name">auth_uri</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> |
| 910 | <a name="L680"></a><tt class="py-lineno">680</tt> <tt class="py-line"> <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">_token_uri</tt><tt class="py-op">,</tt> </tt> |
| 911 | <a name="L681"></a><tt class="py-lineno">681</tt> <tt class="py-line"> <tt class="py-name">revoke_uri</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_revoke_uri</tt><tt class="py-op">,</tt> </tt> |
| 912 | <a name="L682"></a><tt class="py-lineno">682</tt> <tt class="py-line"> <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> |
| 913 | </div><a name="L683"></a><tt class="py-lineno">683</tt> <tt class="py-line"> </tt> |
| 914 | <a name="OAuth2Decorator.oauth_aware"></a><div id="OAuth2Decorator.oauth_aware-def"><a name="L684"></a><tt class="py-lineno">684</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.oauth_aware-toggle" onclick="return toggle('OAuth2Decorator.oauth_aware');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#oauth_aware">oauth_aware</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 915 | </div><div id="OAuth2Decorator.oauth_aware-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.oauth_aware-expanded"><a name="L685"></a><tt class="py-lineno">685</tt> <tt class="py-line"> <tt class="py-docstring">"""Decorator that sets up for OAuth 2.0 dance, but doesn't do it.</tt> </tt> |
| 916 | <a name="L686"></a><tt class="py-lineno">686</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 917 | <a name="L687"></a><tt class="py-lineno">687</tt> <tt class="py-line"><tt class="py-docstring"> Does all the setup for the OAuth dance, but doesn't initiate it.</tt> </tt> |
| 918 | <a name="L688"></a><tt class="py-lineno">688</tt> <tt class="py-line"><tt class="py-docstring"> This decorator is useful if you want to create a page that knows</tt> </tt> |
| 919 | <a name="L689"></a><tt class="py-lineno">689</tt> <tt class="py-line"><tt class="py-docstring"> whether or not the user has granted access to this application.</tt> </tt> |
| 920 | <a name="L690"></a><tt class="py-lineno">690</tt> <tt class="py-line"><tt class="py-docstring"> From within a method decorated with @oauth_aware the has_credentials()</tt> </tt> |
| 921 | <a name="L691"></a><tt class="py-lineno">691</tt> <tt class="py-line"><tt class="py-docstring"> and authorize_url() methods can be called.</tt> </tt> |
| 922 | <a name="L692"></a><tt class="py-lineno">692</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 923 | <a name="L693"></a><tt class="py-lineno">693</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 924 | <a name="L694"></a><tt class="py-lineno">694</tt> <tt class="py-line"><tt class="py-docstring"> method: callable, to be decorated method of a webapp.RequestHandler</tt> </tt> |
| 925 | <a name="L695"></a><tt class="py-lineno">695</tt> <tt class="py-line"><tt class="py-docstring"> instance.</tt> </tt> |
| 926 | <a name="L696"></a><tt class="py-lineno">696</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 927 | <a name="L697"></a><tt class="py-lineno">697</tt> <tt class="py-line"> </tt> |
| 928 | <a name="L698"></a><tt class="py-lineno">698</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">setup_oauth</tt><tt class="py-op">(</tt><tt class="py-param">request_handler</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 929 | <a name="L699"></a><tt class="py-lineno">699</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">_in_error</tt><tt class="py-op">:</tt> </tt> |
| 930 | <a name="L700"></a><tt class="py-lineno">700</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator._display_error_message" class="py-name" href="#" onclick="return doclink('link-197', '_display_error_message', 'link-183');">_display_error_message</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">)</tt> </tt> |
| 931 | <a name="L701"></a><tt class="py-lineno">701</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt> |
| 932 | <a name="L702"></a><tt class="py-lineno">702</tt> <tt class="py-line"> </tt> |
| 933 | <a name="L703"></a><tt class="py-lineno">703</tt> <tt class="py-line"> <tt class="py-name">user</tt> <tt class="py-op">=</tt> <tt class="py-name">users</tt><tt class="py-op">.</tt><tt class="py-name">get_current_user</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 934 | <a name="L704"></a><tt class="py-lineno">704</tt> <tt class="py-line"> <tt class="py-comment"># Don't use @login_decorator as this could be used in a POST request.</tt> </tt> |
| 935 | <a name="L705"></a><tt class="py-lineno">705</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">user</tt><tt class="py-op">:</tt> </tt> |
| 936 | <a name="L706"></a><tt class="py-lineno">706</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt class="py-name">redirect</tt><tt class="py-op">(</tt><tt class="py-name">users</tt><tt class="py-op">.</tt><tt class="py-name">create_login_url</tt><tt class="py-op">(</tt> </tt> |
| 937 | <a name="L707"></a><tt class="py-lineno">707</tt> <tt class="py-line"> <tt class="py-name">request_handler</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name"><a title="apiclient.http.HttpMock.request |
| 938 | apiclient.http.HttpMockSequence.request |
| 939 | apiclient.model.BaseModel.request |
| 940 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-198', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 941 | <a name="L708"></a><tt class="py-lineno">708</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt> |
| 942 | <a name="L709"></a><tt class="py-lineno">709</tt> <tt class="py-line"> </tt> |
| 943 | <a name="L710"></a><tt class="py-lineno">710</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator._create_flow" class="py-name" href="#" onclick="return doclink('link-199', '_create_flow', 'link-185');">_create_flow</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">)</tt> </tt> |
| 944 | <a name="L711"></a><tt class="py-lineno">711</tt> <tt class="py-line"> </tt> |
| 945 | <a name="L712"></a><tt class="py-lineno">712</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">flow</tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'state'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-200" class="py-name"><a title="oauth2client.appengine._build_state_value" class="py-name" href="#" onclick="return doclink('link-200', '_build_state_value', 'link-186');">_build_state_value</a></tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">)</tt> </tt> |
| 946 | <a name="L713"></a><tt class="py-lineno">713</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-201" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 947 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-201', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-202" class="py-name"><a title="oauth2client.appengine.StorageByKeyName" class="py-name" href="#" onclick="return doclink('link-202', 'StorageByKeyName', 'link-188');">StorageByKeyName</a></tt><tt class="py-op">(</tt> </tt> |
| 948 | <a name="L714"></a><tt class="py-lineno">714</tt> <tt class="py-line"> <tt id="link-203" class="py-name"><a title="oauth2client.appengine.CredentialsModel" class="py-name" href="#" onclick="return doclink('link-203', 'CredentialsModel', 'link-189');">CredentialsModel</a></tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">.</tt><tt class="py-name">user_id</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 949 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 950 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-204', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 951 | <a name="L715"></a><tt class="py-lineno">715</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">method</tt><tt class="py-op">(</tt><tt class="py-name">request_handler</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt> |
| 952 | </div><a name="L716"></a><tt class="py-lineno">716</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">setup_oauth</tt> </tt> |
| 953 | </div><a name="L717"></a><tt class="py-lineno">717</tt> <tt class="py-line"> </tt> |
| 954 | <a name="OAuth2Decorator.has_credentials"></a><div id="OAuth2Decorator.has_credentials-def"><a name="L718"></a><tt class="py-lineno">718</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.has_credentials-toggle" onclick="return toggle('OAuth2Decorator.has_credentials');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#has_credentials">has_credentials</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 955 | </div><div id="OAuth2Decorator.has_credentials-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.has_credentials-expanded"><a name="L719"></a><tt class="py-lineno">719</tt> <tt class="py-line"> <tt class="py-docstring">"""True if for the logged in user there are valid access Credentials.</tt> </tt> |
| 956 | <a name="L720"></a><tt class="py-lineno">720</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 957 | <a name="L721"></a><tt class="py-lineno">721</tt> <tt class="py-line"><tt class="py-docstring"> Must only be called from with a webapp.RequestHandler subclassed method</tt> </tt> |
| 958 | <a name="L722"></a><tt class="py-lineno">722</tt> <tt class="py-line"><tt class="py-docstring"> that had been decorated with either @oauth_required or @oauth_aware.</tt> </tt> |
| 959 | <a name="L723"></a><tt class="py-lineno">723</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 960 | <a name="L724"></a><tt class="py-lineno">724</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-205" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 961 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-205', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-206" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 962 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-206', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt class="py-name">invalid</tt> </tt> |
| 963 | </div><a name="L725"></a><tt class="py-lineno">725</tt> <tt class="py-line"> </tt> |
| 964 | <a name="OAuth2Decorator.authorize_url"></a><div id="OAuth2Decorator.authorize_url-def"><a name="L726"></a><tt class="py-lineno">726</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.authorize_url-toggle" onclick="return toggle('OAuth2Decorator.authorize_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#authorize_url">authorize_url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 965 | </div><div id="OAuth2Decorator.authorize_url-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.authorize_url-expanded"><a name="L727"></a><tt class="py-lineno">727</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns the URL to start the OAuth dance.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 966 | <a name="L728"></a><tt class="py-lineno">728</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 967 | <a name="L729"></a><tt class="py-lineno">729</tt> <tt class="py-line"><tt class="py-docstring"> Must only be called from with a webapp.RequestHandler subclassed method</tt> </tt> |
| 968 | <a name="L730"></a><tt class="py-lineno">730</tt> <tt class="py-line"><tt class="py-docstring"> that had been decorated with either @oauth_required or @oauth_aware.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 969 | <a name="L731"></a><tt class="py-lineno">731</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 970 | <a name="L732"></a><tt class="py-lineno">732</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-207" 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-207', 'step1_get_authorize_url', 'link-207');">step1_get_authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 971 | <a name="L733"></a><tt class="py-lineno">733</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt> |
| 972 | </div><a name="L734"></a><tt class="py-lineno">734</tt> <tt class="py-line"> </tt> |
| 973 | <a name="OAuth2Decorator.http"></a><div id="OAuth2Decorator.http-def"><a name="L735"></a><tt class="py-lineno">735</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.http-toggle" onclick="return toggle('OAuth2Decorator.http');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#http">http</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 974 | </div><div id="OAuth2Decorator.http-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.http-expanded"><a name="L736"></a><tt class="py-lineno">736</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns an authorized http instance.</tt> </tt> |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 975 | <a name="L737"></a><tt class="py-lineno">737</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 976 | <a name="L738"></a><tt class="py-lineno">738</tt> <tt class="py-line"><tt class="py-docstring"> Must only be called from within an @oauth_required decorated method, or</tt> </tt> |
| 977 | <a name="L739"></a><tt class="py-lineno">739</tt> <tt class="py-line"><tt class="py-docstring"> from within an @oauth_aware decorated method where has_credentials()</tt> </tt> |
| 978 | <a name="L740"></a><tt class="py-lineno">740</tt> <tt class="py-line"><tt class="py-docstring"> returns True.</tt> </tt> |
| 979 | <a name="L741"></a><tt class="py-lineno">741</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 980 | <a name="L742"></a><tt class="py-lineno">742</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-208" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 981 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-208', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-209" class="py-name" targets="Method oauth2client.client.Credentials.authorize()=oauth2client.client.Credentials-class.html#authorize,Method oauth2client.client.OAuth2Credentials.authorize()=oauth2client.client.OAuth2Credentials-class.html#authorize"><a title="oauth2client.client.Credentials.authorize |
| 982 | oauth2client.client.OAuth2Credentials.authorize" class="py-name" href="#" onclick="return doclink('link-209', 'authorize', 'link-209');">authorize</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 class="py-op">)</tt> </tt> |
| 983 | </div><a name="L743"></a><tt class="py-lineno">743</tt> <tt class="py-line"> </tt> |
| 984 | <a name="L744"></a><tt class="py-lineno">744</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| 985 | <a name="OAuth2Decorator.callback_path"></a><div id="OAuth2Decorator.callback_path-def"><a name="L745"></a><tt class="py-lineno">745</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.callback_path-toggle" onclick="return toggle('OAuth2Decorator.callback_path');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#callback_path">callback_path</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 986 | </div><div id="OAuth2Decorator.callback_path-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.callback_path-expanded"><a name="L746"></a><tt class="py-lineno">746</tt> <tt class="py-line"> <tt class="py-docstring">"""The absolute path where the callback will occur.</tt> </tt> |
| 987 | <a name="L747"></a><tt class="py-lineno">747</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 988 | <a name="L748"></a><tt class="py-lineno">748</tt> <tt class="py-line"><tt class="py-docstring"> Note this is the absolute path, not the absolute URI, that will be</tt> </tt> |
| 989 | <a name="L749"></a><tt class="py-lineno">749</tt> <tt class="py-line"><tt class="py-docstring"> calculated by the decorator at runtime. See callback_handler() for how this</tt> </tt> |
| 990 | <a name="L750"></a><tt class="py-lineno">750</tt> <tt class="py-line"><tt class="py-docstring"> should be used.</tt> </tt> |
| 991 | <a name="L751"></a><tt class="py-lineno">751</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 992 | <a name="L752"></a><tt class="py-lineno">752</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 993 | <a name="L753"></a><tt class="py-lineno">753</tt> <tt class="py-line"><tt class="py-docstring"> The callback path as a string.</tt> </tt> |
| 994 | <a name="L754"></a><tt class="py-lineno">754</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 995 | <a name="L755"></a><tt class="py-lineno">755</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">_callback_path</tt> </tt> |
| 996 | </div><a name="L756"></a><tt class="py-lineno">756</tt> <tt class="py-line"> </tt> |
| 997 | <a name="L757"></a><tt class="py-lineno">757</tt> <tt class="py-line"> </tt> |
| 998 | <a name="OAuth2Decorator.callback_handler"></a><div id="OAuth2Decorator.callback_handler-def"><a name="L758"></a><tt class="py-lineno">758</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.callback_handler-toggle" onclick="return toggle('OAuth2Decorator.callback_handler');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#callback_handler">callback_handler</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 999 | </div><div id="OAuth2Decorator.callback_handler-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.callback_handler-expanded"><a name="L759"></a><tt class="py-lineno">759</tt> <tt class="py-line"> <tt class="py-docstring">"""RequestHandler for the OAuth 2.0 redirect callback.</tt> </tt> |
| 1000 | <a name="L760"></a><tt class="py-lineno">760</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1001 | <a name="L761"></a><tt class="py-lineno">761</tt> <tt class="py-line"><tt class="py-docstring"> Usage:</tt> </tt> |
| 1002 | <a name="L762"></a><tt class="py-lineno">762</tt> <tt class="py-line"><tt class="py-docstring"> app = webapp.WSGIApplication([</tt> </tt> |
| 1003 | <a name="L763"></a><tt class="py-lineno">763</tt> <tt class="py-line"><tt class="py-docstring"> ('/index', MyIndexHandler),</tt> </tt> |
| 1004 | <a name="L764"></a><tt class="py-lineno">764</tt> <tt class="py-line"><tt class="py-docstring"> ...,</tt> </tt> |
| 1005 | <a name="L765"></a><tt class="py-lineno">765</tt> <tt class="py-line"><tt class="py-docstring"> (decorator.callback_path, decorator.callback_handler())</tt> </tt> |
| 1006 | <a name="L766"></a><tt class="py-lineno">766</tt> <tt class="py-line"><tt class="py-docstring"> ])</tt> </tt> |
| 1007 | <a name="L767"></a><tt class="py-lineno">767</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1008 | <a name="L768"></a><tt class="py-lineno">768</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1009 | <a name="L769"></a><tt class="py-lineno">769</tt> <tt class="py-line"><tt class="py-docstring"> A webapp.RequestHandler that handles the redirect back from the</tt> </tt> |
| 1010 | <a name="L770"></a><tt class="py-lineno">770</tt> <tt class="py-line"><tt class="py-docstring"> server during the OAuth 2.0 dance.</tt> </tt> |
| 1011 | <a name="L771"></a><tt class="py-lineno">771</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1012 | <a name="L772"></a><tt class="py-lineno">772</tt> <tt class="py-line"> <tt class="py-name">decorator</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt> </tt> |
| 1013 | <a name="L773"></a><tt class="py-lineno">773</tt> <tt class="py-line"> </tt> |
| 1014 | <a name="L774"></a><tt class="py-lineno">774</tt> <tt class="py-line"> <tt class="py-keyword">class</tt> <tt class="py-def-name">OAuth2Handler</tt><tt class="py-op">(</tt><tt class="py-base-class">webapp</tt><tt class="py-op">.</tt><tt class="py-base-class">RequestHandler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1015 | <a name="L775"></a><tt class="py-lineno">775</tt> <tt class="py-line"> <tt class="py-docstring">"""Handler for the redirect_uri of the OAuth 2.0 dance."""</tt> </tt> |
| 1016 | <a name="L776"></a><tt class="py-lineno">776</tt> <tt class="py-line"> </tt> |
| 1017 | <a name="L777"></a><tt class="py-lineno">777</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">login_required</tt> </tt> |
| 1018 | <a name="L778"></a><tt class="py-lineno">778</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">get</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1019 | <a name="L779"></a><tt class="py-lineno">779</tt> <tt class="py-line"> <tt class="py-name">error</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1020 | apiclient.http.HttpMockSequence.request |
| 1021 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1022 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-210', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1023 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1024 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-211', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'error'</tt><tt class="py-op">)</tt> </tt> |
| 1025 | <a name="L780"></a><tt class="py-lineno">780</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">error</tt><tt class="py-op">:</tt> </tt> |
| 1026 | <a name="L781"></a><tt class="py-lineno">781</tt> <tt class="py-line"> <tt class="py-name">errormsg</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-212" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1027 | apiclient.http.HttpMockSequence.request |
| 1028 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1029 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-212', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1030 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1031 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-213', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'error_description'</tt><tt class="py-op">,</tt> <tt class="py-name">error</tt><tt class="py-op">)</tt> </tt> |
| 1032 | <a name="L782"></a><tt class="py-lineno">782</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-214" class="py-name"><a title="apiclient.model.BaseModel.response |
| 1033 | apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-214', 'response', 'link-176');">response</a></tt><tt class="py-op">.</tt><tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="apiclient.push.Headers.write" class="py-name" href="#" onclick="return doclink('link-215', 'write', 'link-177');">write</a></tt><tt class="py-op">(</tt> </tt> |
| 1034 | <a name="L783"></a><tt class="py-lineno">783</tt> <tt class="py-line"> <tt class="py-string">'The authorization request failed: %s'</tt> <tt class="py-op">%</tt> <tt id="link-216" class="py-name"><a title="oauth2client.appengine._safe_html" class="py-name" href="#" onclick="return doclink('link-216', '_safe_html', 'link-180');">_safe_html</a></tt><tt class="py-op">(</tt><tt class="py-name">errormsg</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1035 | <a name="L784"></a><tt class="py-lineno">784</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1036 | <a name="L785"></a><tt class="py-lineno">785</tt> <tt class="py-line"> <tt class="py-name">user</tt> <tt class="py-op">=</tt> <tt class="py-name">users</tt><tt class="py-op">.</tt><tt class="py-name">get_current_user</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| 1037 | <a name="L786"></a><tt class="py-lineno">786</tt> <tt class="py-line"> <tt class="py-name">decorator</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator._create_flow" class="py-name" href="#" onclick="return doclink('link-217', '_create_flow', 'link-185');">_create_flow</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt> |
| 1038 | <a name="L787"></a><tt class="py-lineno">787</tt> <tt class="py-line"> <tt id="link-218" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 1039 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-218', 'credentials', 'link-105');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">decorator</tt><tt class="py-op">.</tt><tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-219" 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-219', 'step2_exchange', 'link-219');">step2_exchange</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1040 | apiclient.http.HttpMockSequence.request |
| 1041 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1042 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-220', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">params</tt><tt class="py-op">)</tt> </tt> |
| 1043 | <a name="L788"></a><tt class="py-lineno">788</tt> <tt class="py-line"> <tt id="link-221" class="py-name"><a title="oauth2client.appengine.StorageByKeyName" class="py-name" href="#" onclick="return doclink('link-221', 'StorageByKeyName', 'link-188');">StorageByKeyName</a></tt><tt class="py-op">(</tt> </tt> |
| 1044 | <a name="L789"></a><tt class="py-lineno">789</tt> <tt class="py-line"> <tt id="link-222" class="py-name"><a title="oauth2client.appengine.CredentialsModel" class="py-name" href="#" onclick="return doclink('link-222', 'CredentialsModel', 'link-189');">CredentialsModel</a></tt><tt class="py-op">,</tt> <tt class="py-name">user</tt><tt class="py-op">.</tt><tt class="py-name">user_id</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name"><a title="oauth2client.client.Storage.put" class="py-name" href="#" onclick="return doclink('link-223', 'put', 'link-69');">put</a></tt><tt class="py-op">(</tt><tt id="link-224" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 1045 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-224', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">)</tt> </tt> |
| 1046 | <a name="L790"></a><tt class="py-lineno">790</tt> <tt class="py-line"> <tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt id="link-225" class="py-name" targets="Function oauth2client.appengine._parse_state_value()=oauth2client.appengine-module.html#_parse_state_value"><a title="oauth2client.appengine._parse_state_value" class="py-name" href="#" onclick="return doclink('link-225', '_parse_state_value', 'link-225');">_parse_state_value</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name"><a title="apiclient.http.HttpMock.request |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1047 | apiclient.http.HttpMockSequence.request |
| 1048 | apiclient.model.BaseModel.request |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1049 | apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-226', 'request', 'link-160');">request</a></tt><tt class="py-op">.</tt><tt id="link-227" class="py-name"><a title="apiclient.schema.Schemas.get |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1050 | oauth2client.client.MemoryCache.get |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1051 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-227', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'state'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| 1052 | <a name="L791"></a><tt class="py-lineno">791</tt> <tt class="py-line"> <tt class="py-name">user</tt><tt class="py-op">)</tt> </tt> |
| 1053 | <a name="L792"></a><tt class="py-lineno">792</tt> <tt class="py-line"> </tt> |
| 1054 | <a name="L793"></a><tt class="py-lineno">793</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">decorator</tt><tt class="py-op">.</tt><tt class="py-name">_token_response_param</tt> <tt class="py-keyword">and</tt> <tt id="link-228" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 1055 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-228', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt class="py-name">token_response</tt><tt class="py-op">:</tt> </tt> |
| 1056 | <a name="L794"></a><tt class="py-lineno">794</tt> <tt class="py-line"> <tt class="py-name">resp_json</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt id="link-229" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials |
| 1057 | oauth2client.appengine.CredentialsNDBModel.credentials" class="py-name" href="#" onclick="return doclink('link-229', 'credentials', 'link-105');">credentials</a></tt><tt class="py-op">.</tt><tt class="py-name">token_response</tt><tt class="py-op">)</tt> </tt> |
| 1058 | <a name="L795"></a><tt class="py-lineno">795</tt> <tt class="py-line"> <tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt id="link-230" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-230', 'util', 'link-9');">util</a></tt><tt class="py-op">.</tt><tt id="link-231" class="py-name" targets="Function oauth2client.util._add_query_parameter()=oauth2client.util-module.html#_add_query_parameter"><a title="oauth2client.util._add_query_parameter" class="py-name" href="#" onclick="return doclink('link-231', '_add_query_parameter', 'link-231');">_add_query_parameter</a></tt><tt class="py-op">(</tt> </tt> |
| 1059 | <a name="L796"></a><tt class="py-lineno">796</tt> <tt class="py-line"> <tt class="py-name">redirect_uri</tt><tt class="py-op">,</tt> <tt class="py-name">decorator</tt><tt class="py-op">.</tt><tt class="py-name">_token_response_param</tt><tt class="py-op">,</tt> <tt class="py-name">resp_json</tt><tt class="py-op">)</tt> </tt> |
| 1060 | <a name="L797"></a><tt class="py-lineno">797</tt> <tt class="py-line"> </tt> |
| 1061 | <a name="L798"></a><tt class="py-lineno">798</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">redirect</tt><tt class="py-op">(</tt><tt class="py-name">redirect_uri</tt><tt class="py-op">)</tt> </tt> |
| 1062 | </div></div><a name="L799"></a><tt class="py-lineno">799</tt> <tt class="py-line"> </tt> |
| 1063 | <a name="L800"></a><tt class="py-lineno">800</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">OAuth2Handler</tt> </tt> |
| 1064 | </div><a name="L801"></a><tt class="py-lineno">801</tt> <tt class="py-line"> </tt> |
| 1065 | <a name="OAuth2Decorator.callback_application"></a><div id="OAuth2Decorator.callback_application-def"><a name="L802"></a><tt class="py-lineno">802</tt> <a class="py-toggle" href="#" id="OAuth2Decorator.callback_application-toggle" onclick="return toggle('OAuth2Decorator.callback_application');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2Decorator-class.html#callback_application">callback_application</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1066 | </div><div id="OAuth2Decorator.callback_application-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2Decorator.callback_application-expanded"><a name="L803"></a><tt class="py-lineno">803</tt> <tt class="py-line"> <tt class="py-docstring">"""WSGI application for handling the OAuth 2.0 redirect callback.</tt> </tt> |
| 1067 | <a name="L804"></a><tt class="py-lineno">804</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1068 | <a name="L805"></a><tt class="py-lineno">805</tt> <tt class="py-line"><tt class="py-docstring"> If you need finer grained control use `callback_handler` which returns just</tt> </tt> |
| 1069 | <a name="L806"></a><tt class="py-lineno">806</tt> <tt class="py-line"><tt class="py-docstring"> the webapp.RequestHandler.</tt> </tt> |
| 1070 | <a name="L807"></a><tt class="py-lineno">807</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1071 | <a name="L808"></a><tt class="py-lineno">808</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| 1072 | <a name="L809"></a><tt class="py-lineno">809</tt> <tt class="py-line"><tt class="py-docstring"> A webapp.WSGIApplication that handles the redirect back from the</tt> </tt> |
| 1073 | <a name="L810"></a><tt class="py-lineno">810</tt> <tt class="py-line"><tt class="py-docstring"> server during the OAuth 2.0 dance.</tt> </tt> |
| 1074 | <a name="L811"></a><tt class="py-lineno">811</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1075 | <a name="L812"></a><tt class="py-lineno">812</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">webapp</tt><tt class="py-op">.</tt><tt class="py-name">WSGIApplication</tt><tt class="py-op">(</tt><tt class="py-op">[</tt> </tt> |
| 1076 | <a name="L813"></a><tt class="py-lineno">813</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-232" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator.callback_path" class="py-name" href="#" onclick="return doclink('link-232', 'callback_path', 'link-175');">callback_path</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-233" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator.callback_handler()=oauth2client.appengine.OAuth2Decorator-class.html#callback_handler"><a title="oauth2client.appengine.OAuth2Decorator.callback_handler" class="py-name" href="#" onclick="return doclink('link-233', 'callback_handler', 'link-233');">callback_handler</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| 1077 | <a name="L814"></a><tt class="py-lineno">814</tt> <tt class="py-line"> <tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| 1078 | </div></div><a name="L815"></a><tt class="py-lineno">815</tt> <tt class="py-line"> </tt> |
| 1079 | <a name="OAuth2DecoratorFromClientSecrets"></a><div id="OAuth2DecoratorFromClientSecrets-def"><a name="L816"></a><tt class="py-lineno">816</tt> <tt class="py-line"> </tt> |
| 1080 | <a name="L817"></a><tt class="py-lineno">817</tt> <a class="py-toggle" href="#" id="OAuth2DecoratorFromClientSecrets-toggle" onclick="return toggle('OAuth2DecoratorFromClientSecrets');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html">OAuth2DecoratorFromClientSecrets</a><tt class="py-op">(</tt><tt class="py-base-class">OAuth2Decorator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| 1081 | </div><div id="OAuth2DecoratorFromClientSecrets-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="OAuth2DecoratorFromClientSecrets-expanded"><a name="L818"></a><tt class="py-lineno">818</tt> <tt class="py-line"> <tt class="py-docstring">"""An OAuth2Decorator that builds from a clientsecrets file.</tt> </tt> |
| 1082 | <a name="L819"></a><tt class="py-lineno">819</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1083 | <a name="L820"></a><tt class="py-lineno">820</tt> <tt class="py-line"><tt class="py-docstring"> Uses a clientsecrets file as the source for all the information when</tt> </tt> |
| 1084 | <a name="L821"></a><tt class="py-lineno">821</tt> <tt class="py-line"><tt class="py-docstring"> constructing an OAuth2Decorator.</tt> </tt> |
| 1085 | <a name="L822"></a><tt class="py-lineno">822</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1086 | <a name="L823"></a><tt class="py-lineno">823</tt> <tt class="py-line"><tt class="py-docstring"> Example:</tt> </tt> |
| 1087 | <a name="L824"></a><tt class="py-lineno">824</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1088 | <a name="L825"></a><tt class="py-lineno">825</tt> <tt class="py-line"><tt class="py-docstring"> decorator = OAuth2DecoratorFromClientSecrets(</tt> </tt> |
| 1089 | <a name="L826"></a><tt class="py-lineno">826</tt> <tt class="py-line"><tt class="py-docstring"> os.path.join(os.path.dirname(__file__), 'client_secrets.json')</tt> </tt> |
| 1090 | <a name="L827"></a><tt class="py-lineno">827</tt> <tt class="py-line"><tt class="py-docstring"> scope='https://www.googleapis.com/auth/plus')</tt> </tt> |
| 1091 | <a name="L828"></a><tt class="py-lineno">828</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1092 | <a name="L829"></a><tt class="py-lineno">829</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1093 | <a name="L830"></a><tt class="py-lineno">830</tt> <tt class="py-line"><tt class="py-docstring"> class MainHandler(webapp.RequestHandler):</tt> </tt> |
| 1094 | <a name="L831"></a><tt class="py-lineno">831</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1095 | <a name="L832"></a><tt class="py-lineno">832</tt> <tt class="py-line"><tt class="py-docstring"> @decorator.oauth_required</tt> </tt> |
| 1096 | <a name="L833"></a><tt class="py-lineno">833</tt> <tt class="py-line"><tt class="py-docstring"> def get(self):</tt> </tt> |
| 1097 | <a name="L834"></a><tt class="py-lineno">834</tt> <tt class="py-line"><tt class="py-docstring"> http = decorator.http()</tt> </tt> |
| 1098 | <a name="L835"></a><tt class="py-lineno">835</tt> <tt class="py-line"><tt class="py-docstring"> # http is authorized with the user's Credentials and can be used</tt> </tt> |
| 1099 | <a name="L836"></a><tt class="py-lineno">836</tt> <tt class="py-line"><tt class="py-docstring"> # in API calls</tt> </tt> |
| 1100 | <a name="L837"></a><tt class="py-lineno">837</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1101 | <a name="L838"></a><tt class="py-lineno">838</tt> <tt class="py-line"> </tt> |
| 1102 | <a name="L839"></a><tt class="py-lineno">839</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-234', 'positional', 'link-78');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt> </tt> |
| 1103 | <a name="OAuth2DecoratorFromClientSecrets.__init__"></a><div id="OAuth2DecoratorFromClientSecrets.__init__-def"><a name="L840"></a><tt class="py-lineno">840</tt> <a class="py-toggle" href="#" id="OAuth2DecoratorFromClientSecrets.__init__-toggle" onclick="return toggle('OAuth2DecoratorFromClientSecrets.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">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> |
| 1104 | </div><div id="OAuth2DecoratorFromClientSecrets.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="OAuth2DecoratorFromClientSecrets.__init__-expanded"><a name="L841"></a><tt class="py-lineno">841</tt> <tt class="py-line"> <tt class="py-docstring">"""Constructor</tt> </tt> |
| 1105 | <a name="L842"></a><tt class="py-lineno">842</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1106 | <a name="L843"></a><tt class="py-lineno">843</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1107 | <a name="L844"></a><tt class="py-lineno">844</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, File name of client secrets.</tt> </tt> |
| 1108 | <a name="L845"></a><tt class="py-lineno">845</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or iterable of strings, scope(s) of the credentials being</tt> </tt> |
| 1109 | <a name="L846"></a><tt class="py-lineno">846</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 1110 | <a name="L847"></a><tt class="py-lineno">847</tt> <tt class="py-line"><tt class="py-docstring"> message: string, A friendly string to display to the user if the</tt> </tt> |
| 1111 | <a name="L848"></a><tt class="py-lineno">848</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets file is missing or invalid. The message may contain HTML</tt> </tt> |
| 1112 | <a name="L849"></a><tt class="py-lineno">849</tt> <tt class="py-line"><tt class="py-docstring"> and will be presented on the web interface for any method that uses the</tt> </tt> |
| 1113 | <a name="L850"></a><tt class="py-lineno">850</tt> <tt class="py-line"><tt class="py-docstring"> decorator.</tt> </tt> |
| 1114 | <a name="L851"></a><tt class="py-lineno">851</tt> <tt class="py-line"><tt class="py-docstring"> cache: An optional cache service client that implements get() and set()</tt> </tt> |
| 1115 | <a name="L852"></a><tt class="py-lineno">852</tt> <tt class="py-line"><tt class="py-docstring"> methods. See clientsecrets.loadfile() for details.</tt> </tt> |
| 1116 | <a name="L853"></a><tt class="py-lineno">853</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1117 | <a name="L854"></a><tt class="py-lineno">854</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-235" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-235', 'clientsecrets', 'link-20');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-236" 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-236', 'loadfile', 'link-236');">loadfile</a></tt><tt class="py-op">(</tt><tt id="link-237" 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 |
| 1118 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-237', 'filename', 'link-237');">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> |
| 1119 | <a name="L855"></a><tt class="py-lineno">855</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">client_type</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt> </tt> |
| 1120 | <a name="L856"></a><tt class="py-lineno">856</tt> <tt class="py-line"> <tt id="link-238" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-238', 'clientsecrets', 'link-20');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-239" 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-239', 'TYPE_WEB', 'link-239');">TYPE_WEB</a></tt><tt class="py-op">,</tt> <tt id="link-240" class="py-name"><a title="oauth2client.clientsecrets" class="py-name" href="#" onclick="return doclink('link-240', 'clientsecrets', 'link-20');">clientsecrets</a></tt><tt class="py-op">.</tt><tt id="link-241" 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-241', 'TYPE_INSTALLED', 'link-241');">TYPE_INSTALLED</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt> |
| 1121 | <a name="L857"></a><tt class="py-lineno">857</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-242" 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 |
| 1122 | oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-242', 'InvalidClientSecretsError', 'link-242');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt> </tt> |
| 1123 | <a name="L858"></a><tt class="py-lineno">858</tt> <tt class="py-line"> <tt class="py-string">'OAuth2Decorator doesn\'t support this OAuth 2.0 flow.'</tt><tt class="py-op">)</tt> </tt> |
| 1124 | <a name="L859"></a><tt class="py-lineno">859</tt> <tt class="py-line"> <tt class="py-name">constructor_kwargs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt> |
| 1125 | <a name="L860"></a><tt class="py-lineno">860</tt> <tt class="py-line"> <tt class="py-string">'auth_uri'</tt><tt class="py-op">:</tt> <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> |
| 1126 | <a name="L861"></a><tt class="py-lineno">861</tt> <tt class="py-line"> <tt class="py-string">'token_uri'</tt><tt class="py-op">:</tt> <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> |
| 1127 | <a name="L862"></a><tt class="py-lineno">862</tt> <tt class="py-line"> <tt class="py-string">'message'</tt><tt class="py-op">:</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> </tt> |
| 1128 | <a name="L863"></a><tt class="py-lineno">863</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| 1129 | <a name="L864"></a><tt class="py-lineno">864</tt> <tt class="py-line"> <tt class="py-name">revoke_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">client_info</tt><tt class="py-op">.</tt><tt id="link-243" class="py-name"><a title="apiclient.schema.Schemas.get |
| 1130 | oauth2client.client.MemoryCache.get |
| 1131 | oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-243', 'get', 'link-57');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">'revoke_uri'</tt><tt class="py-op">)</tt> </tt> |
| 1132 | <a name="L865"></a><tt class="py-lineno">865</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">revoke_uri</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> |
| 1133 | <a name="L866"></a><tt class="py-lineno">866</tt> <tt class="py-line"> <tt class="py-name">constructor_kwargs</tt><tt class="py-op">[</tt><tt class="py-string">'revoke_uri'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">revoke_uri</tt> </tt> |
| 1134 | <a name="L867"></a><tt class="py-lineno">867</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-244" class="py-name" targets="Class oauth2client.appengine.OAuth2DecoratorFromClientSecrets=oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html"><a title="oauth2client.appengine.OAuth2DecoratorFromClientSecrets" class="py-name" href="#" onclick="return doclink('link-244', 'OAuth2DecoratorFromClientSecrets', 'link-244');">OAuth2DecoratorFromClientSecrets</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-245" class="py-name"><a title="apiclient.discovery.Resource.__init__ |
| 1135 | apiclient.discovery.ResourceMethodParameters.__init__ |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1136 | apiclient.errors.BatchError.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1137 | apiclient.errors.HttpError.__init__ |
| 1138 | apiclient.errors.UnexpectedBodyError.__init__ |
| 1139 | apiclient.errors.UnexpectedMethodError.__init__ |
| 1140 | apiclient.http.BatchHttpRequest.__init__ |
| 1141 | apiclient.http.HttpMock.__init__ |
| 1142 | apiclient.http.HttpMockSequence.__init__ |
| 1143 | apiclient.http.HttpRequest.__init__ |
| 1144 | apiclient.http.HttpRequestMock.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1145 | apiclient.http.MediaDownloadProgress.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1146 | apiclient.http.MediaFileUpload.__init__ |
| 1147 | apiclient.http.MediaInMemoryUpload.__init__ |
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 1148 | apiclient.http.MediaIoBaseDownload.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1149 | apiclient.http.MediaIoBaseUpload.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1150 | apiclient.http.MediaUploadProgress.__init__ |
| 1151 | apiclient.http.RequestMockBuilder.__init__ |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 1152 | apiclient.http._StreamSlice.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1153 | apiclient.model.JsonModel.__init__ |
| 1154 | apiclient.model.ProtocolBufferModel.__init__ |
| Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 1155 | apiclient.push.Channel.__init__ |
| 1156 | apiclient.push.Headers.__init__ |
| 1157 | apiclient.push.Subscription.__init__ |
| 1158 | apiclient.push.WebhookChannel.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1159 | apiclient.schema.Schemas.__init__ |
| 1160 | apiclient.schema._SchemaToStruct.__init__ |
| 1161 | oauth2client.appengine.AppAssertionCredentials.__init__ |
| 1162 | oauth2client.appengine.OAuth2Decorator.__init__ |
| 1163 | oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| 1164 | oauth2client.appengine.StorageByKeyName.__init__ |
| 1165 | oauth2client.client.AccessTokenCredentials.__init__ |
| 1166 | oauth2client.client.AssertionCredentials.__init__ |
| 1167 | oauth2client.client.MemoryCache.__init__ |
| 1168 | oauth2client.client.OAuth2Credentials.__init__ |
| 1169 | oauth2client.client.OAuth2WebServerFlow.__init__ |
| 1170 | oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1171 | oauth2client.django_orm.CredentialsField.__init__ |
| 1172 | oauth2client.django_orm.FlowField.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1173 | oauth2client.django_orm.Storage.__init__ |
| 1174 | oauth2client.file.Storage.__init__ |
| Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 1175 | oauth2client.gce.AppAssertionCredentials.__init__ |
| Joe Gregorio | ad8013f | 2012-08-03 08:44:02 -0400 | [diff] [blame] | 1176 | oauth2client.keyring_storage.Storage.__init__ |
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 1177 | oauth2client.locked_file.LockedFile.__init__ |
| 1178 | oauth2client.locked_file._Opener.__init__ |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1179 | oauth2client.multistore_file._MultiStore._Storage.__init__ |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1180 | oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-245', '__init__', 'link-82');">__init__</a></tt><tt class="py-op">(</tt> </tt> |
| 1181 | <a name="L868"></a><tt class="py-lineno">868</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 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> |
| 1182 | <a name="L869"></a><tt class="py-lineno">869</tt> <tt class="py-line"> <tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">constructor_kwargs</tt><tt class="py-op">)</tt> </tt> |
| 1183 | <a name="L870"></a><tt class="py-lineno">870</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">message</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> |
| 1184 | <a name="L871"></a><tt class="py-lineno">871</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt> <tt class="py-op">=</tt> <tt class="py-name">message</tt> </tt> |
| 1185 | <a name="L872"></a><tt class="py-lineno">872</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| 1186 | <a name="L873"></a><tt class="py-lineno">873</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt> <tt class="py-op">=</tt> <tt class="py-string">'Please configure your application for OAuth 2.0.'</tt> </tt> |
| 1187 | </div></div><a name="L874"></a><tt class="py-lineno">874</tt> <tt class="py-line"> </tt> |
| 1188 | <a name="oauth2decorator_from_clientsecrets"></a><div id="oauth2decorator_from_clientsecrets-def"><a name="L875"></a><tt class="py-lineno">875</tt> <tt class="py-line"> </tt> |
| 1189 | <a name="L876"></a><tt class="py-lineno">876</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-246" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-246', 'positional', 'link-78');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt> |
| 1190 | <a name="L877"></a><tt class="py-lineno">877</tt> <a class="py-toggle" href="#" id="oauth2decorator_from_clientsecrets-toggle" onclick="return toggle('oauth2decorator_from_clientsecrets');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.appengine-module.html#oauth2decorator_from_clientsecrets">oauth2decorator_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> |
| 1191 | <a name="L878"></a><tt class="py-lineno">878</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 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> |
| 1192 | </div><div id="oauth2decorator_from_clientsecrets-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="oauth2decorator_from_clientsecrets-expanded"><a name="L879"></a><tt class="py-lineno">879</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates an OAuth2Decorator populated from a clientsecrets file.</tt> </tt> |
| 1193 | <a name="L880"></a><tt class="py-lineno">880</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1194 | <a name="L881"></a><tt class="py-lineno">881</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| 1195 | <a name="L882"></a><tt class="py-lineno">882</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, File name of client secrets.</tt> </tt> |
| 1196 | <a name="L883"></a><tt class="py-lineno">883</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or list of strings, scope(s) of the credentials being</tt> </tt> |
| 1197 | <a name="L884"></a><tt class="py-lineno">884</tt> <tt class="py-line"><tt class="py-docstring"> requested.</tt> </tt> |
| 1198 | <a name="L885"></a><tt class="py-lineno">885</tt> <tt class="py-line"><tt class="py-docstring"> message: string, A friendly string to display to the user if the</tt> </tt> |
| 1199 | <a name="L886"></a><tt class="py-lineno">886</tt> <tt class="py-line"><tt class="py-docstring"> clientsecrets file is missing or invalid. The message may contain HTML and</tt> </tt> |
| 1200 | <a name="L887"></a><tt class="py-lineno">887</tt> <tt class="py-line"><tt class="py-docstring"> will be presented on the web interface for any method that uses the</tt> </tt> |
| 1201 | <a name="L888"></a><tt class="py-lineno">888</tt> <tt class="py-line"><tt class="py-docstring"> decorator.</tt> </tt> |
| 1202 | <a name="L889"></a><tt class="py-lineno">889</tt> <tt class="py-line"><tt class="py-docstring"> cache: An optional cache service client that implements get() and set()</tt> </tt> |
| 1203 | <a name="L890"></a><tt class="py-lineno">890</tt> <tt class="py-line"><tt class="py-docstring"> methods. See clientsecrets.loadfile() for details.</tt> </tt> |
| 1204 | <a name="L891"></a><tt class="py-lineno">891</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1205 | <a name="L892"></a><tt class="py-lineno">892</tt> <tt class="py-line"><tt class="py-docstring"> Returns: An OAuth2Decorator</tt> </tt> |
| 1206 | <a name="L893"></a><tt class="py-lineno">893</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| 1207 | <a name="L894"></a><tt class="py-lineno">894</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| 1208 | <a name="L895"></a><tt class="py-lineno">895</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-247" class="py-name"><a title="oauth2client.appengine.OAuth2DecoratorFromClientSecrets" class="py-name" href="#" onclick="return doclink('link-247', 'OAuth2DecoratorFromClientSecrets', 'link-244');">OAuth2DecoratorFromClientSecrets</a></tt><tt class="py-op">(</tt><tt id="link-248" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename |
| 1209 | oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-248', 'filename', 'link-237');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt> |
| 1210 | <a name="L896"></a><tt class="py-lineno">896</tt> <tt class="py-line"> <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> |
| 1211 | </div><a name="L897"></a><tt class="py-lineno">897</tt> <tt class="py-line"> </tt><script type="text/javascript"> |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1212 | <!-- |
| 1213 | expandto(location.href); |
| 1214 | // --> |
| 1215 | </script> |
| 1216 | </pre> |
| 1217 | <br /> |
| 1218 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 1219 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 1220 | bgcolor="#a0c0ff" cellspacing="0"> |
| 1221 | <tr valign="middle"> |
| 1222 | |
| 1223 | <!-- Tree link --> |
| 1224 | <th> <a |
| 1225 | href="module-tree.html">Trees</a> </th> |
| 1226 | |
| 1227 | <!-- Index link --> |
| 1228 | <th> <a |
| 1229 | href="identifier-index.html">Indices</a> </th> |
| 1230 | |
| 1231 | <!-- Help link --> |
| 1232 | <th> <a |
| 1233 | href="help.html">Help</a> </th> |
| 1234 | |
| 1235 | <th class="navbar" width="100%"></th> |
| 1236 | </tr> |
| 1237 | </table> |
| 1238 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 1239 | <tr> |
| 1240 | <td align="left" class="footer"> |
| Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 1241 | Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013 |
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 1242 | </td> |
| 1243 | <td align="right" class="footer"> |
| 1244 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 1245 | >http://epydoc.sourceforge.net</a> |
| 1246 | </td> |
| 1247 | </tr> |
| 1248 | </table> |
| 1249 | |
| 1250 | <script type="text/javascript"> |
| 1251 | <!-- |
| 1252 | // Private objects are initially displayed (because if |
| 1253 | // javascript is turned off then we want them to be |
| 1254 | // visible); but by default, we want to hide them. So hide |
| 1255 | // them unless we have a cookie that says to show them. |
| 1256 | checkCookie(); |
| 1257 | // --> |
| 1258 | </script> |
| 1259 | </body> |
| 1260 | </html> |