Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(1134)

Side by Side Diff: docs/epy/oauth2client.file-pysrc.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)
Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 9 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « docs/epy/oauth2client.file-module.html ('k') | docs/epy/oauth2client.file.Storage-class.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>oauth2client.file</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32 </table>
33 <table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 Module&nbsp;file
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0) ;" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.file-pysrc.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53 </table>
54 <h1 class="epydoc">Source Code for <a href="oauth2client.file-module.html">Modul e oauth2client.file</a></h1>
55 <pre class="py-src">
56 <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class=" py-comment"># Copyright (C) 2010 Google Inc.</tt> </tt>
57 <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class=" py-comment">#</tt> </tt>
58 <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class=" py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</t t> </tt>
59 <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class=" py-comment"># you may not use this file except in compliance with the License.</ tt> </tt>
60 <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class=" py-comment"># You may obtain a copy of the License at</tt> </tt>
61 <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class=" py-comment">#</tt> </tt>
62 <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class=" py-comment"># http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
63 <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class=" py-comment">#</tt> </tt>
64 <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class=" py-comment"># Unless required by applicable law or agreed to in writing, softwar e</tt> </tt>
65 <a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class= "py-comment"># distributed under the License is distributed on an "AS IS" BASIS, </tt> </tt>
66 <a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class= "py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or i mplied.</tt> </tt>
67 <a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class= "py-comment"># See the License for the specific language governing permissions a nd</tt> </tt>
68 <a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class= "py-comment"># limitations under the License.</tt> </tt>
69 <a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt>
70 <a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class= "py-docstring">"""Utilities for OAuth.</tt> </tt>
71 <a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
72 <a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class= "py-docstring">Utilities for making it easier to work with OAuth 2.0</tt> </tt>
73 <a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class= "py-docstring">credentials.</tt> </tt>
74 <a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class= "py-docstring">"""</tt> </tt>
75 <a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"> </tt>
76 <a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class= "py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'jcgreg orio@google.com (Joe Gregorio)'</tt> </tt>
77 <a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> </tt>
78 <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class= "py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
79 <a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class= "py-keyword">import</tt> <tt class="py-name">stat</tt> </tt>
80 <a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class= "py-keyword">import</tt> <tt class="py-name">threading</tt> </tt>
81 <a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
82 <a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class= "py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module oauth2cli ent.anyjson=oauth2client.anyjson-module.html"><a title="oauth2client.anyjson" cl ass="py-name" href="#" onclick="return doclink('link-0', 'anyjson', 'link-0');"> anyjson</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">simplejs on</tt> </tt>
83 <a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class= "py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Module oauth2cli ent.client=oauth2client.client-module.html"><a title="oauth2client.client" class ="py-name" href="#" onclick="return doclink('link-1', 'client', 'link-1');">clie nt</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" t argets="Class oauth2client.client.Storage=oauth2client.client.Storage-class.html ,Class oauth2client.django_orm.Storage=oauth2client.django_orm.Storage-class.htm l,Class oauth2client.file.Storage=oauth2client.file.Storage-class.html"><a title ="oauth2client.client.Storage
84 oauth2client.django_orm.Storage
85 oauth2client.file.Storage" class="py-name" href="#" onclick="return doclink('lin k-2', 'Storage', 'link-2');">Storage</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">BaseStorage</tt> </tt>
86 <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class= "py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="oauth2client.cl ient" class="py-name" href="#" onclick="return doclink('link-3', 'client', 'link -1');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-4" class= "py-name" targets="Class oauth2client.client.Credentials=oauth2client.client.Cre dentials-class.html"><a title="oauth2client.client.Credentials" class="py-name" href="#" onclick="return doclink('link-4', 'Credentials', 'link-4');">Credential s</a></tt> </tt>
87 <a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt>
88 <a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> </tt>
89 <a name="Storage"></a><div id="Storage-def"><a name="L32"></a><tt class="py-line no"> 32</tt> <a class="py-toggle" href="#" id="Storage-toggle" onclick="return t oggle('Storage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.file.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>
90 </div><div id="Storage-collapsed" style="display:none;" pad="+++" indent="++++"> </div><div id="Storage-expanded"><a name="L33"></a><tt class="py-lineno"> 33</tt > <tt class="py-line"> <tt class="py-docstring">"""Store and retrieve a single credential to and from a file."""</tt> </tt>
91 <a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> </tt>
92 <a name="Storage.__init__"></a><div id="Storage.__init__-def"><a name="L35"></a> <tt class="py-lineno"> 35</tt> <a class="py-toggle" href="#" id="Storage.__init_ _-toggle" onclick="return toggle('Storage.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.file .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">filename</tt><tt c lass="py-op">)</tt><tt class="py-op">:</tt> </tt>
93 </div><div id="Storage.__init__-collapsed" style="display:none;" pad="+++" inden t="++++++"></div><div id="Storage.__init__-expanded"><a name="L36"></a><tt class ="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">filename</tt> </tt>
94 <a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt cl ass="py-name">self</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" t argets="Method oauth2client.multistore_file._MultiStore._lock()=oauth2client.mul tistore_file._MultiStore-class.html#_lock"><a title="oauth2client.multistore_fil e._MultiStore._lock" class="py-name" href="#" onclick="return doclink('link-5', '_lock', 'link-5');">_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="p y-op">(</tt><tt class="py-op">)</tt> </tt>
95 </div><a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> </t t>
96 <a name="Storage.acquire_lock"></a><div id="Storage.acquire_lock-def"><a name="L 39"></a><tt class="py-lineno"> 39</tt> <a class="py-toggle" href="#" id="Storage .acquire_lock-toggle" onclick="return toggle('Storage.acquire_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="o auth2client.file.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>
97 </div><div id="Storage.acquire_lock-collapsed" style="display:none;" pad="+++" i ndent="++++++"></div><div id="Storage.acquire_lock-expanded"><a name="L40"></a>< tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-docstring"> """Acquires any lock necessary to access this Storage.</tt> </tt>
98 <a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
99 <a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class= "py-docstring"> This lock is not reentrant."""</tt> </tt>
100 <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt cl ass="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name">< a title="oauth2client.multistore_file._MultiStore._lock" class="py-name" href="# " onclick="return doclink('link-6', '_lock', 'link-5');">_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>
101 </div><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </t t>
102 <a name="Storage.release_lock"></a><div id="Storage.release_lock-def"><a name="L 45"></a><tt class="py-lineno"> 45</tt> <a class="py-toggle" href="#" id="Storage .release_lock-toggle" onclick="return toggle('Storage.release_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="o auth2client.file.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>
103 </div><div id="Storage.release_lock-collapsed" style="display:none;" pad="+++" i ndent="++++++"></div><div id="Storage.release_lock-expanded"><a name="L46"></a>< tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-docstring"> """Release the Storage lock.</tt> </tt>
104 <a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
105 <a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class= "py-docstring"> Trying to release a lock that isn't held will result in a</tt > </tt>
106 <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class= "py-docstring"> RuntimeError.</tt> </tt>
107 <a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class= "py-docstring"> """</tt> </tt>
108 <a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt cl ass="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name">< a title="oauth2client.multistore_file._MultiStore._lock" class="py-name" href="# " onclick="return doclink('link-7', '_lock', 'link-5');">_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>
109 </div><a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> </t t>
110 <a name="Storage.locked_get"></a><div id="Storage.locked_get-def"><a name="L53"> </a><tt class="py-lineno"> 53</tt> <a class="py-toggle" href="#" id="Storage.loc ked_get-toggle" onclick="return toggle('Storage.locked_get');">-</a><tt class="p y-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2cli ent.file.Storage-class.html#locked_get">locked_get</a><tt class="py-op">(</tt><t t class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </t t>
111 </div><div id="Storage.locked_get-collapsed" style="display:none;" pad="+++" ind ent="++++++"></div><div id="Storage.locked_get-expanded"><a name="L54"></a><tt c lass="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-docstring">"""R etrieve Credential from file.</tt> </tt>
112 <a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
113 <a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class= "py-docstring"> Returns:</tt> </tt>
114 <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class= "py-docstring"> oauth2client.client.Credentials</tt> </tt>
115 <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class= "py-docstring"> """</tt> </tt>
116 <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt id ="link-8" class="py-name" targets="Variable oauth2client.appengine.CredentialsMo del.credentials=oauth2client.appengine.CredentialsModel-class.html#credentials"> <a title="oauth2client.appengine.CredentialsModel.credentials" class="py-name" h ref="#" onclick="return doclink('link-8', 'credentials', 'link-8');">credentials </a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
117 <a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt cl ass="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
118 <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt cl ass="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-string">'rb'< /tt><tt class="py-op">)</tt> </tt>
119 <a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">f</tt> <tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
120 <a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
121 <a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt cl ass="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">: </tt> </tt>
122 <a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-9" class="py-name"><a title="oauth2c lient.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick=" return doclink('link-9', 'credentials', 'link-8');">credentials</a></tt> </tt>
123 <a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> </tt>
124 <a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt cl ass="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
125 <a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt id="link-10" class="py-name"><a title="oauth2client.appengine.CredentialsModel.c redentials" class="py-name" href="#" onclick="return doclink('link-10', 'credent ials', 'link-8');">credentials</a></tt> <tt class="py-op">=</tt> <tt id="link-11 " class="py-name"><a title="oauth2client.client.Credentials" class="py-name" hre f="#" onclick="return doclink('link-11', 'Credentials', 'link-4');">Credentials< /a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Class Method apiclient.http.MediaUpload.new_from_json()=apiclient.http.MediaUpload-cla ss.html#new_from_json,Class Method oauth2client.client.Credentials.new_from_json ()=oauth2client.client.Credentials-class.html#new_from_json"><a title="apiclient .http.MediaUpload.new_from_json
126 oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick= "return doclink('link-12', 'new_from_json', 'link-12');">new_from_json</a></tt>< tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
127 <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt id="link-13" class="py-name"><a title="oauth2client.appengine.CredentialsModel.c redentials" class="py-name" href="#" onclick="return doclink('link-13', 'credent ials', 'link-8');">credentials</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method oauth2client.client.OAuth2Credentials.set_store( )=oauth2client.client.OAuth2Credentials-class.html#set_store"><a title="oauth2cl ient.client.OAuth2Credentials.set_store" class="py-name" href="#" onclick="retur n doclink('link-14', 'set_store', 'link-14');">set_store</a></tt><tt class="py-o p">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
128 <a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt cl ass="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op ">:</tt> </tt>
129 <a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
130 <a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
131 <a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt cl ass="py-keyword">return</tt> <tt id="link-15" class="py-name"><a title="oauth2cl ient.appengine.CredentialsModel.credentials" class="py-name" href="#" onclick="r eturn doclink('link-15', 'credentials', 'link-8');">credentials</a></tt> </tt>
132 </div><a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> </t t>
133 <a name="Storage._create_file_if_needed"></a><div id="Storage._create_file_if_ne eded-def"><a name="L75"></a><tt class="py-lineno"> 75</tt> <a class="py-toggle" href="#" id="Storage._create_file_if_needed-toggle" onclick="return toggle('Stor age._create_file_if_needed');">-</a><tt class="py-line"> <tt class="py-keyword" >def</tt> <a class="py-def-name" href="oauth2client.file.Storage-class.html#_cre ate_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>
134 </div><div id="Storage._create_file_if_needed-collapsed" style="display:none;" p ad="+++" indent="++++++"></div><div id="Storage._create_file_if_needed-expanded" ><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt c lass="py-docstring">"""Create an empty file if necessary.</tt> </tt>
135 <a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
136 <a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class= "py-docstring"> This method will not initialize the file. Instead it implemen ts a</tt> </tt>
137 <a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class= "py-docstring"> simple version of "touch" to ensure the file has been created .</tt> </tt>
138 <a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class= "py-docstring"> """</tt> </tt>
139 <a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt cl ass="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">_filename</tt><tt class="py-op" >)</tt><tt class="py-op">:</tt> </tt>
140 <a name="L82"></a><tt class="py-lineno"> 82</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>
141 <a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
142 <a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <t t class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt> <tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</t t> <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>
143 <a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
144 <a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <t t 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>
145 </div><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> </t t>
146 <a name="Storage.locked_put"></a><div id="Storage.locked_put-def"><a name="L88"> </a><tt class="py-lineno"> 88</tt> <a class="py-toggle" href="#" id="Storage.loc ked_put-toggle" onclick="return toggle('Storage.locked_put');">-</a><tt class="p y-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2cli ent.file.Storage-class.html#locked_put">locked_put</a><tt class="py-op">(</tt><t t class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">creden tials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
147 </div><div id="Storage.locked_put-collapsed" style="display:none;" pad="+++" ind ent="++++++"></div><div id="Storage.locked_put-expanded"><a name="L89"></a><tt c lass="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-docstring">"""W rite Credentials to file.</tt> </tt>
148 <a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class= "py-docstring"></tt> </tt>
149 <a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class= "py-docstring"> Args:</tt> </tt>
150 <a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class= "py-docstring"> credentials: Credentials, the credentials to store.</tt> </ tt>
151 <a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class= "py-docstring"> """</tt> </tt>
152 <a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
153 <a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt cl ass="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method oauth2client.file.Storage._create_file_if_needed()=oauth2client. file.Storage-class.html#_create_file_if_needed,Method oauth2client.multistore_fi le._MultiStore._create_file_if_needed()=oauth2client.multistore_file._MultiStore -class.html#_create_file_if_needed"><a title="oauth2client.file.Storage._create_ file_if_needed
154 oauth2client.multistore_file._MultiStore._create_file_if_needed" class="py-name" href="#" onclick="return doclink('link-16', '_create_file_if_needed', 'link-16' );">_create_file_if_needed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</ tt> </tt>
155 <a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt cl ass="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt c lass="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt clas s="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-string">'wb'</t t><tt class="py-op">)</tt> </tt>
156 <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt cl ass="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt cl ass="py-op">(</tt><tt id="link-17" class="py-name"><a title="oauth2client.appeng ine.CredentialsModel.credentials" class="py-name" href="#" onclick="return docli nk('link-17', 'credentials', 'link-8');">credentials</a></tt><tt class="py-op">. </tt><tt id="link-18" class="py-name" targets="Method apiclient.http.HttpRequest .to_json()=apiclient.http.HttpRequest-class.html#to_json,Method apiclient.http.M ediaFileUpload.to_json()=apiclient.http.MediaFileUpload-class.html#to_json,Metho d apiclient.http.MediaInMemoryUpload.to_json()=apiclient.http.MediaInMemoryUploa d-class.html#to_json,Method apiclient.http.MediaUpload.to_json()=apiclient.http. MediaUpload-class.html#to_json,Method oauth2client.client.Credentials.to_json()= oauth2client.client.Credentials-class.html#to_json,Method oauth2client.client.OA uth2Credentials.to_json()=oauth2client.client.OAuth2Credentials-class.html#to_js on"><a title="apiclient.http.HttpRequest.to_json
157 apiclient.http.MediaFileUpload.to_json
158 apiclient.http.MediaInMemoryUpload.to_json
159 apiclient.http.MediaUpload.to_json
160 oauth2client.client.Credentials.to_json
161 oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick= "return doclink('link-18', 'to_json', 'link-18');">to_json</a></tt><tt class="py -op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
162 <a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt cl ass="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt cl ass="py-op">(</tt><tt class="py-op">)</tt> </tt>
163 </div><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </t t>
164 <a name="Storage.locked_delete"></a><div id="Storage.locked_delete-def"><a name= "L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="Stor age.locked_delete-toggle" onclick="return toggle('Storage.locked_delete');">-</a ><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" hr ef="oauth2client.file.Storage-class.html#locked_delete">locked_delete</a><tt cla ss="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class ="py-op">:</tt> </tt>
165 </div><div id="Storage.locked_delete-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Storage.locked_delete-expanded"><a name="L101"></ a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-docstrin g">"""Delete Credentials file.</tt> </tt>
166 <a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class ="py-docstring"></tt> </tt>
167 <a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class ="py-docstring"> Args:</tt> </tt>
168 <a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class ="py-docstring"> credentials: Credentials, the credentials to store.</tt> < /tt>
169 <a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class ="py-docstring"> """</tt> </tt>
170 <a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt>
171 <a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt c lass="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">unlink</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt cl ass="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
172 </div></div><a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-lin e"> </tt><script type="text/javascript">
173 <!--
174 expandto(location.href);
175 // -->
176 </script>
177 </pre>
178 <br />
179 <!-- ==================== NAVIGATION BAR ==================== -->
180 <table class="navbar" border="0" width="100%" cellpadding="0"
181 bgcolor="#a0c0ff" cellspacing="0">
182 <tr valign="middle">
183
184 <!-- Tree link -->
185 <th>&nbsp;&nbsp;&nbsp;<a
186 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
187
188 <!-- Index link -->
189 <th>&nbsp;&nbsp;&nbsp;<a
190 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
191
192 <!-- Help link -->
193 <th>&nbsp;&nbsp;&nbsp;<a
194 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
195
196 <th class="navbar" width="100%"></th>
197 </tr>
198 </table>
199 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
200 <tr>
201 <td align="left" class="footer">
202 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:12 2012
203 </td>
204 <td align="right" class="footer">
205 <a target="mainFrame" href="http://epydoc.sourceforge.net"
206 >http://epydoc.sourceforge.net</a>
207 </td>
208 </tr>
209 </table>
210
211 <script type="text/javascript">
212 <!--
213 // Private objects are initially displayed (because if
214 // javascript is turned off then we want them to be
215 // visible); but by default, we want to hide them. So hide
216 // them unless we have a cookie that says to show them.
217 checkCookie();
218 // -->
219 </script>
220 </body>
221 </html>
OLDNEW
« no previous file with comments | « docs/epy/oauth2client.file-module.html ('k') | docs/epy/oauth2client.file.Storage-class.html » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b