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