Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f08a4985170209be9bc4382c264a202bc2ea202c / . / docs / oauth2client.file.html
blob: dd6c31807a695e351c9b9b4861a052c3ffb7f141 [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 Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/file.py">/usr/local/google/home/jcgregorio/projects/apiclient/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>
23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]24</td><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]25</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]26</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]27<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
28<tr bgcolor="#ee77aa">
29<td colspan=3 valign=bottom>&nbsp;<br>
30<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
31
32<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
33<td width="100%"><dl>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]34<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]35</font></dt><dd>
36<dl>
37<dt><font face="helvetica, arial"><a href="oauth2client.file.html#Storage">Storage</a>
38</font></dt></dl>
39</dd>
40</dl>
41 <p>
42<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
43<tr bgcolor="#ffc8d8">
44<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]45<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]46
47<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
48<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>
49<tr><td>&nbsp;</td>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]50<td width="100%"><dl><dt>Method resolution order:</dt>
51<dd><a href="oauth2client.file.html#Storage">Storage</a></dd>
52<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
53<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
54</dl>
55<hr>
56Methods defined here:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]57<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl>
58
59<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;file.<br>
60&nbsp;<br>
61Returns:<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]62&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]63
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]64<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;Credentials&nbsp;to&nbsp;file.<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]65&nbsp;<br>
66Args:<br>
67&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
68
69<hr>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]70Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
71<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>
72&nbsp;<br>
73This&nbsp;lock&nbsp;is&nbsp;not&nbsp;reentrant.</tt></dd></dl>
74
75<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;credential.<br>
76&nbsp;<br>
77The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
78&nbsp;<br>
79Returns:<br>
80&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
81
82<dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;credential.<br>
83&nbsp;<br>
84The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
85&nbsp;<br>
86Args:<br>
87&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
88
89<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>
90&nbsp;<br>
91Trying&nbsp;to&nbsp;release&nbsp;a&nbsp;lock&nbsp;that&nbsp;isn't&nbsp;held&nbsp;will&nbsp;result&nbsp;in&nbsp;a<br>
92RuntimeError.</tt></dd></dl>
93
94<hr>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]95Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]96<dl><dt><strong>__dict__</strong></dt>
97<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
98</dl>
99<dl><dt><strong>__weakref__</strong></dt>
100<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
101</dl>
102</td></tr></table></td></tr></table><p>
103<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
104<tr bgcolor="#55aa55">
105<td colspan=3 valign=bottom>&nbsp;<br>
106<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
107
108<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
109<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
110<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
111<tr bgcolor="#7799ee">
112<td colspan=3 valign=bottom>&nbsp;<br>
113<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
114
115<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
116<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
117</body></html>