Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e7a0c477e1269ee11daa322ee1ab9ef414cb1b77 / . / docs / epy / oauth2client.file.Storage-class.html
blob: e4c4b8d64775fb70f69dcb2c1d7852c5847665b6 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.file.Storage</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 <a href="oauth2client.file-module.html">Module&nbsp;file</a> ::
39 Class&nbsp;Storage
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.file.Storage-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class Storage</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_storage_4" name="class_hierarchy_for_storage_4">
59<area shape="rect" href="oauth2client.client.Storage-class.html" title="client.Storage" alt="" coords="5,5,107,32"/>
60<area shape="rect" href="oauth2client.file.Storage-class.html" title="Storage" alt="" coords="23,61,89,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]61</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]62 <img src="class_hierarchy_for_storage_4.gif" alt='' usemap="#class_hierarchy_for_storage_4" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Store and retrieve a single credential to and from a file.
68
69</pre>
70
71<!-- ==================== INSTANCE METHODS ==================== -->
72<a name="section-InstanceMethods"></a>
73<table class="summary" border="1" cellpadding="3"
74 cellspacing="0" width="100%" bgcolor="white">
75<tr bgcolor="#70b0f0" class="table-header">
76 <td colspan="2" class="table-header">
77 <table border="0" cellpadding="0" cellspacing="0" width="100%">
78 <tr valign="top">
79 <td align="left"><span class="table-header">Instance Methods</span></td>
80 <td align="right" valign="top"
81 ><span class="options">[<a href="#section-InstanceMethods"
82 class="privatelink" onclick="toggle_private();"
83 >hide private</a>]</span></td>
84 </tr>
85 </table>
86 </td>
87</tr>
88<tr>
89 <td width="15%" align="right" valign="top" class="summary">
90 <span class="summary-type">&nbsp;</span>
91 </td><td class="summary">
92 <table width="100%" cellpadding="0" cellspacing="0" border="0">
93 <tr>
94 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
95 <span class="summary-sig-arg">filename</span>)</span><br />
96 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
97 <td align="right" valign="top">
98 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.__init__">source&nbsp;code</a></span>
99
100 </td>
101 </tr>
102 </table>
103
104 </td>
105 </tr>
106<tr>
107 <td width="15%" align="right" valign="top" class="summary">
108 <span class="summary-type">&nbsp;</span>
109 </td><td class="summary">
110 <table width="100%" cellpadding="0" cellspacing="0" border="0">
111 <tr>
112 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#acquire_lock" class="summary-sig-name">acquire_lock</a>(<span class="summary-sig-arg">self</span>)</span><br />
113 Acquires any lock necessary to access this Storage.</td>
114 <td align="right" valign="top">
115 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.acquire_lock">source&nbsp;code</a></span>
116
117 </td>
118 </tr>
119 </table>
120
121 </td>
122 </tr>
123<tr>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type">&nbsp;</span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
128 <tr>
129 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#release_lock" class="summary-sig-name">release_lock</a>(<span class="summary-sig-arg">self</span>)</span><br />
130 Release the Storage lock.</td>
131 <td align="right" valign="top">
132 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.release_lock">source&nbsp;code</a></span>
133
134 </td>
135 </tr>
136 </table>
137
138 </td>
139 </tr>
140<tr>
141 <td width="15%" align="right" valign="top" class="summary">
142 <span class="summary-type">&nbsp;</span>
143 </td><td class="summary">
144 <table width="100%" cellpadding="0" cellspacing="0" border="0">
145 <tr>
146 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#locked_get" class="summary-sig-name">locked_get</a>(<span class="summary-sig-arg">self</span>)</span><br />
147 Retrieve Credential from file.</td>
148 <td align="right" valign="top">
149 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_get">source&nbsp;code</a></span>
150
151 </td>
152 </tr>
153 </table>
154
155 </td>
156 </tr>
157<tr class="private">
158 <td width="15%" align="right" valign="top" class="summary">
159 <span class="summary-type">&nbsp;</span>
160 </td><td class="summary">
161 <table width="100%" cellpadding="0" cellspacing="0" border="0">
162 <tr>
163 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#_create_file_if_needed" class="summary-sig-name" onclick="show_private();">_create_file_if_needed</a>(<span class="summary-sig-arg">self</span>)</span><br />
164 Create an empty file if necessary.</td>
165 <td align="right" valign="top">
166 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage._create_file_if_needed">source&nbsp;code</a></span>
167
168 </td>
169 </tr>
170 </table>
171
172 </td>
173 </tr>
174<tr>
175 <td width="15%" align="right" valign="top" class="summary">
176 <span class="summary-type">&nbsp;</span>
177 </td><td class="summary">
178 <table width="100%" cellpadding="0" cellspacing="0" border="0">
179 <tr>
180 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#locked_put" class="summary-sig-name">locked_put</a>(<span class="summary-sig-arg">self</span>,
181 <span class="summary-sig-arg">credentials</span>)</span><br />
182 Write Credentials to file.</td>
183 <td align="right" valign="top">
184 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_put">source&nbsp;code</a></span>
185
186 </td>
187 </tr>
188 </table>
189
190 </td>
191 </tr>
192<tr>
193 <td width="15%" align="right" valign="top" class="summary">
194 <span class="summary-type">&nbsp;</span>
195 </td><td class="summary">
196 <table width="100%" cellpadding="0" cellspacing="0" border="0">
197 <tr>
198 <td><span class="summary-sig"><a href="oauth2client.file.Storage-class.html#locked_delete" class="summary-sig-name">locked_delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
199 Delete Credentials file.</td>
200 <td align="right" valign="top">
201 <span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_delete">source&nbsp;code</a></span>
202
203 </td>
204 </tr>
205 </table>
206
207 </td>
208 </tr>
209 <tr>
210 <td colspan="2" class="summary">
211 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Storage-class.html">client.Storage</a></code></b>:
212 <code><a href="oauth2client.client.Storage-class.html#delete">delete</a></code>,
213 <code><a href="oauth2client.client.Storage-class.html#get">get</a></code>,
214 <code><a href="oauth2client.client.Storage-class.html#put">put</a></code>
215 </p>
216 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
217 <code>__delattr__</code>,
218 <code>__format__</code>,
219 <code>__getattribute__</code>,
220 <code>__hash__</code>,
221 <code>__new__</code>,
222 <code>__reduce__</code>,
223 <code>__reduce_ex__</code>,
224 <code>__repr__</code>,
225 <code>__setattr__</code>,
226 <code>__sizeof__</code>,
227 <code>__str__</code>,
228 <code>__subclasshook__</code>
229 </p>
230 </td>
231 </tr>
232</table>
233<!-- ==================== PROPERTIES ==================== -->
234<a name="section-Properties"></a>
235<table class="summary" border="1" cellpadding="3"
236 cellspacing="0" width="100%" bgcolor="white">
237<tr bgcolor="#70b0f0" class="table-header">
238 <td colspan="2" class="table-header">
239 <table border="0" cellpadding="0" cellspacing="0" width="100%">
240 <tr valign="top">
241 <td align="left"><span class="table-header">Properties</span></td>
242 <td align="right" valign="top"
243 ><span class="options">[<a href="#section-Properties"
244 class="privatelink" onclick="toggle_private();"
245 >hide private</a>]</span></td>
246 </tr>
247 </table>
248 </td>
249</tr>
250 <tr>
251 <td colspan="2" class="summary">
252 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
253 <code>__class__</code>
254 </p>
255 </td>
256 </tr>
257</table>
258<!-- ==================== METHOD DETAILS ==================== -->
259<a name="section-MethodDetails"></a>
260<table class="details" border="1" cellpadding="3"
261 cellspacing="0" width="100%" bgcolor="white">
262<tr bgcolor="#70b0f0" class="table-header">
263 <td colspan="2" class="table-header">
264 <table border="0" cellpadding="0" cellspacing="0" width="100%">
265 <tr valign="top">
266 <td align="left"><span class="table-header">Method Details</span></td>
267 <td align="right" valign="top"
268 ><span class="options">[<a href="#section-MethodDetails"
269 class="privatelink" onclick="toggle_private();"
270 >hide private</a>]</span></td>
271 </tr>
272 </table>
273 </td>
274</tr>
275</table>
276<a name="__init__"></a>
277<div>
278<table class="details" border="1" cellpadding="3"
279 cellspacing="0" width="100%" bgcolor="white">
280<tr><td>
281 <table width="100%" cellpadding="0" cellspacing="0" border="0">
282 <tr valign="top"><td>
283 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
284 <span class="sig-arg">filename</span>)</span>
285 <br /><em class="fname">(Constructor)</em>
286 </h3>
287 </td><td align="right" valign="top"
288 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.__init__">source&nbsp;code</a></span>&nbsp;
289 </td>
290 </tr></table>
291
292 <pre class="literalblock">
293x.__init__(...) initializes x; see x.__class__.__doc__ for signature
294
295</pre>
296 <dl class="fields">
297 <dt>Overrides:
298 object.__init__
299 <dd><em class="note">(inherited documentation)</em></dd>
300 </dt>
301 </dl>
302</td></tr></table>
303</div>
304<a name="acquire_lock"></a>
305<div>
306<table class="details" border="1" cellpadding="3"
307 cellspacing="0" width="100%" bgcolor="white">
308<tr><td>
309 <table width="100%" cellpadding="0" cellspacing="0" border="0">
310 <tr valign="top"><td>
311 <h3 class="epydoc"><span class="sig"><span class="sig-name">acquire_lock</span>(<span class="sig-arg">self</span>)</span>
312 </h3>
313 </td><td align="right" valign="top"
314 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.acquire_lock">source&nbsp;code</a></span>&nbsp;
315 </td>
316 </tr></table>
317
318 <pre class="literalblock">
319Acquires any lock necessary to access this Storage.
320
321This lock is not reentrant.
322
323</pre>
324 <dl class="fields">
325 <dt>Overrides:
326 <a href="oauth2client.client.Storage-class.html#acquire_lock">client.Storage.acquire_lock</a>
327 </dt>
328 </dl>
329</td></tr></table>
330</div>
331<a name="release_lock"></a>
332<div>
333<table class="details" border="1" cellpadding="3"
334 cellspacing="0" width="100%" bgcolor="white">
335<tr><td>
336 <table width="100%" cellpadding="0" cellspacing="0" border="0">
337 <tr valign="top"><td>
338 <h3 class="epydoc"><span class="sig"><span class="sig-name">release_lock</span>(<span class="sig-arg">self</span>)</span>
339 </h3>
340 </td><td align="right" valign="top"
341 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.release_lock">source&nbsp;code</a></span>&nbsp;
342 </td>
343 </tr></table>
344
345 <pre class="literalblock">
346Release the Storage lock.
347
348Trying to release a lock that isn't held will result in a
349RuntimeError.
350
351</pre>
352 <dl class="fields">
353 <dt>Overrides:
354 <a href="oauth2client.client.Storage-class.html#release_lock">client.Storage.release_lock</a>
355 </dt>
356 </dl>
357</td></tr></table>
358</div>
359<a name="locked_get"></a>
360<div>
361<table class="details" border="1" cellpadding="3"
362 cellspacing="0" width="100%" bgcolor="white">
363<tr><td>
364 <table width="100%" cellpadding="0" cellspacing="0" border="0">
365 <tr valign="top"><td>
366 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span>
367 </h3>
368 </td><td align="right" valign="top"
369 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_get">source&nbsp;code</a></span>&nbsp;
370 </td>
371 </tr></table>
372
373 <pre class="literalblock">
374Retrieve Credential from file.
375
376Returns:
377 oauth2client.client.Credentials
378
379</pre>
380 <dl class="fields">
381 <dt>Overrides:
382 <a href="oauth2client.client.Storage-class.html#locked_get">client.Storage.locked_get</a>
383 </dt>
384 </dl>
385</td></tr></table>
386</div>
387<a name="_create_file_if_needed"></a>
388<div class="private">
389<table class="details" border="1" cellpadding="3"
390 cellspacing="0" width="100%" bgcolor="white">
391<tr><td>
392 <table width="100%" cellpadding="0" cellspacing="0" border="0">
393 <tr valign="top"><td>
394 <h3 class="epydoc"><span class="sig"><span class="sig-name">_create_file_if_needed</span>(<span class="sig-arg">self</span>)</span>
395 </h3>
396 </td><td align="right" valign="top"
397 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage._create_file_if_needed">source&nbsp;code</a></span>&nbsp;
398 </td>
399 </tr></table>
400
401 <pre class="literalblock">
402Create an empty file if necessary.
403
404This method will not initialize the file. Instead it implements a
405simple version of &quot;touch&quot; to ensure the file has been created.
406
407</pre>
408 <dl class="fields">
409 </dl>
410</td></tr></table>
411</div>
412<a name="locked_put"></a>
413<div>
414<table class="details" border="1" cellpadding="3"
415 cellspacing="0" width="100%" bgcolor="white">
416<tr><td>
417 <table width="100%" cellpadding="0" cellspacing="0" border="0">
418 <tr valign="top"><td>
419 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>,
420 <span class="sig-arg">credentials</span>)</span>
421 </h3>
422 </td><td align="right" valign="top"
423 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_put">source&nbsp;code</a></span>&nbsp;
424 </td>
425 </tr></table>
426
427 <pre class="literalblock">
428Write Credentials to file.
429
430Args:
431 credentials: Credentials, the credentials to store.
432
433</pre>
434 <dl class="fields">
435 <dt>Overrides:
436 <a href="oauth2client.client.Storage-class.html#locked_put">client.Storage.locked_put</a>
437 </dt>
438 </dl>
439</td></tr></table>
440</div>
441<a name="locked_delete"></a>
442<div>
443<table class="details" border="1" cellpadding="3"
444 cellspacing="0" width="100%" bgcolor="white">
445<tr><td>
446 <table width="100%" cellpadding="0" cellspacing="0" border="0">
447 <tr valign="top"><td>
448 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_delete</span>(<span class="sig-arg">self</span>)</span>
449 </h3>
450 </td><td align="right" valign="top"
451 ><span class="codelink"><a href="oauth2client.file-pysrc.html#Storage.locked_delete">source&nbsp;code</a></span>&nbsp;
452 </td>
453 </tr></table>
454
455 <pre class="literalblock">
456Delete Credentials file.
457
458Args:
459 credentials: Credentials, the credentials to store.
460
461</pre>
462 <dl class="fields">
463 <dt>Overrides:
464 <a href="oauth2client.client.Storage-class.html#locked_delete">client.Storage.locked_delete</a>
465 </dt>
466 </dl>
467</td></tr></table>
468</div>
469<br />
470<!-- ==================== NAVIGATION BAR ==================== -->
471<table class="navbar" border="0" width="100%" cellpadding="0"
472 bgcolor="#a0c0ff" cellspacing="0">
473 <tr valign="middle">
474
475 <!-- Tree link -->
476 <th>&nbsp;&nbsp;&nbsp;<a
477 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
478
479 <!-- Index link -->
480 <th>&nbsp;&nbsp;&nbsp;<a
481 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
482
483 <!-- Help link -->
484 <th>&nbsp;&nbsp;&nbsp;<a
485 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
486
487 <th class="navbar" width="100%"></th>
488 </tr>
489</table>
490<table border="0" cellpadding="0" cellspacing="0" width="100%%">
491 <tr>
492 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame^]493 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:14 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]494 </td>
495 <td align="right" class="footer">
496 <a target="mainFrame" href="http://epydoc.sourceforge.net"
497 >http://epydoc.sourceforge.net</a>
498 </td>
499 </tr>
500</table>
501
502<script type="text/javascript">
503 <!--
504 // Private objects are initially displayed (because if
505 // javascript is turned off then we want them to be
506 // visible); but by default, we want to hide them. So hide
507 // them unless we have a cookie that says to show them.
508 checkCookie();
509 // -->
510</script>
511</body>
512</html>