| Joe Gregorio | 6e53703 | 2011-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> <br> |
| 9 | <font color="#ffffff" face="helvetica, arial"> <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 Gregorio | 761c456 | 2011-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 Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 12 | <p><tt>Utilities for OAuth.<br> |
| 13 | <br> |
| 14 | Utilities for making it easier to work with OAuth 2.0<br> |
| 15 | credentials.</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> <br> |
| 20 | <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| 21 | |
| 22 | <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| Joe Gregorio | b417caf | 2011-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 Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 24 | </td><td width="25%" valign=top><a href="threading.html">threading</a><br> |
| Joe Gregorio | 761c456 | 2011-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 Gregorio | 6e53703 | 2011-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> <br> |
| 29 | <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| 30 | |
| 31 | <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| 32 | <td width="100%"><dl> |
| Joe Gregorio | 3b79fa8 | 2011-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 Gregorio | 6e53703 | 2011-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> <br> |
| Joe Gregorio | 3b79fa8 | 2011-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 Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 45 | |
| 46 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 47 | <td colspan=2><tt>Store and retrieve a single credential to and from a file.<br> </tt></td></tr> |
| 48 | <tr><td> </td> |
| Joe Gregorio | 3b79fa8 | 2011-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> |
| 55 | Methods defined here:<br> |
| Joe Gregorio | 6e53703 | 2011-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 Gregorio | a845167 | 2011-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 any lock necessary to access this <a href="#Storage">Storage</a>.<br> |
| 59 | <br> |
| 60 | This lock is not reentrant.</tt></dd></dl> |
| 61 | |
| Joe Gregorio | 761c456 | 2011-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 Credential from file.<br> |
| Joe Gregorio | a845167 | 2011-09-15 09:53:21 -0400 | [diff] [blame] | 63 | <br> |
| 64 | Returns:<br> |
| 65 | oauth2client.client.Credentials</tt></dd></dl> |
| 66 | |
| Joe Gregorio | 761c456 | 2011-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 Credentials to file.<br> |
| Joe Gregorio | a845167 | 2011-09-15 09:53:21 -0400 | [diff] [blame] | 68 | <br> |
| 69 | Args:<br> |
| 70 | credentials: Credentials, the credentials to store.</tt></dd></dl> |
| 71 | |
| 72 | <dl><dt><a name="Storage-release_lock"><strong>release_lock</strong></a>(self)</dt><dd><tt>Release the <a href="#Storage">Storage</a> lock.<br> |
| 73 | <br> |
| 74 | Trying to release a lock that isn't held will result in a<br> |
| 75 | RuntimeError.</tt></dd></dl> |
| 76 | |
| 77 | <hr> |
| Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 78 | Methods 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 credential.<br> |
| 80 | <br> |
| 81 | The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br> |
| 82 | <br> |
| 83 | Returns:<br> |
| 84 | oauth2client.client.Credentials</tt></dd></dl> |
| 85 | |
| 86 | <dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write a credential.<br> |
| 87 | <br> |
| 88 | The <a href="#Storage">Storage</a> lock must be held when this is called.<br> |
| 89 | <br> |
| 90 | Args:<br> |
| 91 | credentials: Credentials, the credentials to store.</tt></dd></dl> |
| 92 | |
| 93 | <hr> |
| Joe Gregorio | 3b79fa8 | 2011-02-17 11:47:17 -0500 | [diff] [blame] | 94 | Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br> |
| Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 95 | <dl><dt><strong>__dict__</strong></dt> |
| 96 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 97 | </dl> |
| 98 | <dl><dt><strong>__weakref__</strong></dt> |
| 99 | <dd><tt>list of weak references to the object (if 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> <br> |
| 105 | <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| 106 | |
| 107 | <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </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> <br> |
| 112 | <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| 113 | |
| 114 | <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| 115 | <td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table> |
| 116 | </body></html> |