648 lines
123 KiB
HTML
648 lines
123 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>oauth2client.multistore_file</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="oauth2client-module.html">Package oauth2client</a> ::
|
|
Module multistore_file
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="oauth2client.multistore_file-pysrc.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h1 class="epydoc">Source Code for <a href="oauth2client.multistore_file-module.html">Module oauth2client.multistore_file</a></h1>
|
|
<pre class="py-src">
|
|
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright 2014 Google Inc. All rights reserved.</tt> </tt>
|
|
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
|
|
<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>
|
|
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt>
|
|
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt>
|
|
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">"""Multi-credential file store with lock support.</tt> </tt>
|
|
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">This module implements a JSON credential store where multiple</tt> </tt>
|
|
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">credentials can be stored in one file. That file supports locking</tt> </tt>
|
|
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">both in a single process and across processes.</tt> </tt>
|
|
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring">The credential themselves are keyed off of:</tt> </tt>
|
|
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">* client_id</tt> </tt>
|
|
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">* user_agent</tt> </tt>
|
|
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">* scope</tt> </tt>
|
|
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring">The format of the stored data is like so:</tt> </tt>
|
|
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring">{</tt> </tt>
|
|
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> 'file_version': 1,</tt> </tt>
|
|
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> 'data': [</tt> </tt>
|
|
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> {</tt> </tt>
|
|
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> 'key': {</tt> </tt>
|
|
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> 'clientId': '<client id>',</tt> </tt>
|
|
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> 'userAgent': '<user agent>',</tt> </tt>
|
|
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> 'scope': '<scope>'</tt> </tt>
|
|
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> },</tt> </tt>
|
|
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> 'credential': {</tt> </tt>
|
|
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> # JSON serialized Credentials.</tt> </tt>
|
|
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> }</tt> </tt>
|
|
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> }</tt> </tt>
|
|
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> ]</tt> </tt>
|
|
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring">}</tt> </tt>
|
|
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
|
|
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> </tt>
|
|
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'jbeda@google.com (Joe Beda)'</tt> </tt>
|
|
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt>
|
|
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">json</tt> </tt>
|
|
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
|
|
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
|
|
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">threading</tt> </tt>
|
|
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> </tt>
|
|
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-0', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module oauth2client.client=oauth2client.client-module.html"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-1', 'client', 'link-1');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" 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-2', 'Credentials', 'link-2');">Credentials</a></tt> </tt>
|
|
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-3', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-4', 'client', 'link-1');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" 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
|
|
oauth2client.django_orm.Storage
|
|
oauth2client.file.Storage
|
|
oauth2client.keyring_storage.Storage" class="py-name" href="#" onclick="return doclink('link-5', 'Storage', 'link-5');">Storage</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">BaseStorage</tt> </tt>
|
|
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-6', 'oauth2client', 'link-0');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-7" class="py-name" targets="Module oauth2client.util=oauth2client.util-module.html"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-7', 'util', 'link-7');">util</a></tt> </tt>
|
|
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-8" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-8', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Module oauth2client.locked_file=oauth2client.locked_file-module.html"><a title="oauth2client.locked_file" class="py-name" href="#" onclick="return doclink('link-9', 'locked_file', 'link-9');">locked_file</a></tt> <tt class="py-keyword">import</tt> <tt id="link-10" class="py-name" targets="Class oauth2client.locked_file.LockedFile=oauth2client.locked_file.LockedFile-class.html"><a title="oauth2client.locked_file.LockedFile" class="py-name" href="#" onclick="return doclink('link-10', 'LockedFile', 'link-10');">LockedFile</a></tt> </tt>
|
|
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
|
|
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="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="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-11', 'logger', 'link-11');">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>
|
|
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt>
|
|
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-comment"># A dict from 'filename'->_MultiStore instances</tt> </tt>
|
|
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable oauth2client.multistore_file._multistores=oauth2client.multistore_file-module.html#_multistores"><a title="oauth2client.multistore_file._multistores" class="py-name" href="#" onclick="return doclink('link-12', '_multistores', 'link-12');">_multistores</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt id="link-13" class="py-name" targets="Variable oauth2client.multistore_file._multistores_lock=oauth2client.multistore_file-module.html#_multistores_lock"><a title="oauth2client.multistore_file._multistores_lock" class="py-name" href="#" onclick="return doclink('link-13', '_multistores_lock', 'link-13');">_multistores_lock</a></tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="Error"></a><div id="Error-def"><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
|
|
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> </tt>
|
|
<a name="L63"></a><tt class="py-lineno"> 63</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.multistore_file.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>
|
|
</div><div id="Error-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Error-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-docstring">"""Base error for this module."""</tt> </tt>
|
|
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
</div><a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt>
|
|
<a name="NewerCredentialStoreError"></a><div id="NewerCredentialStoreError-def"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> </tt>
|
|
<a name="L68"></a><tt class="py-lineno"> 68</tt> <a class="py-toggle" href="#" id="NewerCredentialStoreError-toggle" onclick="return toggle('NewerCredentialStoreError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.multistore_file.NewerCredentialStoreError-class.html">NewerCredentialStoreError</a><tt class="py-op">(</tt><tt class="py-base-class">Error</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="NewerCredentialStoreError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="NewerCredentialStoreError-expanded"><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-docstring">"""The credential store is a newer version that supported."""</tt> </tt>
|
|
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
</div><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
|
|
<a name="get_credential_storage"></a><div id="get_credential_storage-def"><a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
|
|
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-14" 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-14', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="get_credential_storage-toggle" onclick="return toggle('get_credential_storage');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file-module.html#get_credential_storage">get_credential_storage</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">client_id</tt><tt class="py-op">,</tt> <tt class="py-param">user_agent</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> </tt>
|
|
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-param">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="get_credential_storage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_credential_storage-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a Storage instance for a credential.</tt> </tt>
|
|
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> filename: The JSON file storing a set of credentials</tt> </tt>
|
|
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> client_id: The client_id for the credential</tt> </tt>
|
|
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> user_agent: The user agent for the credential</tt> </tt>
|
|
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> scope: string or iterable of strings, Scope(s) being requested</tt> </tt>
|
|
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> warn_on_readonly: if True, log a warning if the store is readonly</tt> </tt>
|
|
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> An object derived from client.Storage for getting/setting the</tt> </tt>
|
|
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> credential.</tt> </tt>
|
|
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-comment"># Recreate the legacy key with these specific parameters</tt> </tt>
|
|
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'clientId'</tt><tt class="py-op">:</tt> <tt class="py-name">client_id</tt><tt class="py-op">,</tt> <tt class="py-string">'userAgent'</tt><tt class="py-op">:</tt> <tt class="py-name">user_agent</tt><tt class="py-op">,</tt> </tt>
|
|
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-string">'scope'</tt><tt class="py-op">:</tt> <tt id="link-15" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-15', 'util', 'link-7');">util</a></tt><tt class="py-op">.</tt><tt id="link-16" 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-16', 'scopes_to_string', 'link-16');">scopes_to_string</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">)</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-17" class="py-name" targets="Function oauth2client.multistore_file.get_credential_storage_custom_key()=oauth2client.multistore_file-module.html#get_credential_storage_custom_key"><a title="oauth2client.multistore_file.get_credential_storage_custom_key" class="py-name" href="#" onclick="return doclink('link-17', 'get_credential_storage_custom_key', 'link-17');">get_credential_storage_custom_key</a></tt><tt class="py-op">(</tt> </tt>
|
|
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <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
|
|
oauth2client.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-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">warn_on_readonly</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
|
|
<a name="get_credential_storage_custom_string_key"></a><div id="get_credential_storage_custom_string_key-def"><a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
|
|
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-19', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L97"></a><tt class="py-lineno"> 97</tt> <a class="py-toggle" href="#" id="get_credential_storage_custom_string_key-toggle" onclick="return toggle('get_credential_storage_custom_string_key');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file-module.html#get_credential_storage_custom_string_key">get_credential_storage_custom_string_key</a><tt class="py-op">(</tt> </tt>
|
|
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">key_string</tt><tt class="py-op">,</tt> <tt class="py-param">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="get_credential_storage_custom_string_key-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_credential_storage_custom_string_key-expanded"><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a Storage instance for a credential using a single string as a key.</tt> </tt>
|
|
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> Allows you to provide a string as a custom key that will be used for</tt> </tt>
|
|
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> credential storage and retrieval.</tt> </tt>
|
|
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> filename: The JSON file storing a set of credentials</tt> </tt>
|
|
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> key_string: A string to use as the key for storing this credential.</tt> </tt>
|
|
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> warn_on_readonly: if True, log a warning if the store is readonly</tt> </tt>
|
|
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> An object derived from client.Storage for getting/setting the</tt> </tt>
|
|
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> credential.</tt> </tt>
|
|
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-comment"># Create a key dictionary that can be used</tt> </tt>
|
|
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-name">key_dict</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'key'</tt><tt class="py-op">:</tt> <tt class="py-name">key_string</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-20" class="py-name"><a title="oauth2client.multistore_file.get_credential_storage_custom_key" class="py-name" href="#" onclick="return doclink('link-20', 'get_credential_storage_custom_key', 'link-17');">get_credential_storage_custom_key</a></tt><tt class="py-op">(</tt> </tt>
|
|
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.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 class="py-name">key_dict</tt><tt class="py-op">,</tt> <tt class="py-name">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">warn_on_readonly</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> </tt>
|
|
<a name="get_credential_storage_custom_key"></a><div id="get_credential_storage_custom_key-def"><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> </tt>
|
|
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-22', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L120"></a><tt class="py-lineno">120</tt> <a class="py-toggle" href="#" id="get_credential_storage_custom_key-toggle" onclick="return toggle('get_credential_storage_custom_key');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file-module.html#get_credential_storage_custom_key">get_credential_storage_custom_key</a><tt class="py-op">(</tt> </tt>
|
|
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">key_dict</tt><tt class="py-op">,</tt> <tt class="py-param">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="get_credential_storage_custom_key-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_credential_storage_custom_key-expanded"><a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a Storage instance for a credential using a dictionary as a key.</tt> </tt>
|
|
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> Allows you to provide a dictionary as a custom key that will be used for</tt> </tt>
|
|
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> credential storage and retrieval.</tt> </tt>
|
|
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> filename: The JSON file storing a set of credentials</tt> </tt>
|
|
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> key_dict: A dictionary to use as the key for storing this credential. There</tt> </tt>
|
|
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> is no ordering of the keys in the dictionary. Logically equivalent</tt> </tt>
|
|
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> dictionaries will produce equivalent storage keys.</tt> </tt>
|
|
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> warn_on_readonly: if True, log a warning if the store is readonly</tt> </tt>
|
|
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> An object derived from client.Storage for getting/setting the</tt> </tt>
|
|
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> credential.</tt> </tt>
|
|
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-name">multistore</tt> <tt class="py-op">=</tt> <tt id="link-23" class="py-name" targets="Function oauth2client.multistore_file._get_multistore()=oauth2client.multistore_file-module.html#_get_multistore"><a title="oauth2client.multistore_file._get_multistore" class="py-name" href="#" onclick="return doclink('link-23', '_get_multistore', 'link-23');">_get_multistore</a></tt><tt class="py-op">(</tt><tt id="link-24" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.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 class="py-name">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">warn_on_readonly</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt id="link-25" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-25', 'util', 'link-7');">util</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Function oauth2client.util.dict_to_tuple_key()=oauth2client.util-module.html#dict_to_tuple_key"><a title="oauth2client.util.dict_to_tuple_key" class="py-name" href="#" onclick="return doclink('link-26', 'dict_to_tuple_key', 'link-26');">dict_to_tuple_key</a></tt><tt class="py-op">(</tt><tt class="py-name">key_dict</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">multistore</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._get_storage()=oauth2client.multistore_file._MultiStore-class.html#_get_storage"><a title="oauth2client.multistore_file._MultiStore._get_storage" class="py-name" href="#" onclick="return doclink('link-27', '_get_storage', 'link-27');">_get_storage</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> </tt>
|
|
<a name="get_all_credential_keys"></a><div id="get_all_credential_keys-def"><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt>
|
|
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-28', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L144"></a><tt class="py-lineno">144</tt> <a class="py-toggle" href="#" id="get_all_credential_keys-toggle" onclick="return toggle('get_all_credential_keys');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file-module.html#get_all_credential_keys">get_all_credential_keys</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="get_all_credential_keys-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_all_credential_keys-expanded"><a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-docstring">"""Gets all the registered credential keys in the given Multistore.</tt> </tt>
|
|
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> filename: The JSON file storing a set of credentials</tt> </tt>
|
|
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> warn_on_readonly: if True, log a warning if the store is readonly</tt> </tt>
|
|
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> A list of the credential keys present in the file. They are returned as</tt> </tt>
|
|
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"> dictionaries that can be passed into get_credential_storage_custom_key to</tt> </tt>
|
|
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> get the actual credentials.</tt> </tt>
|
|
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-name">multistore</tt> <tt class="py-op">=</tt> <tt id="link-29" class="py-name"><a title="oauth2client.multistore_file._get_multistore" class="py-name" href="#" onclick="return doclink('link-29', '_get_multistore', 'link-23');">_get_multistore</a></tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.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">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">warn_on_readonly</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> <tt class="py-name">multistore</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._lock()=oauth2client.multistore_file._MultiStore-class.html#_lock"><a title="oauth2client.multistore_file._MultiStore._lock" class="py-name" href="#" onclick="return doclink('link-31', '_lock', 'link-31');">_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">multistore</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._get_all_credential_keys()=oauth2client.multistore_file._MultiStore-class.html#_get_all_credential_keys"><a title="oauth2client.multistore_file._MultiStore._get_all_credential_keys" class="py-name" href="#" onclick="return doclink('link-32', '_get_all_credential_keys', 'link-32');">_get_all_credential_keys</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-name">multistore</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._unlock()=oauth2client.multistore_file._MultiStore-class.html#_unlock"><a title="oauth2client.multistore_file._MultiStore._unlock" class="py-name" href="#" onclick="return doclink('link-33', '_unlock', 'link-33');">_unlock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> </tt>
|
|
<a name="_get_multistore"></a><div id="_get_multistore-def"><a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> </tt>
|
|
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-34', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L165"></a><tt class="py-lineno">165</tt> <a class="py-toggle" href="#" id="_get_multistore-toggle" onclick="return toggle('_get_multistore');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file-module.html#_get_multistore">_get_multistore</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_get_multistore-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_get_multistore-expanded"><a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> <tt class="py-docstring">"""A helper method to initialize the multistore with proper locking.</tt> </tt>
|
|
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> filename: The JSON file storing a set of credentials</tt> </tt>
|
|
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> warn_on_readonly: if True, log a warning if the store is readonly</tt> </tt>
|
|
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> A multistore object</tt> </tt>
|
|
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt id="link-35" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-35', 'filename', 'link-18');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">expanduser</tt><tt class="py-op">(</tt><tt id="link-36" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-36', 'filename', 'link-18');">filename</a></tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt id="link-37" class="py-name"><a title="oauth2client.multistore_file._multistores_lock" class="py-name" href="#" onclick="return doclink('link-37', '_multistores_lock', 'link-13');">_multistores_lock</a></tt><tt class="py-op">.</tt><tt class="py-name">acquire</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-name">multistore</tt> <tt class="py-op">=</tt> <tt id="link-38" class="py-name"><a title="oauth2client.multistore_file._multistores" class="py-name" href="#" onclick="return doclink('link-38', '_multistores', 'link-12');">_multistores</a></tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt> </tt>
|
|
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt id="link-39" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-39', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt id="link-40" class="py-name" targets="Class oauth2client.multistore_file._MultiStore=oauth2client.multistore_file._MultiStore-class.html"><a title="oauth2client.multistore_file._MultiStore" class="py-name" href="#" onclick="return doclink('link-40', '_MultiStore', 'link-40');">_MultiStore</a></tt><tt class="py-op">(</tt><tt id="link-41" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-41', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">warn_on_readonly</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt id="link-42" class="py-name"><a title="oauth2client.multistore_file._multistores_lock" class="py-name" href="#" onclick="return doclink('link-42', '_multistores_lock', 'link-13');">_multistores_lock</a></tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">multistore</tt> </tt>
|
|
</div><a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore"></a><div id="_MultiStore-def"><a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> </tt>
|
|
<a name="L185"></a><tt class="py-lineno">185</tt> <a class="py-toggle" href="#" id="_MultiStore-toggle" onclick="return toggle('_MultiStore');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html">_MultiStore</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_MultiStore-expanded"><a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-docstring">"""A file backed store for multiple credentials."""</tt> </tt>
|
|
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> </tt>
|
|
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-43', 'positional', 'link-14');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="_MultiStore.__init__"></a><div id="_MultiStore.__init__-def"><a name="L189"></a><tt class="py-lineno">189</tt> <a class="py-toggle" href="#" id="_MultiStore.__init__-toggle" onclick="return toggle('_MultiStore.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-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">warn_on_readonly</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore.__init__-expanded"><a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-docstring">"""Initialize the class.</tt> </tt>
|
|
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"> This will create the file if necessary.</tt> </tt>
|
|
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt> <tt class="py-op">=</tt> <tt id="link-44" class="py-name"><a title="oauth2client.locked_file.LockedFile" class="py-name" href="#" onclick="return doclink('link-44', 'LockedFile', 'link-10');">LockedFile</a></tt><tt class="py-op">(</tt><tt id="link-45" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-45', 'filename', 'link-18');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'r+b'</tt><tt class="py-op">,</tt> <tt class="py-string">'rb'</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread_lock</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Lock</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_read_only</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
|
|
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_warn_on_readonly</tt> <tt class="py-op">=</tt> <tt class="py-name">warn_on_readonly</tt> </tt>
|
|
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> </tt>
|
|
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name" targets="Method oauth2client.file.Storage._create_file_if_needed()=oauth2client.file.Storage-class.html#_create_file_if_needed,Method oauth2client.multistore_file._MultiStore._create_file_if_needed()=oauth2client.multistore_file._MultiStore-class.html#_create_file_if_needed"><a title="oauth2client.file.Storage._create_file_if_needed
|
|
oauth2client.multistore_file._MultiStore._create_file_if_needed" class="py-name" href="#" onclick="return doclink('link-46', '_create_file_if_needed', 'link-46');">_create_file_if_needed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> </tt>
|
|
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-comment"># Cache of deserialized store. This is only valid after the</tt> </tt>
|
|
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-comment"># _MultiStore is locked or _refresh_data_cache is called. This is</tt> </tt>
|
|
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-comment"># of the form of:</tt> </tt>
|
|
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-comment">#</tt> </tt>
|
|
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-comment"># ((key, value), (key, value)...) -> OAuth2Credential</tt> </tt>
|
|
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-comment">#</tt> </tt>
|
|
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-comment"># If this is None, then the store hasn't been read yet.</tt> </tt>
|
|
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
|
</div><a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage"></a><div id="_MultiStore._Storage-def"><a name="L210"></a><tt class="py-lineno">210</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage-toggle" onclick="return toggle('_MultiStore._Storage');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html">_Storage</a><tt class="py-op">(</tt><tt class="py-base-class">BaseStorage</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._Storage-expanded"><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt class="py-docstring">"""A Storage object that knows how to read/write a single credential."""</tt> </tt>
|
|
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.__init__"></a><div id="_MultiStore._Storage.__init__-def"><a name="L213"></a><tt class="py-lineno">213</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.__init__-toggle" onclick="return toggle('_MultiStore._Storage.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-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">multistore</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.__init__-expanded"><a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt> <tt class="py-op">=</tt> <tt class="py-name">multistore</tt> </tt>
|
|
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key</tt> <tt class="py-op">=</tt> <tt class="py-name">key</tt> </tt>
|
|
</div><a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.acquire_lock"></a><div id="_MultiStore._Storage.acquire_lock-def"><a name="L217"></a><tt class="py-lineno">217</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.acquire_lock-toggle" onclick="return toggle('_MultiStore._Storage.acquire_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html#acquire_lock">acquire_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.acquire_lock-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.acquire_lock-expanded"><a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-docstring">"""Acquires any lock necessary to access this Storage.</tt> </tt>
|
|
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"><tt class="py-docstring"> This lock is not reentrant.</tt> </tt>
|
|
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="oauth2client.multistore_file._MultiStore._lock" class="py-name" href="#" onclick="return doclink('link-47', '_lock', 'link-31');">_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.release_lock"></a><div id="_MultiStore._Storage.release_lock-def"><a name="L224"></a><tt class="py-lineno">224</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.release_lock-toggle" onclick="return toggle('_MultiStore._Storage.release_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html#release_lock">release_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.release_lock-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.release_lock-expanded"><a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-docstring">"""Release the Storage lock.</tt> </tt>
|
|
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"><tt class="py-docstring"> Trying to release a lock that isn't held will result in a</tt> </tt>
|
|
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"><tt class="py-docstring"> RuntimeError.</tt> </tt>
|
|
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="oauth2client.multistore_file._MultiStore._unlock" class="py-name" href="#" onclick="return doclink('link-48', '_unlock', 'link-33');">_unlock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.locked_get"></a><div id="_MultiStore._Storage.locked_get-def"><a name="L232"></a><tt class="py-lineno">232</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.locked_get-toggle" onclick="return toggle('_MultiStore._Storage.locked_get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html#locked_get">locked_get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.locked_get-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.locked_get-expanded"><a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> <tt class="py-docstring">"""Retrieve credential.</tt> </tt>
|
|
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt>
|
|
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials</tt> </tt>
|
|
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> <tt class="py-name">credential</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._get_credential()=oauth2client.multistore_file._MultiStore-class.html#_get_credential"><a title="oauth2client.multistore_file._MultiStore._get_credential" class="py-name" href="#" onclick="return doclink('link-49', '_get_credential', 'link-49');">_get_credential</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credential</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> <tt class="py-name">credential</tt><tt class="py-op">.</tt><tt id="link-50" 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-50', 'set_store', 'link-50');">set_store</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credential</tt> </tt>
|
|
</div><a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.locked_put"></a><div id="_MultiStore._Storage.locked_put-def"><a name="L245"></a><tt class="py-lineno">245</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.locked_put-toggle" onclick="return toggle('_MultiStore._Storage.locked_put');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html#locked_put">locked_put</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.locked_put-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.locked_put-expanded"><a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-docstring">"""Write a credential.</tt> </tt>
|
|
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt>
|
|
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"><tt class="py-docstring"> credentials: Credentials, the credentials to store.</tt> </tt>
|
|
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._update_credential()=oauth2client.multistore_file._MultiStore-class.html#_update_credential"><a title="oauth2client.multistore_file._MultiStore._update_credential" class="py-name" href="#" onclick="return doclink('link-51', '_update_credential', 'link-51');">_update_credential</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key</tt><tt class="py-op">,</tt> <tt id="link-52" 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,Variable oauth2client.appengine.OAuth2Decorator.credentials=oauth2client.appengine.OAuth2Decorator-class.html#credentials"><a title="oauth2client.appengine.CredentialsModel.credentials
|
|
oauth2client.appengine.CredentialsNDBModel.credentials
|
|
oauth2client.appengine.OAuth2Decorator.credentials" class="py-name" href="#" onclick="return doclink('link-52', 'credentials', 'link-52');">credentials</a></tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._Storage.locked_delete"></a><div id="_MultiStore._Storage.locked_delete-def"><a name="L255"></a><tt class="py-lineno">255</tt> <a class="py-toggle" href="#" id="_MultiStore._Storage.locked_delete-toggle" onclick="return toggle('_MultiStore._Storage.locked_delete');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore._Storage-class.html#locked_delete">locked_delete</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._Storage.locked_delete-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_MultiStore._Storage.locked_delete-expanded"><a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete a credential.</tt> </tt>
|
|
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> The Storage lock must be held when this is called.</tt> </tt>
|
|
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> credentials: Credentials, the credentials to store.</tt> </tt>
|
|
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_multistore</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._delete_credential()=oauth2client.multistore_file._MultiStore-class.html#_delete_credential"><a title="oauth2client.multistore_file._MultiStore._delete_credential" class="py-name" href="#" onclick="return doclink('link-53', '_delete_credential', 'link-53');">_delete_credential</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_key</tt><tt class="py-op">)</tt> </tt>
|
|
</div></div><a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._create_file_if_needed"></a><div id="_MultiStore._create_file_if_needed-def"><a name="L265"></a><tt class="py-lineno">265</tt> <a class="py-toggle" href="#" id="_MultiStore._create_file_if_needed-toggle" onclick="return toggle('_MultiStore._create_file_if_needed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_create_file_if_needed">_create_file_if_needed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._create_file_if_needed-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._create_file_if_needed-expanded"><a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-docstring">"""Create an empty file if necessary.</tt> </tt>
|
|
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-docstring"> This method will not initialize the file. Instead it implements a</tt> </tt>
|
|
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-docstring"> simple version of "touch" to ensure the file has been created.</tt> </tt>
|
|
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-54', 'filename', 'link-18');">filename</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-name">old_umask</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">umask</tt><tt class="py-op">(</tt><tt class="py-number">0177</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-55', 'filename', 'link-18');">filename</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'a+b'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">umask</tt><tt class="py-op">(</tt><tt class="py-name">old_umask</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._lock"></a><div id="_MultiStore._lock-def"><a name="L278"></a><tt class="py-lineno">278</tt> <a class="py-toggle" href="#" id="_MultiStore._lock-toggle" onclick="return toggle('_MultiStore._lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_lock">_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._lock-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._lock-expanded"><a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-docstring">"""Lock the entire multistore."""</tt> </tt>
|
|
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread_lock</tt><tt class="py-op">.</tt><tt class="py-name">acquire</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name" targets="Method oauth2client.locked_file.LockedFile.open_and_lock()=oauth2client.locked_file.LockedFile-class.html#open_and_lock,Method oauth2client.locked_file._Opener.open_and_lock()=oauth2client.locked_file._Opener-class.html#open_and_lock,Method oauth2client.locked_file._PosixOpener.open_and_lock()=oauth2client.locked_file._PosixOpener-class.html#open_and_lock"><a title="oauth2client.locked_file.LockedFile.open_and_lock
|
|
oauth2client.locked_file._Opener.open_and_lock
|
|
oauth2client.locked_file._PosixOpener.open_and_lock" class="py-name" href="#" onclick="return doclink('link-56', 'open_and_lock', 'link-56');">open_and_lock</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name" targets="Method oauth2client.locked_file.LockedFile.is_locked()=oauth2client.locked_file.LockedFile-class.html#is_locked,Method oauth2client.locked_file._Opener.is_locked()=oauth2client.locked_file._Opener-class.html#is_locked"><a title="oauth2client.locked_file.LockedFile.is_locked
|
|
oauth2client.locked_file._Opener.is_locked" class="py-name" href="#" onclick="return doclink('link-57', 'is_locked', 'link-57');">is_locked</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_read_only</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
|
|
<a name="L284"></a><tt class="py-lineno">284</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">_warn_on_readonly</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-58', 'logger', 'link-11');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'The credentials file (%s) is not writable. Opening in '</tt> </tt>
|
|
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-string">'read-only mode. Any refreshed credentials will only be '</tt> </tt>
|
|
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-string">'valid for this run.'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-59', 'filename', 'link-18');">filename</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">getsize</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
|
|
oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-60', 'filename', 'link-18');">filename</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt id="link-61" class="py-name"><a title="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-61', 'logger', 'link-11');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">'Initializing empty multistore file'</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-comment"># The multistore is empty so write out an empty file.</tt> </tt>
|
|
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._write()=oauth2client.multistore_file._MultiStore-class.html#_write"><a title="oauth2client.multistore_file._MultiStore._write" class="py-name" href="#" onclick="return doclink('link-62', '_write', 'link-62');">_write</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_read_only</tt> <tt class="py-keyword">or</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-comment"># Only refresh the data if we are read/write or we haven't</tt> </tt>
|
|
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-comment"># cached the data yet. If we are readonly, we assume is isn't</tt> </tt>
|
|
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-comment"># changing out from under us and that we only have to read it</tt> </tt>
|
|
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-comment"># once. This prevents us from whacking any new access keys that</tt> </tt>
|
|
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-comment"># we have cached in memory but were unable to write out.</tt> </tt>
|
|
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._refresh_data_cache()=oauth2client.multistore_file._MultiStore-class.html#_refresh_data_cache"><a title="oauth2client.multistore_file._MultiStore._refresh_data_cache" class="py-name" href="#" onclick="return doclink('link-63', '_refresh_data_cache', 'link-63');">_refresh_data_cache</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._unlock"></a><div id="_MultiStore._unlock-def"><a name="L301"></a><tt class="py-lineno">301</tt> <a class="py-toggle" href="#" id="_MultiStore._unlock-toggle" onclick="return toggle('_MultiStore._unlock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_unlock">_unlock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._unlock-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._unlock-expanded"><a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-docstring">"""Release the lock on the multistore."""</tt> </tt>
|
|
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name" targets="Method oauth2client.locked_file.LockedFile.unlock_and_close()=oauth2client.locked_file.LockedFile-class.html#unlock_and_close,Method oauth2client.locked_file._Opener.unlock_and_close()=oauth2client.locked_file._Opener-class.html#unlock_and_close,Method oauth2client.locked_file._PosixOpener.unlock_and_close()=oauth2client.locked_file._PosixOpener-class.html#unlock_and_close"><a title="oauth2client.locked_file.LockedFile.unlock_and_close
|
|
oauth2client.locked_file._Opener.unlock_and_close
|
|
oauth2client.locked_file._PosixOpener.unlock_and_close" class="py-name" href="#" onclick="return doclink('link-64', 'unlock_and_close', 'link-64');">unlock_and_close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread_lock</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._locked_json_read"></a><div id="_MultiStore._locked_json_read-def"><a name="L306"></a><tt class="py-lineno">306</tt> <a class="py-toggle" href="#" id="_MultiStore._locked_json_read-toggle" onclick="return toggle('_MultiStore._locked_json_read');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_locked_json_read">_locked_json_read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._locked_json_read-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._locked_json_read-expanded"><a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-docstring">"""Get the raw content of the multistore file.</tt> </tt>
|
|
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> The multistore must be locked when this is called.</tt> </tt>
|
|
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> The contents of the multistore decoded as JSON.</tt> </tt>
|
|
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread_lock</tt><tt class="py-op">.</tt><tt class="py-name">locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Method oauth2client.locked_file.LockedFile.file_handle()=oauth2client.locked_file.LockedFile-class.html#file_handle,Method oauth2client.locked_file._Opener.file_handle()=oauth2client.locked_file._Opener-class.html#file_handle"><a title="oauth2client.locked_file.LockedFile.file_handle
|
|
oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-65', 'file_handle', 'link-65');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt id="link-66" 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-66', 'load', 'link-66');">load</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="oauth2client.locked_file.LockedFile.file_handle
|
|
oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-67', 'file_handle', 'link-65');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._locked_json_write"></a><div id="_MultiStore._locked_json_write-def"><a name="L318"></a><tt class="py-lineno">318</tt> <a class="py-toggle" href="#" id="_MultiStore._locked_json_write-toggle" onclick="return toggle('_MultiStore._locked_json_write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_locked_json_write">_locked_json_write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._locked_json_write-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._locked_json_write-expanded"><a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> <tt class="py-docstring">"""Write a JSON serializable data structure to the multistore.</tt> </tt>
|
|
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"> The multistore must be locked when this is called.</tt> </tt>
|
|
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"><tt class="py-docstring"> data: The data to be serialized and written.</tt> </tt>
|
|
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_thread_lock</tt><tt class="py-op">.</tt><tt class="py-name">locked</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L327"></a><tt class="py-lineno">327</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">_read_only</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
|
|
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="oauth2client.locked_file.LockedFile.file_handle
|
|
oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-68', 'file_handle', 'link-65');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">seek</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="oauth2client.locked_file.LockedFile.file_handle
|
|
oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-69', 'file_handle', 'link-65');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">sort_keys</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_file</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="oauth2client.locked_file.LockedFile.file_handle
|
|
oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-70', 'file_handle', 'link-65');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">truncate</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._refresh_data_cache"></a><div id="_MultiStore._refresh_data_cache-def"><a name="L333"></a><tt class="py-lineno">333</tt> <a class="py-toggle" href="#" id="_MultiStore._refresh_data_cache-toggle" onclick="return toggle('_MultiStore._refresh_data_cache');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_refresh_data_cache">_refresh_data_cache</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._refresh_data_cache-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._refresh_data_cache-expanded"><a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"> <tt class="py-docstring">"""Refresh the contents of the multistore.</tt> </tt>
|
|
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"><tt class="py-docstring"> The multistore must be locked when this is called.</tt> </tt>
|
|
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
|
|
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"><tt class="py-docstring"> NewerCredentialStoreError: Raised when a newer client has written the</tt> </tt>
|
|
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"><tt class="py-docstring"> store.</tt> </tt>
|
|
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> <tt class="py-name">raw_data</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._locked_json_read()=oauth2client.multistore_file._MultiStore-class.html#_locked_json_read"><a title="oauth2client.multistore_file._MultiStore._locked_json_read" class="py-name" href="#" onclick="return doclink('link-71', '_locked_json_read', 'link-71');">_locked_json_read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> <tt id="link-72" class="py-name"><a title="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-72', 'logger', 'link-11');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Credential data store could not be loaded. '</tt> </tt>
|
|
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> <tt class="py-string">'Will ignore and overwrite.'</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
|
|
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> </tt>
|
|
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> <tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
|
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-name">version</tt> <tt class="py-op">=</tt> <tt class="py-name">raw_data</tt><tt class="py-op">[</tt><tt class="py-string">'file_version'</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> <tt id="link-73" class="py-name"><a title="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-73', 'logger', 'link-11');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Missing version for credential data store. It may be '</tt> </tt>
|
|
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt class="py-string">'corrupt or an old version. Overwriting.'</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">version</tt> <tt class="py-op">></tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-74" class="py-name" targets="Class oauth2client.multistore_file.NewerCredentialStoreError=oauth2client.multistore_file.NewerCredentialStoreError-class.html"><a title="oauth2client.multistore_file.NewerCredentialStoreError" class="py-name" href="#" onclick="return doclink('link-74', 'NewerCredentialStoreError', 'link-74');">NewerCredentialStoreError</a></tt><tt class="py-op">(</tt> </tt>
|
|
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-string">'Credential file has file_version of %d. '</tt> </tt>
|
|
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> <tt class="py-string">'Only file_version of 1 is supported.'</tt> <tt class="py-op">%</tt> <tt class="py-name">version</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> </tt>
|
|
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt id="link-75" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials
|
|
oauth2client.appengine.CredentialsNDBModel.credentials
|
|
oauth2client.appengine.OAuth2Decorator.credentials" class="py-name" href="#" onclick="return doclink('link-75', 'credentials', 'link-52');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"> <tt id="link-76" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials
|
|
oauth2client.appengine.CredentialsNDBModel.credentials
|
|
oauth2client.appengine.OAuth2Decorator.credentials" class="py-name" href="#" onclick="return doclink('link-76', 'credentials', 'link-52');">credentials</a></tt> <tt class="py-op">=</tt> <tt class="py-name">raw_data</tt><tt class="py-op">[</tt><tt class="py-string">'data'</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-op">(</tt><tt class="py-name">TypeError</tt><tt class="py-op">,</tt> <tt class="py-name">KeyError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> </tt>
|
|
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">cred_entry</tt> <tt class="py-keyword">in</tt> <tt id="link-77" class="py-name"><a title="oauth2client.appengine.CredentialsModel.credentials
|
|
oauth2client.appengine.CredentialsNDBModel.credentials
|
|
oauth2client.appengine.OAuth2Decorator.credentials" class="py-name" href="#" onclick="return doclink('link-77', 'credentials', 'link-52');">credentials</a></tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">credential</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._decode_credential_from_json()=oauth2client.multistore_file._MultiStore-class.html#_decode_credential_from_json"><a title="oauth2client.multistore_file._MultiStore._decode_credential_from_json" class="py-name" href="#" onclick="return doclink('link-78', '_decode_credential_from_json', 'link-78');">_decode_credential_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">cred_entry</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">credential</tt> </tt>
|
|
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"> <tt class="py-comment"># If something goes wrong loading a credential, just ignore it</tt> </tt>
|
|
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"> <tt id="link-79" class="py-name"><a title="oauth2client.appengine.logger
|
|
oauth2client.client.logger
|
|
oauth2client.crypt.logger
|
|
oauth2client.gce.logger
|
|
oauth2client.locked_file.logger
|
|
oauth2client.multistore_file.logger
|
|
oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-79', 'logger', 'link-11');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">'Error decoding credential, skipping'</tt><tt class="py-op">,</tt> <tt class="py-name">exc_info</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._decode_credential_from_json"></a><div id="_MultiStore._decode_credential_from_json-def"><a name="L375"></a><tt class="py-lineno">375</tt> <a class="py-toggle" href="#" id="_MultiStore._decode_credential_from_json-toggle" onclick="return toggle('_MultiStore._decode_credential_from_json');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_decode_credential_from_json">_decode_credential_from_json</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cred_entry</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._decode_credential_from_json-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._decode_credential_from_json-expanded"><a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> <tt class="py-docstring">"""Load a credential from our JSON serialization.</tt> </tt>
|
|
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-docstring"> cred_entry: A dict entry from the data member of our format</tt> </tt>
|
|
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"><tt class="py-docstring"> (key, cred) where the key is the key tuple and the cred is the</tt> </tt>
|
|
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"><tt class="py-docstring"> OAuth2Credential object.</tt> </tt>
|
|
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"> <tt class="py-name">raw_key</tt> <tt class="py-op">=</tt> <tt class="py-name">cred_entry</tt><tt class="py-op">[</tt><tt class="py-string">'key'</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt id="link-80" class="py-name"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-80', 'util', 'link-7');">util</a></tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="oauth2client.util.dict_to_tuple_key" class="py-name" href="#" onclick="return doclink('link-81', 'dict_to_tuple_key', 'link-26');">dict_to_tuple_key</a></tt><tt class="py-op">(</tt><tt class="py-name">raw_key</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"> <tt class="py-name">credential</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
|
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> <tt class="py-name">credential</tt> <tt class="py-op">=</tt> <tt id="link-82" class="py-name"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-82', 'Credentials', 'link-2');">Credentials</a></tt><tt class="py-op">.</tt><tt id="link-83" class="py-name" targets="Class Method oauth2client.client.Credentials.new_from_json()=oauth2client.client.Credentials-class.html#new_from_json"><a title="oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick="return doclink('link-83', 'new_from_json', 'link-83');">new_from_json</a></tt><tt class="py-op">(</tt><tt class="py-name">json</tt><tt class="py-op">.</tt><tt class="py-name">dumps</tt><tt class="py-op">(</tt><tt class="py-name">cred_entry</tt><tt class="py-op">[</tt><tt class="py-string">'credential'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">credential</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._write"></a><div id="_MultiStore._write-def"><a name="L391"></a><tt class="py-lineno">391</tt> <a class="py-toggle" href="#" id="_MultiStore._write-toggle" onclick="return toggle('_MultiStore._write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_write">_write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._write-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._write-expanded"><a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"> <tt class="py-docstring">"""Write the cached data back out.</tt> </tt>
|
|
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-docstring"> The multistore must be locked.</tt> </tt>
|
|
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> <tt class="py-name">raw_data</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'file_version'</tt><tt class="py-op">:</tt> <tt class="py-number">1</tt><tt class="py-op">}</tt> </tt>
|
|
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> <tt class="py-name">raw_creds</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-name">raw_data</tt><tt class="py-op">[</tt><tt class="py-string">'data'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">raw_creds</tt> </tt>
|
|
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">cred_key</tt><tt class="py-op">,</tt> <tt class="py-name">cred</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> <tt class="py-name">raw_key</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">cred_key</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"> <tt class="py-name">raw_cred</tt> <tt class="py-op">=</tt> <tt class="py-name">json</tt><tt class="py-op">.</tt><tt id="link-84" 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-84', 'loads', 'link-84');">loads</a></tt><tt class="py-op">(</tt><tt class="py-name">cred</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name" targets="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="oauth2client.client.Credentials.to_json
|
|
oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick="return doclink('link-85', 'to_json', 'link-85');">to_json</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-name">raw_creds</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'key'</tt><tt class="py-op">:</tt> <tt class="py-name">raw_key</tt><tt class="py-op">,</tt> <tt class="py-string">'credential'</tt><tt class="py-op">:</tt> <tt class="py-name">raw_cred</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
|
|
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name" targets="Method oauth2client.multistore_file._MultiStore._locked_json_write()=oauth2client.multistore_file._MultiStore-class.html#_locked_json_write"><a title="oauth2client.multistore_file._MultiStore._locked_json_write" class="py-name" href="#" onclick="return doclink('link-86', '_locked_json_write', 'link-86');">_locked_json_write</a></tt><tt class="py-op">(</tt><tt class="py-name">raw_data</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._get_all_credential_keys"></a><div id="_MultiStore._get_all_credential_keys-def"><a name="L405"></a><tt class="py-lineno">405</tt> <a class="py-toggle" href="#" id="_MultiStore._get_all_credential_keys-toggle" onclick="return toggle('_MultiStore._get_all_credential_keys');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_get_all_credential_keys">_get_all_credential_keys</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._get_all_credential_keys-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._get_all_credential_keys-expanded"><a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-docstring">"""Gets all the registered credential keys in the multistore.</tt> </tt>
|
|
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"><tt class="py-docstring"> A list of dictionaries corresponding to all the keys currently registered</tt> </tt>
|
|
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
|
|
</div><a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._get_credential"></a><div id="_MultiStore._get_credential-def"><a name="L413"></a><tt class="py-lineno">413</tt> <a class="py-toggle" href="#" id="_MultiStore._get_credential-toggle" onclick="return toggle('_MultiStore._get_credential');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_get_credential">_get_credential</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._get_credential-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._get_credential-expanded"><a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a credential from the multistore.</tt> </tt>
|
|
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"><tt class="py-docstring"> The multistore must be locked.</tt> </tt>
|
|
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"><tt class="py-docstring"> key: The key used to retrieve the credential</tt> </tt>
|
|
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"><tt class="py-docstring"> The credential specified or None if not present</tt> </tt>
|
|
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L424"></a><tt class="py-lineno">424</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">_data</tt><tt class="py-op">.</tt><tt id="link-87" class="py-name" targets="Method oauth2client.client.MemoryCache.get()=oauth2client.client.MemoryCache-class.html#get,Method oauth2client.client.Storage.get()=oauth2client.client.Storage-class.html#get"><a title="oauth2client.client.MemoryCache.get
|
|
oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-87', 'get', 'link-87');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._update_credential"></a><div id="_MultiStore._update_credential-def"><a name="L426"></a><tt class="py-lineno">426</tt> <a class="py-toggle" href="#" id="_MultiStore._update_credential-toggle" onclick="return toggle('_MultiStore._update_credential');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_update_credential">_update_credential</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">cred</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._update_credential-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._update_credential-expanded"><a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-docstring">"""Update a credential and write the multistore.</tt> </tt>
|
|
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"><tt class="py-docstring"> This must be called when the multistore is locked.</tt> </tt>
|
|
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"><tt class="py-docstring"> key: The key used to retrieve the credential</tt> </tt>
|
|
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt class="py-docstring"> cred: The OAuth2Credential to update/set</tt> </tt>
|
|
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cred</tt> </tt>
|
|
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="oauth2client.multistore_file._MultiStore._write" class="py-name" href="#" onclick="return doclink('link-88', '_write', 'link-62');">_write</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._delete_credential"></a><div id="_MultiStore._delete_credential-def"><a name="L438"></a><tt class="py-lineno">438</tt> <a class="py-toggle" href="#" id="_MultiStore._delete_credential-toggle" onclick="return toggle('_MultiStore._delete_credential');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_delete_credential">_delete_credential</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._delete_credential-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._delete_credential-expanded"><a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"> <tt class="py-docstring">"""Delete a credential and write the multistore.</tt> </tt>
|
|
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"><tt class="py-docstring"> This must be called when the multistore is locked.</tt> </tt>
|
|
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"><tt class="py-docstring"> key: The key used to retrieve the credential</tt> </tt>
|
|
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_data</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
|
|
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
|
|
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="oauth2client.multistore_file._MultiStore._write" class="py-name" href="#" onclick="return doclink('link-89', '_write', 'link-62');">_write</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
</div><a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> </tt>
|
|
<a name="_MultiStore._get_storage"></a><div id="_MultiStore._get_storage-def"><a name="L452"></a><tt class="py-lineno">452</tt> <a class="py-toggle" href="#" id="_MultiStore._get_storage-toggle" onclick="return toggle('_MultiStore._get_storage');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.multistore_file._MultiStore-class.html#_get_storage">_get_storage</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
</div><div id="_MultiStore._get_storage-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_MultiStore._get_storage-expanded"><a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a Storage object to get/set a credential.</tt> </tt>
|
|
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"><tt class="py-docstring"> This Storage is a 'view' into the multistore.</tt> </tt>
|
|
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
|
|
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"><tt class="py-docstring"> key: The key used to retrieve the credential</tt> </tt>
|
|
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
|
|
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"><tt class="py-docstring"> A Storage object that can be used to get/set this cred</tt> </tt>
|
|
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name" targets="Class oauth2client.multistore_file._MultiStore._Storage=oauth2client.multistore_file._MultiStore._Storage-class.html"><a title="oauth2client.multistore_file._MultiStore._Storage" class="py-name" href="#" onclick="return doclink('link-90', '_Storage', 'link-90');">_Storage</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
|
|
</div></div><a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
|
<!--
|
|
expandto(location.href);
|
|
// -->
|
|
</script>
|
|
</pre>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Mon Sep 29 15:21:53 2014
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|