Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1b425aab261532e775551125c8f7aca3562de144 / . / docs / epy / oauth2client.clientsecrets-pysrc.html
blob: aab9d1d1d764b073f9c39d10569da7b599340a9d [file] [log] [blame]
Joe Gregorio5dc0f5c2012-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.clientsecrets</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>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;oauth2client</a> ::
38 Module&nbsp;clientsecrets
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&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.clientsecrets-pysrc.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<h1 class="epydoc">Source Code for <a href="oauth2client.clientsecrets-module.html">Module oauth2client.clientsecrets</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) 2011 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 reading OAuth 2.0 client secret files.</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">A client_secrets.json file contains all the information needed to interact with</tt> </tt>
73<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">an OAuth 2.0 protected service.</tt> </tt>
74<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
75<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"> </tt>
76<a name="L21"></a><tt class="py-lineno"> 21</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>
77<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> </tt>
78<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt>
79<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module oauth2client.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" class="py-name" href="#" onclick="return doclink('link-0', 'anyjson', 'link-0');">anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt>
80<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt>
81<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-comment"># Properties that make a client_secrets.json file valid.</tt> </tt>
82<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt id="link-1" 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-1', 'TYPE_WEB', 'link-1');">TYPE_WEB</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'web'</tt> </tt>
83<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt id="link-2" 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-2', 'TYPE_INSTALLED', 'link-2');">TYPE_INSTALLED</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'installed'</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 id="link-3" class="py-name" targets="Variable oauth2client.clientsecrets.VALID_CLIENT=oauth2client.clientsecrets-module.html#VALID_CLIENT"><a title="oauth2client.clientsecrets.VALID_CLIENT" class="py-name" href="#" onclick="return doclink('link-3', 'VALID_CLIENT', 'link-3');">VALID_CLIENT</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
86<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> <tt id="link-4" class="py-name"><a title="oauth2client.clientsecrets.TYPE_WEB" class="py-name" href="#" onclick="return doclink('link-4', 'TYPE_WEB', 'link-1');">TYPE_WEB</a></tt><tt class="py-op">:</tt> <tt class="py-op">{</tt> </tt>
87<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-op">[</tt> </tt>
88<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">,</tt> </tt>
89<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt><tt class="py-op">,</tt> </tt>
90<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> <tt class="py-string">'redirect_uris'</tt><tt class="py-op">,</tt> </tt>
91<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-string">'auth_uri'</tt><tt class="py-op">,</tt> </tt>
92<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-string">'token_uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
93<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> <tt class="py-op">[</tt> </tt>
94<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">,</tt> </tt>
95<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt> </tt>
96<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
97<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-op">}</tt><tt class="py-op">,</tt> </tt>
98<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt id="link-5" class="py-name"><a title="oauth2client.clientsecrets.TYPE_INSTALLED" class="py-name" href="#" onclick="return doclink('link-5', 'TYPE_INSTALLED', 'link-2');">TYPE_INSTALLED</a></tt><tt class="py-op">:</tt> <tt class="py-op">{</tt> </tt>
99<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-string">'required'</tt><tt class="py-op">:</tt> <tt class="py-op">[</tt> </tt>
100<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">,</tt> </tt>
101<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt><tt class="py-op">,</tt> </tt>
102<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-string">'redirect_uris'</tt><tt class="py-op">,</tt> </tt>
103<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-string">'auth_uri'</tt><tt class="py-op">,</tt> </tt>
104<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-string">'token_uri'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
105<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-string">'string'</tt><tt class="py-op">:</tt> <tt class="py-op">[</tt> </tt>
106<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-string">'client_id'</tt><tt class="py-op">,</tt> </tt>
107<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-string">'client_secret'</tt> </tt>
108<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
109<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
110<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
111<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt>
112<a name="Error"></a><div id="Error-def"><a name="L57"></a><tt class="py-lineno"> 57</tt> <a class="py-toggle" href="#" id="Error-toggle" onclick="return toggle('Error');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.clientsecrets.Error-class.html">Error</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
113</div><div id="Error-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Error-expanded"><a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-docstring">"""Base error for this module."""</tt> </tt>
114<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
115</div><a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> </tt>
116<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
117<a name="InvalidClientSecretsError"></a><div id="InvalidClientSecretsError-def"><a name="L62"></a><tt class="py-lineno"> 62</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.clientsecrets.InvalidClientSecretsError-class.html">InvalidClientSecretsError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
118</div><div id="InvalidClientSecretsError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidClientSecretsError-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-docstring">"""Format of ClientSecrets file is invalid."""</tt> </tt>
119<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
120</div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
121<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt>
122<a name="_validate_clientsecrets"></a><div id="_validate_clientsecrets-def"><a name="L67"></a><tt class="py-lineno"> 67</tt> <a class="py-toggle" href="#" id="_validate_clientsecrets-toggle" onclick="return toggle('_validate_clientsecrets');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.clientsecrets-module.html#_validate_clientsecrets">_validate_clientsecrets</a><tt class="py-op">(</tt><tt class="py-param">obj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
123</div><div id="_validate_clientsecrets-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_validate_clientsecrets-expanded"><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">obj</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
124<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-6" 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
125oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-6', 'InvalidClientSecretsError', 'link-6');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Invalid file format.'</tt><tt class="py-op">)</tt> </tt>
126<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-name">client_type</tt> <tt class="py-op">=</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
127<a name="L71"></a><tt class="py-lineno"> 71</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 id="link-7" class="py-name"><a title="oauth2client.clientsecrets.VALID_CLIENT" class="py-name" href="#" onclick="return doclink('link-7', 'VALID_CLIENT', 'link-3');">VALID_CLIENT</a></tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
128<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-8" class="py-name"><a title="oauth2client.appengine.InvalidClientSecretsError
129oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-8', 'InvalidClientSecretsError', 'link-6');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unknown client type: %s.'</tt> <tt class="py-op">%</tt> <tt class="py-name">client_type</tt><tt class="py-op">)</tt> </tt>
130<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-name">client_info</tt> <tt class="py-op">=</tt> <tt class="py-name">obj</tt><tt class="py-op">[</tt><tt class="py-name">client_type</tt><tt class="py-op">]</tt> </tt>
131<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">prop_name</tt> <tt class="py-keyword">in</tt> <tt id="link-9" class="py-name"><a title="oauth2client.clientsecrets.VALID_CLIENT" class="py-name" href="#" onclick="return doclink('link-9', 'VALID_CLIENT', 'link-3');">VALID_CLIENT</a></tt><tt class="py-op">[</tt><tt class="py-name">client_type</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'required'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
132<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prop_name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">client_info</tt><tt class="py-op">:</tt> </tt>
133<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-10" class="py-name"><a title="oauth2client.appengine.InvalidClientSecretsError
134oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-10', 'InvalidClientSecretsError', 'link-6');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt> </tt>
135<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-string">'Missing property "%s" in a client type of "%s".'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">prop_name</tt><tt class="py-op">,</tt> </tt>
136<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-name">client_type</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
137<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">prop_name</tt> <tt class="py-keyword">in</tt> <tt id="link-11" class="py-name"><a title="oauth2client.clientsecrets.VALID_CLIENT" class="py-name" href="#" onclick="return doclink('link-11', 'VALID_CLIENT', 'link-3');">VALID_CLIENT</a></tt><tt class="py-op">[</tt><tt class="py-name">client_type</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-string">'string'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
138<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">client_info</tt><tt class="py-op">[</tt><tt class="py-name">prop_name</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'[['</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
139<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-12" class="py-name"><a title="oauth2client.appengine.InvalidClientSecretsError
140oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-12', 'InvalidClientSecretsError', 'link-6');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt> </tt>
141<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-string">'Property "%s" is not configured.'</tt> <tt class="py-op">%</tt> <tt class="py-name">prop_name</tt><tt class="py-op">)</tt> </tt>
142<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">client_type</tt><tt class="py-op">,</tt> <tt class="py-name">client_info</tt> </tt>
143</div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
144<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
145<a name="load"></a><div id="load-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="load-toggle" onclick="return toggle('load');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.clientsecrets-module.html#load">load</a><tt class="py-op">(</tt><tt class="py-param">fp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
146</div><div id="load-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="load-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Function oauth2client.clientsecrets.load()=oauth2client.clientsecrets-module.html#load"><a title="oauth2client.clientsecrets.load" class="py-name" href="#" onclick="return doclink('link-13', 'load', 'link-13');">load</a></tt><tt class="py-op">(</tt><tt class="py-name">fp</tt><tt class="py-op">)</tt> </tt>
147<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-14" class="py-name" targets="Function oauth2client.clientsecrets._validate_clientsecrets()=oauth2client.clientsecrets-module.html#_validate_clientsecrets"><a title="oauth2client.clientsecrets._validate_clientsecrets" class="py-name" href="#" onclick="return doclink('link-14', '_validate_clientsecrets', 'link-14');">_validate_clientsecrets</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
148</div><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> </tt>
149<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
150<a name="loads"></a><div id="loads-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="loads-toggle" onclick="return toggle('loads');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.clientsecrets-module.html#loads">loads</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
151</div><div id="loads-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="loads-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-15" 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-15', 'loads', 'link-15');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
152<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-16" class="py-name"><a title="oauth2client.clientsecrets._validate_clientsecrets" class="py-name" href="#" onclick="return doclink('link-16', '_validate_clientsecrets', 'link-14');">_validate_clientsecrets</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
153</div><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
154<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]155<a name="_loadfile"></a><div id="_loadfile-def"><a name="L96"></a><tt class="py-lineno"> 96</tt> <a class="py-toggle" href="#" id="_loadfile-toggle" onclick="return toggle('_loadfile');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.clientsecrets-module.html#_loadfile">_loadfile</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
156</div><div id="_loadfile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_loadfile-expanded"><a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]157<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt id="link-17" class="py-name" targets="Module oauth2client.file=oauth2client.file-module.html"><a title="oauth2client.file" class="py-name" href="#" onclick="return doclink('link-17', 'file', 'link-17');">file</a></tt><tt class="py-op">(</tt><tt id="link-18" 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
158oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-18', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt> </tt>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]159<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]160<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="oauth2client.clientsecrets.load" class="py-name" href="#" onclick="return doclink('link-19', 'load', 'link-13');">load</a></tt><tt class="py-op">(</tt><tt class="py-name">fp</tt><tt class="py-op">)</tt> </tt>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]161<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
162<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-name">fp</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
163<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]164<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-20" class="py-name"><a title="oauth2client.appengine.InvalidClientSecretsError
165oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" onclick="return doclink('link-20', 'InvalidClientSecretsError', 'link-6');">InvalidClientSecretsError</a></tt><tt class="py-op">(</tt><tt class="py-string">'File not found: "%s"'</tt> <tt class="py-op">%</tt> <tt id="link-21" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
166oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-21', 'filename', 'link-18');">filename</a></tt><tt class="py-op">)</tt> </tt>
167<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-22" class="py-name"><a title="oauth2client.clientsecrets._validate_clientsecrets" class="py-name" href="#" onclick="return doclink('link-22', '_validate_clientsecrets', 'link-14');">_validate_clientsecrets</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]168</div><a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt>
169<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> </tt>
170<a name="loadfile"></a><div id="loadfile-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="loadfile-toggle" onclick="return toggle('loadfile');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.clientsecrets-module.html#loadfile">loadfile</a><tt class="py-op">(</tt><tt class="py-param">filename</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>
171</div><div id="loadfile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="loadfile-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""Loading of client_secrets JSON file, optionally backed by a cache.</tt> </tt>
172<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
173<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> Typical cache storage would be App Engine memcache service,</tt> </tt>
174<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> but you can pass in any other cache client that implements</tt> </tt>
175<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> these methods:</tt> </tt>
176<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> - get(key, namespace=ns)</tt> </tt>
177<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> - set(key, value, namespace=ns)</tt> </tt>
178<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
179<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> Usage:</tt> </tt>
180<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> # without caching</tt> </tt>
181<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> client_type, client_info = loadfile('secrets.json')</tt> </tt>
182<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> # using App Engine memcache service</tt> </tt>
183<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> from google.appengine.api import memcache</tt> </tt>
184<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> client_type, client_info = loadfile('secrets.json', cache=memcache)</tt> </tt>
185<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
186<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
187<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, Path to a client_secrets.json file on a filesystem.</tt> </tt>
188<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> cache: An optional cache service client that implements get() and set() </tt> </tt>
189<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> methods. If not specified, the file is always being loaded from</tt> </tt>
190<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> a filesystem.</tt> </tt>
191<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
192<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
193<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> InvalidClientSecretsError: In case of a validation error or some </tt> </tt>
194<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> I/O failure. Can happen only on cache miss.</tt> </tt>
195<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
196<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
197<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> (client_type, client_info) tuple, as _loadfile() normally would. </tt> </tt>
198<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> JSON contents is validated only during first load. Cache hits are not</tt> </tt>
199<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> validated.</tt> </tt>
200<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
201<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-name">_SECRET_NAMESPACE</tt> <tt class="py-op">=</tt> <tt class="py-string">'oauth2client:secrets#ns'</tt> </tt>
202<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
203<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">cache</tt><tt class="py-op">:</tt> </tt>
204<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-23" 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-23', '_loadfile', 'link-23');">_loadfile</a></tt><tt class="py-op">(</tt><tt id="link-24" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
205oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-24', 'filename', 'link-18');">filename</a></tt><tt class="py-op">)</tt> </tt>
206<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]207<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-name">cache</tt><tt class="py-op">.</tt><tt id="link-25" 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 Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]208oauth2client.client.MemoryCache.get
209oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-25', 'get', 'link-25');">get</a></tt><tt class="py-op">(</tt><tt id="link-26" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
210oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-26', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt class="py-name">_SECRET_NAMESPACE</tt><tt class="py-op">)</tt> </tt>
211<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">obj</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
212<a name="L146"></a><tt class="py-lineno">146</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-27" class="py-name"><a title="oauth2client.clientsecrets._loadfile" class="py-name" href="#" onclick="return doclink('link-27', '_loadfile', 'link-23');">_loadfile</a></tt><tt class="py-op">(</tt><tt id="link-28" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
213oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-28', 'filename', 'link-18');">filename</a></tt><tt class="py-op">)</tt> </tt>
214<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <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>
215<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-name">cache</tt><tt class="py-op">.</tt><tt id="link-29" 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-29', 'set', 'link-29');">set</a></tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
216oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-30', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt class="py-name">_SECRET_NAMESPACE</tt><tt class="py-op">)</tt> </tt>
217<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> </tt>
218<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">next</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
219</div><a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> </tt><script type="text/javascript">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]220<!--
221expandto(location.href);
222// -->
223</script>
224</pre>
225<br />
226<!-- ==================== NAVIGATION BAR ==================== -->
227<table class="navbar" border="0" width="100%" cellpadding="0"
228 bgcolor="#a0c0ff" cellspacing="0">
229 <tr valign="middle">
230
231 <!-- Tree link -->
232 <th>&nbsp;&nbsp;&nbsp;<a
233 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
234
235 <!-- Index link -->
236 <th>&nbsp;&nbsp;&nbsp;<a
237 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
238
239 <!-- Help link -->
240 <th>&nbsp;&nbsp;&nbsp;<a
241 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
242
243 <th class="navbar" width="100%"></th>
244 </tr>
245</table>
246<table border="0" cellpadding="0" cellspacing="0" width="100%%">
247 <tr>
248 <td align="left" class="footer">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]249 Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:10 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]250 </td>
251 <td align="right" class="footer">
252 <a target="mainFrame" href="http://epydoc.sourceforge.net"
253 >http://epydoc.sourceforge.net</a>
254 </td>
255 </tr>
256</table>
257
258<script type="text/javascript">
259 <!--
260 // Private objects are initially displayed (because if
261 // javascript is turned off then we want them to be
262 // visible); but by default, we want to hide them. So hide
263 // them unless we have a cookie that says to show them.
264 checkCookie();
265 // -->
266</script>
267</body>
268</html>