| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.sample_util</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="gdata.html"><font color="#ffffff">gdata</font></a>.sample_util</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/afshar/src/external-gdata-release/google3/src/gdata/sample_util.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/sample_util.py</a></font></td></tr></table> |
| <p><tt>Provides utility functions used with command line samples.</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="gdata.html">gdata</a><br> |
| </td><td width="25%" valign=top><a href="getpass.html">getpass</a><br> |
| </td><td width="25%" valign=top><a href="sys.html">sys</a><br> |
| </td><td width="25%" valign=top><a href="urllib.html">urllib</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="__builtin__.html#object">__builtin__.object</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.sample_util.html#SettingsUtil">SettingsUtil</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="SettingsUtil">class <strong>SettingsUtil</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Gather's user preferences from flags or command prompts.<br> |
| <br> |
| An instance of this <a href="__builtin__.html#object">object</a> stores the choices made by the user. At some<br> |
| point it might be useful to save the user's preferences so that they do<br> |
| not need to always set flags or answer preference prompts.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="SettingsUtil-__init__"><strong>__init__</strong></a>(self, prefs<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="SettingsUtil-authorize_client"><strong>authorize_client</strong></a>(self, client, auth_type<font color="#909090">=None</font>, service<font color="#909090">=None</font>, source<font color="#909090">=None</font>, scopes<font color="#909090">=None</font>, oauth_type<font color="#909090">=None</font>, consumer_key<font color="#909090">=None</font>, consumer_secret<font color="#909090">=None</font>)</dt><dd><tt>Uses command line arguments, or prompts user for token values.</tt></dd></dl> |
| |
| <dl><dt><a name="SettingsUtil-get_param"><strong>get_param</strong></a>(self, name, prompt<font color="#909090">=''</font>, secret<font color="#909090">=False</font>, ask<font color="#909090">=True</font>, reuse<font color="#909090">=False</font>)</dt></dl> |
| |
| <hr> |
| Data descriptors defined here:<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="#eeaa77"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt><a name="-authorize_client"><strong>authorize_client</strong></a>(client, auth_type<font color="#909090">=None</font>, service<font color="#909090">=None</font>, source<font color="#909090">=None</font>, scopes<font color="#909090">=None</font>, oauth_type<font color="#909090">=None</font>, consumer_key<font color="#909090">=None</font>, consumer_secret<font color="#909090">=None</font>)</dt><dd><tt>Uses command line arguments, or prompts user for token values.</tt></dd></dl> |
| <dl><dt><a name="-get_param"><strong>get_param</strong></a>(name, prompt<font color="#909090">=''</font>, secret<font color="#909090">=False</font>, ask<font color="#909090">=True</font>)</dt></dl> |
| <dl><dt><a name="-print_options"><strong>print_options</strong></a>()</dt><dd><tt>Displays usage information, available command line params.</tt></dd></dl> |
| </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>AUTHSUB</strong> = 2<br> |
| <strong>CLIENT_LOGIN</strong> = 1<br> |
| <strong>HMAC</strong> = 1<br> |
| <strong>OAUTH</strong> = 3<br> |
| <strong>RSA</strong> = 2<br> |
| <strong>__author__</strong> = 'j.s@google.com (Jeff Scudder)'</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%">j.s@google.com (Jeff Scudder)</td></tr></table> |
| </body></html> |
