Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d02bf5ee3860a50d36f960cd2c90ab6d1ecec7cd / . / docs / oauth2client.file.html
blob: 07497d04ed394bd8cb65434f271ad8aa3d3580fe [file] [log] [blame]
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module oauth2client.file</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.file</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregoriod02bf5e2012-03-02 13:21:32 -0800[diff] [blame^]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py</a></font></td></tr></table>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]12 <p><tt>Utilities&nbsp;for&nbsp;OAuth.<br>
13&nbsp;<br>
14Utilities&nbsp;for&nbsp;making&nbsp;it&nbsp;easier&nbsp;to&nbsp;work&nbsp;with&nbsp;OAuth&nbsp;2.0<br>
15credentials.</tt></p>
16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#aa55cc">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21
22<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
24</td><td width="25%" valign=top><a href="json.html">json</a><br>
25</td><td width="25%" valign=top><a href="stat.html">stat</a><br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]26</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]27</td></tr></table></td></tr></table><p>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]28<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
29<tr bgcolor="#ee77aa">
30<td colspan=3 valign=bottom>&nbsp;<br>
31<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
32
33<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
34<td width="100%"><dl>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]35<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]36</font></dt><dd>
37<dl>
38<dt><font face="helvetica, arial"><a href="oauth2client.file.html#Storage">Storage</a>
39</font></dt></dl>
40</dd>
41</dl>
42 <p>
43<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
44<tr bgcolor="#ffc8d8">
45<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]46<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>)</font></td></tr>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]47
48<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
49<td colspan=2><tt>Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential&nbsp;to&nbsp;and&nbsp;from&nbsp;a&nbsp;file.<br>&nbsp;</tt></td></tr>
50<tr><td>&nbsp;</td>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]51<td width="100%"><dl><dt>Method resolution order:</dt>
52<dd><a href="oauth2client.file.html#Storage">Storage</a></dd>
53<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
54<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
55</dl>
56<hr>
57Methods defined here:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]58<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl>
59
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]60<dl><dt><a name="Storage-acquire_lock"><strong>acquire_lock</strong></a>(self)</dt><dd><tt>Acquires&nbsp;any&nbsp;lock&nbsp;necessary&nbsp;to&nbsp;access&nbsp;this&nbsp;<a href="#Storage">Storage</a>.<br>
61&nbsp;<br>
62This&nbsp;lock&nbsp;is&nbsp;not&nbsp;reentrant.</tt></dd></dl>
63
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]64<dl><dt><a name="Storage-locked_delete"><strong>locked_delete</strong></a>(self)</dt><dd><tt>Delete&nbsp;Credentials&nbsp;file.<br>
65&nbsp;<br>
66Args:<br>
67&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
68
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]69<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;file.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]70&nbsp;<br>
71Returns:<br>
72&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
73
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]74<dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;Credentials&nbsp;to&nbsp;file.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]75&nbsp;<br>
76Args:<br>
77&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
78
79<dl><dt><a name="Storage-release_lock"><strong>release_lock</strong></a>(self)</dt><dd><tt>Release&nbsp;the&nbsp;<a href="#Storage">Storage</a>&nbsp;lock.<br>
80&nbsp;<br>
81Trying&nbsp;to&nbsp;release&nbsp;a&nbsp;lock&nbsp;that&nbsp;isn't&nbsp;held&nbsp;will&nbsp;result&nbsp;in&nbsp;a<br>
82RuntimeError.</tt></dd></dl>
83
84<hr>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]85Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]86<dl><dt><a name="Storage-delete"><strong>delete</strong></a>(self)</dt><dd><tt>Delete&nbsp;credential.<br>
87&nbsp;<br>
88Frees&nbsp;any&nbsp;resources&nbsp;associated&nbsp;with&nbsp;storing&nbsp;the&nbsp;credential.<br>
89The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;*not*&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
90&nbsp;<br>
91Returns:<br>
92&nbsp;&nbsp;None</tt></dd></dl>
93
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]94<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;credential.<br>
95&nbsp;<br>
96The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;*not*&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
97&nbsp;<br>
98Returns:<br>
99&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
100
101<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;credential.<br>
102&nbsp;<br>
103The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
104&nbsp;<br>
105Args:<br>
106&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
107
108<hr>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]109Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]110<dl><dt><strong>__dict__</strong></dt>
111<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
112</dl>
113<dl><dt><strong>__weakref__</strong></dt>
114<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
115</dl>
116</td></tr></table></td></tr></table><p>
117<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
118<tr bgcolor="#55aa55">
119<td colspan=3 valign=bottom>&nbsp;<br>
120<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
121
122<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
123<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
124<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
125<tr bgcolor="#7799ee">
126<td colspan=3 valign=bottom>&nbsp;<br>
127<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
128
129<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
130<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
131</body></html>