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