blob: 3a7ae641ebd10aaab654c11440be769c8a6984e9 [file] [log] [blame]
Joe Gregoriofffa7d72011-02-18 17:20:39 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.ext.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="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.ext.html"><font color="#ffffff">ext</font></a>.file</strong></big></big></font></td
10><td align=right valign=bottom
11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiary/apiclient/ext/file.py">/home/jcgregorio/projects/apiary/apiclient/ext/file.py</a></font></td></tr></table>
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;1.0&nbsp;credentials.</tt></p>
15<p>
16<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
17<tr bgcolor="#aa55cc">
18<td colspan=3 valign=bottom>&nbsp;<br>
19<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
20
21<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
22<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
23</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
24<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
25<tr bgcolor="#ee77aa">
26<td colspan=3 valign=bottom>&nbsp;<br>
27<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
28
29<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
30<td width="100%"><dl>
31<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Storage">apiclient.oauth.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
32</font></dt><dd>
33<dl>
34<dt><font face="helvetica, arial"><a href="apiclient.ext.file.html#Storage">Storage</a>
35</font></dt></dl>
36</dd>
37</dl>
38 <p>
39<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
40<tr bgcolor="#ffc8d8">
41<td colspan=3 valign=bottom>&nbsp;<br>
42<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="apiclient.oauth.html#Storage">apiclient.oauth.Storage</a>)</font></td></tr>
43
44<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
45<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>
46<tr><td>&nbsp;</td>
47<td width="100%"><dl><dt>Method resolution order:</dt>
48<dd><a href="apiclient.ext.file.html#Storage">Storage</a></dd>
49<dd><a href="apiclient.oauth.html#Storage">apiclient.oauth.Storage</a></dd>
50<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
51</dl>
52<hr>
53Methods defined here:<br>
54<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl>
55
56<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;file.<br>
57&nbsp;<br>
58Returns:<br>
59&nbsp;&nbsp;apiclient.oauth.Credentials</tt></dd></dl>
60
61<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;pickled&nbsp;Credentials&nbsp;to&nbsp;file.<br>
62&nbsp;<br>
63Args:<br>
64&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
65
66<hr>
67Data descriptors inherited from <a href="apiclient.oauth.html#Storage">apiclient.oauth.Storage</a>:<br>
68<dl><dt><strong>__dict__</strong></dt>
69<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
70</dl>
71<dl><dt><strong>__weakref__</strong></dt>
72<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
73</dl>
74</td></tr></table></td></tr></table><p>
75<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
76<tr bgcolor="#55aa55">
77<td colspan=3 valign=bottom>&nbsp;<br>
78<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
79
80<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
81<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
82<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
83<tr bgcolor="#7799ee">
84<td colspan=3 valign=bottom>&nbsp;<br>
85<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
86
87<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
88<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
89</body></html>