| Joe Gregorio | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 1 | |
| 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> <br> |
| 9 | <font color="#ffffff" face="helvetica, arial"> <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 |
| Joe Gregorio | d02bf5e | 2012-03-02 13:21:32 -0800 | [diff] [blame^] | 11 | ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/ext/file.py">/home/jcgregorio/projects/google-api-python-client/apiclient/ext/file.py</a></font></td></tr></table> |
| Joe Gregorio | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 12 | <p><tt>Utilities for OAuth.<br> |
| 13 | <br> |
| 14 | Utilities for making it easier to work with OAuth 1.0 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> <br> |
| 19 | <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| 20 | |
| 21 | <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| 22 | <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="pickle.html">pickle</a><br> |
| Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 23 | </td><td width="25%" valign=top><a href="threading.html">threading</a><br> |
| 24 | </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| Joe Gregorio | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 25 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 26 | <tr bgcolor="#ee77aa"> |
| 27 | <td colspan=3 valign=bottom> <br> |
| 28 | <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| 29 | |
| 30 | <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| 31 | <td width="100%"><dl> |
| Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 32 | <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 | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 33 | </font></dt><dd> |
| 34 | <dl> |
| 35 | <dt><font face="helvetica, arial"><a href="apiclient.ext.file.html#Storage">Storage</a> |
| 36 | </font></dt></dl> |
| 37 | </dd> |
| 38 | </dl> |
| 39 | <p> |
| 40 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 41 | <tr bgcolor="#ffc8d8"> |
| 42 | <td colspan=3 valign=bottom> <br> |
| Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 43 | <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 | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 44 | |
| 45 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 46 | <td colspan=2><tt>Store and retrieve a single credential to and from a file.<br> </tt></td></tr> |
| 47 | <tr><td> </td> |
| 48 | <td width="100%"><dl><dt>Method resolution order:</dt> |
| 49 | <dd><a href="apiclient.ext.file.html#Storage">Storage</a></dd> |
| Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 50 | <dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd> |
| Joe Gregorio | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 51 | <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| 52 | </dl> |
| 53 | <hr> |
| 54 | Methods defined here:<br> |
| 55 | <dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl> |
| 56 | |
| 57 | <dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve Credential from file.<br> |
| 58 | <br> |
| 59 | Returns:<br> |
| 60 | apiclient.oauth.Credentials</tt></dd></dl> |
| 61 | |
| 62 | <dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write a pickled Credentials to file.<br> |
| 63 | <br> |
| 64 | Args:<br> |
| 65 | credentials: Credentials, the credentials to store.</tt></dd></dl> |
| 66 | |
| 67 | <hr> |
| Joe Gregorio | 3d55ac5 | 2012-02-21 10:11:19 -0500 | [diff] [blame] | 68 | Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br> |
| 69 | <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> |
| 70 | <br> |
| 71 | This lock is not reentrant.</tt></dd></dl> |
| 72 | |
| 73 | <dl><dt><a name="Storage-delete"><strong>delete</strong></a>(self)</dt><dd><tt>Delete credential.<br> |
| 74 | <br> |
| 75 | Frees any resources associated with storing the credential.<br> |
| 76 | The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br> |
| 77 | <br> |
| 78 | Returns:<br> |
| 79 | None</tt></dd></dl> |
| 80 | |
| 81 | <dl><dt><a name="Storage-locked_delete"><strong>locked_delete</strong></a>(self)</dt><dd><tt>Delete a credential.<br> |
| 82 | <br> |
| 83 | The <a href="#Storage">Storage</a> lock must be held when this is called.</tt></dd></dl> |
| 84 | |
| 85 | <dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br> |
| 86 | <br> |
| 87 | The <a href="#Storage">Storage</a> lock must be held when this is called.<br> |
| 88 | <br> |
| 89 | Returns:<br> |
| 90 | oauth2client.client.Credentials</tt></dd></dl> |
| 91 | |
| 92 | <dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write a credential.<br> |
| 93 | <br> |
| 94 | The <a href="#Storage">Storage</a> lock must be held when this is called.<br> |
| 95 | <br> |
| 96 | Args:<br> |
| 97 | credentials: Credentials, the credentials to store.</tt></dd></dl> |
| 98 | |
| 99 | <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> |
| 100 | <br> |
| 101 | Trying to release a lock that isn't held will result in a<br> |
| 102 | RuntimeError.</tt></dd></dl> |
| 103 | |
| 104 | <hr> |
| 105 | Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br> |
| Joe Gregorio | fffa7d7 | 2011-02-18 17:20:39 -0500 | [diff] [blame] | 106 | <dl><dt><strong>__dict__</strong></dt> |
| 107 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 108 | </dl> |
| 109 | <dl><dt><strong>__weakref__</strong></dt> |
| 110 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 111 | </dl> |
| 112 | </td></tr></table></td></tr></table><p> |
| 113 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 114 | <tr bgcolor="#55aa55"> |
| 115 | <td colspan=3 valign=bottom> <br> |
| 116 | <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| 117 | |
| 118 | <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| 119 | <td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p> |
| 120 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 121 | <tr bgcolor="#7799ee"> |
| 122 | <td colspan=3 valign=bottom> <br> |
| 123 | <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| 124 | |
| 125 | <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| 126 | <td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table> |
| 127 | </body></html> |