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