| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module oauth2client.file</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <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 |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/clean/oauth2client/file.py">/usr/local/google/home/jcgregorio/projects/clean/oauth2client/file.py</a></font></td></tr></table> |
| <p><tt>Utilities for OAuth.<br> |
| <br> |
| Utilities for making it easier to work with OAuth 2.0<br> |
| credentials.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br> |
| </td><td width="25%" valign=top><a href="json.html">json</a><br> |
| </td><td width="25%" valign=top><a href="stat.html">stat</a><br> |
| </td><td width="25%" valign=top><a href="threading.html">threading</a><br> |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="oauth2client.file.html#Storage">Storage</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <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> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Store and retrieve a single credential to and from a file.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="oauth2client.file.html#Storage">Storage</a></dd> |
| <dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl> |
| |
| <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> |
| <br> |
| This lock is not reentrant.</tt></dd></dl> |
| |
| <dl><dt><a name="Storage-locked_delete"><strong>locked_delete</strong></a>(self)</dt><dd><tt>Delete Credentials file.<br> |
| <br> |
| Args:<br> |
| credentials: Credentials, the credentials to store.</tt></dd></dl> |
| |
| <dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve Credential from file.<br> |
| <br> |
| Returns:<br> |
| oauth2client.client.Credentials</tt></dd></dl> |
| |
| <dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write Credentials to file.<br> |
| <br> |
| Args:<br> |
| credentials: Credentials, the credentials to store.</tt></dd></dl> |
| |
| <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> |
| <br> |
| Trying to release a lock that isn't held will result in a<br> |
| RuntimeError.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br> |
| <dl><dt><a name="Storage-delete"><strong>delete</strong></a>(self)</dt><dd><tt>Delete credential.<br> |
| <br> |
| Frees any resources associated with storing the credential.<br> |
| The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br> |
| <br> |
| Returns:<br> |
| None</tt></dd></dl> |
| |
| <dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br> |
| <br> |
| The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br> |
| <br> |
| Returns:<br> |
| oauth2client.client.Credentials</tt></dd></dl> |
| |
| <dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write a credential.<br> |
| <br> |
| The <a href="#Storage">Storage</a> lock must be held when this is called.<br> |
| <br> |
| Args:<br> |
| credentials: Credentials, the credentials to store.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#55aa55"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| <td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#7799ee"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| <td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table> |
| </body></html> |