| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.client</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>.client</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/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/client.py</a></font></td></tr></table> |
| <p><tt>Provides a client to interact with Google Data API servers.<br> |
| <br> |
| This module is used for version 2 of the Google Data APIs. The primary class<br> |
| in this module is <a href="#GDClient">GDClient</a>.<br> |
| <br> |
| <a href="#GDClient">GDClient</a>: handles auth and CRUD operations when communicating with servers.<br> |
| GDataClient: deprecated client for version one services. Will be removed.</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="atom.html">atom</a><br> |
| </td><td width="25%" valign=top><a href="gdata.html">gdata</a><br> |
| </td><td width="25%" valign=top><a href="re.html">re</a><br> |
| </td><td width="25%" valign=top></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.client.html#Query">Query</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#ResumableUploader">ResumableUploader</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">GDClient</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="atom.http_core.html#Uri">atom.http_core.Uri</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#GDQuery">GDQuery</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#Error">Error</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#ClientLoginTokenMissing">ClientLoginTokenMissing</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#MissingOAuthParameters">MissingOAuthParameters</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#RequestError">RequestError</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#BadAuthentication">BadAuthentication</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#CaptchaChallenge">CaptchaChallenge</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#ClientLoginFailed">ClientLoginFailed</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#NotImplemented">NotImplemented</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#NotModified">NotModified</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.client.html#RedirectError">RedirectError</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#BadAuthenticationServiceURL">BadAuthenticationServiceURL</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#UnableToUpgradeToken">UnableToUpgradeToken</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#Unauthorized">Unauthorized</a> |
| </font></dt></dl> |
| </dd> |
| </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="BadAuthentication">class <strong>BadAuthentication</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#BadAuthentication">BadAuthentication</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="BadAuthentication-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BadAuthentication-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="BadAuthentication-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="BadAuthentication-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="BadAuthentication-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthentication-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthentication-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="BadAuthenticationServiceURL">class <strong>BadAuthenticationServiceURL</strong></a>(<a href="gdata.client.html#RedirectError">RedirectError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#BadAuthenticationServiceURL">BadAuthenticationServiceURL</a></dd> |
| <dd><a href="gdata.client.html#RedirectError">RedirectError</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="BadAuthenticationServiceURL-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#BadAuthenticationServiceURL-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="BadAuthenticationServiceURL-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#BadAuthenticationServiceURL-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="BadAuthenticationServiceURL-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="CaptchaChallenge">class <strong>CaptchaChallenge</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#CaptchaChallenge">CaptchaChallenge</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>captcha_token</strong> = None</dl> |
| |
| <dl><dt><strong>captcha_url</strong> = None</dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="CaptchaChallenge-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#CaptchaChallenge-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="CaptchaChallenge-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#CaptchaChallenge-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="CaptchaChallenge-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="ClientLoginFailed">class <strong>ClientLoginFailed</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#ClientLoginFailed">ClientLoginFailed</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="ClientLoginFailed-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ClientLoginFailed-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="ClientLoginFailed-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginFailed-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginFailed-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="ClientLoginTokenMissing">class <strong>ClientLoginTokenMissing</strong></a>(<a href="gdata.client.html#Error">Error</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#ClientLoginTokenMissing">ClientLoginTokenMissing</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="ClientLoginTokenMissing-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ClientLoginTokenMissing-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="ClientLoginTokenMissing-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ClientLoginTokenMissing-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="ClientLoginTokenMissing-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="GDClient">class <strong>GDClient</strong></a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Communicates with Google Data servers to perform CRUD operations.<br> |
| <br> |
| This class is currently experimental and may change in backwards<br> |
| incompatible ways.<br> |
| <br> |
| This class exists to simplify the following three areas involved in using<br> |
| the Google Data APIs.<br> |
| <br> |
| CRUD Operations:<br> |
| <br> |
| The client provides a generic 'request' method for making HTTP requests.<br> |
| There are a number of convenience methods which are built on top of<br> |
| request, which include get_feed, get_entry, get_next, post, update, and<br> |
| delete. These methods contact the Google Data servers.<br> |
| <br> |
| Auth:<br> |
| <br> |
| Reading user-specific private data requires authorization from the user as<br> |
| do any changes to user data. An auth_token <a href="__builtin__.html#object">object</a> can be passed into any<br> |
| of the HTTP requests to set the Authorization header in the request.<br> |
| <br> |
| You may also want to set the auth_token member to a an <a href="__builtin__.html#object">object</a> which can<br> |
| use modify_request to set the Authorization header in the HTTP request.<br> |
| <br> |
| If you are authenticating using the email address and password, you can<br> |
| use the client_login method to obtain an auth token and set the<br> |
| auth_token member.<br> |
| <br> |
| If you are using browser redirects, specifically AuthSub, you will want<br> |
| to use gdata.gauth.AuthSubToken.from_url to obtain the token after the<br> |
| redirect, and you will probably want to updgrade this since use token<br> |
| to a multiple use (session) token using the upgrade_token method.<br> |
| <br> |
| API Versions:<br> |
| <br> |
| This client is multi-version capable and can be used with Google Data API<br> |
| version 1 and version 2. The version should be specified by setting the<br> |
| api_version member to a string, either '1' or '2'.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#GDClient">GDClient</a></dd> |
| <dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="GDClient-Batch"><strong>Batch</strong></a> = <a href="#GDClient-batch">batch</a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-ClientLogin"><strong>ClientLogin</strong></a> = <a href="#GDClient-client_login">client_login</a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-Delete"><strong>Delete</strong></a> = <a href="#GDClient-delete">delete</a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-GetAccessToken"><strong>GetAccessToken</strong></a> = <a href="#GDClient-get_access_token">get_access_token</a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-GetEntry"><strong>GetEntry</strong></a> = <a href="#GDClient-get_entry">get_entry</a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-GetFeed"><strong>GetFeed</strong></a> = <a href="#GDClient-get_feed">get_feed</a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-GetNext"><strong>GetNext</strong></a> = <a href="#GDClient-get_next">get_next</a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = <a href="#GDClient-get_oauth_token">get_oauth_token</a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-ModifyRequest"><strong>ModifyRequest</strong></a> = <a href="#GDClient-modify_request">modify_request</a>(self, http_request)</dt></dl> |
| |
| <dl><dt><a name="GDClient-Post"><strong>Post</strong></a> = <a href="#GDClient-post">post</a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-Request"><strong>Request</strong></a> = <a href="#GDClient-request">request</a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = <a href="#GDClient-request_client_login_token">request_client_login_token</a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-RevokeToken"><strong>RevokeToken</strong></a> = <a href="#GDClient-revoke_token">revoke_token</a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-Update"><strong>Update</strong></a> = <a href="#GDClient-update">update</a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-UpgradeToken"><strong>UpgradeToken</strong></a> = <a href="#GDClient-upgrade_token">upgrade_token</a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br> |
| <br> |
| Args:<br> |
| feed: A batch feed containing batch entries, each is an operation.<br> |
| uri: (optional) The uri to which the batch request feed should be POSTed.<br> |
| If none is provided, then the feed's edit link will be used.<br> |
| force: (optional) boolean set to True if you want the batch update to<br> |
| clobber all data. If False, the version in the information in the<br> |
| feed <a href="__builtin__.html#object">object</a> will cause the server to check to see that no changes<br> |
| intervened between when you fetched the data and when you sent the<br> |
| changes.<br> |
| auth_token: (optional) An <a href="__builtin__.html#object">object</a> which sets the Authorization HTTP header<br> |
| in its modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
| <br> |
| In order to modify user specific data and read user private data, your<br> |
| application must be authorized by the user. One way to demonstrage<br> |
| authorization is by including a Client Login token in the Authorization<br> |
| HTTP header of all requests. This method requests the Client Login token<br> |
| by sending the user's email address, password, the name of the<br> |
| application, and the service code for the service which will be accessed<br> |
| by the application. If the username and password are correct, the server<br> |
| will respond with the client login code and a new ClientLoginToken<br> |
| <a href="__builtin__.html#object">object</a> will be set in the client's auth_token member. With the auth_token<br> |
| set, future requests from this client will include the Client Login<br> |
| token.<br> |
| <br> |
| For a list of service names, see <br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| For more information on Client Login, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br> |
| <br> |
| Args:<br> |
| email: str The user's email address or username.<br> |
| password: str The password for the user's account.<br> |
| source: str The name of your application. This can be anything you<br> |
| like but should should give some indication of which app is<br> |
| making the request.<br> |
| service: str The service code for the service you would like to access.<br> |
| For example, 'cp' for contacts, 'cl' for calendar. For a full<br> |
| list see<br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| If you are using a subclass of the gdata.client.<a href="#GDClient">GDClient</a>, the<br> |
| service will usually be filled in for you so you do not need<br> |
| to specify it. For example see BloggerClient,<br> |
| SpreadsheetsClient, etc.<br> |
| account_type: str (optional) The type of account which is being<br> |
| authenticated. This can be either 'GOOGLE' for a Google<br> |
| Account, 'HOSTED' for a Google Apps Account, or the<br> |
| default 'HOSTED_OR_GOOGLE' which will select the Google<br> |
| Apps Account if the same email address is used for both<br> |
| a Google Account and a Google Apps Account.<br> |
| auth_url: str (optional) The URL to which the login request should be<br> |
| sent.<br> |
| captcha_token: str (optional) If a previous login attempt was reponded<br> |
| to with a CAPTCHA challenge, this is the token which<br> |
| identifies the challenge (from the CAPTCHA's URL).<br> |
| captcha_response: str (optional) If a previous login attempt was<br> |
| reponded to with a CAPTCHA challenge, this is the<br> |
| response text which was contained in the challenge.<br> |
| <br> |
| Returns:<br> |
| Generated token, which is also stored in this <a href="__builtin__.html#object">object</a>.<br> |
| <br> |
| Raises:<br> |
| A <a href="#RequestError">RequestError</a> or one of its suclasses: <a href="#BadAuthentication">BadAuthentication</a>,<br> |
| <a href="#BadAuthenticationServiceURL">BadAuthenticationServiceURL</a>, <a href="#ClientLoginFailed">ClientLoginFailed</a>,<br> |
| <a href="#ClientLoginTokenMissing">ClientLoginTokenMissing</a>, or <a href="#CaptchaChallenge">CaptchaChallenge</a></tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br> |
| <br> |
| Contacts the Google OAuth server to upgrade a previously authorized<br> |
| request token. Once the request token is upgraded to an access token,<br> |
| the access token may be used to access the user's data.<br> |
| <br> |
| For more details, see the Google Accounts OAuth documentation:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br> |
| <br> |
| Args:<br> |
| request_token: An OAuth token which has been authorized by the user.<br> |
| url: (optional) The URL to which the upgrade request should be sent.<br> |
| Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br> |
| <br> |
| When requesting a feed, the number of entries returned is capped at a<br> |
| service specific default limit (often 25 entries). You can specify your<br> |
| own entry-count cap using the max-results URL query parameter. If there<br> |
| are more results than could fit under max-results, the feed will contain<br> |
| a next link. This method performs a GET against this next results URL.<br> |
| <br> |
| Returns:<br> |
| A new feed <a href="__builtin__.html#object">object</a> containing the next set of entries in this feed.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br> |
| <br> |
| Once this client has a request token, the user can authorize the request<br> |
| token by visiting the authorization URL in their browser. After being<br> |
| redirected back to this app at the 'next' URL, this app can then exchange<br> |
| the authorized request token for an access token.<br> |
| <br> |
| For more information see the documentation on Google Accounts with OAuth:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br> |
| <br> |
| Args:<br> |
| scopes: list of strings or atom.http_core.<a href="atom.http_core.html#Uri">Uri</a> objects which specify the<br> |
| URL prefixes which this app will be accessing. For example, to access<br> |
| the Google Calendar API, you would want to use scopes:<br> |
| ['https://www.google.com/calendar/feeds/',<br> |
| '<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br> |
| next: str or atom.http_core.<a href="atom.http_core.html#Uri">Uri</a> <a href="__builtin__.html#object">object</a>, The URL which the user's browser<br> |
| should be sent to after they authorize access to their data. This<br> |
| should be a URL in your application which will read the token<br> |
| information from the URL and upgrade the request token to an access<br> |
| token.<br> |
| consumer_key: str This is the identifier for this application which you<br> |
| should have received when you registered your application with Google<br> |
| to use OAuth.<br> |
| consumer_secret: str (optional) The shared secret between your app and<br> |
| Google which provides evidence that this request is coming from you<br> |
| application and not another app. If present, this libraries assumes<br> |
| you want to use an HMAC signature to verify requests. Keep this data<br> |
| a secret.<br> |
| rsa_private_key: str (optional) The RSA private key which is used to<br> |
| generate a digital signature which is checked by Google's server. If<br> |
| present, this library assumes that you want to use an RSA signature<br> |
| to verify requests. Keep this data a secret.<br> |
| url: The URL to which a request for a token should be made. The default<br> |
| is Google's OAuth request token provider.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br> |
| <br> |
| This client will add the API version if it is specified.<br> |
| Subclasses may override this method to add their own request<br> |
| modifications before the request is made.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="GDClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br> |
| <br> |
| See also documentation for atom.client.<a href="atom.client.html#AtomPubClient">AtomPubClient</a>.request.<br> |
| <br> |
| If a 302 redirect is sent from the server to the client, this client<br> |
| assumes that the redirect is in the form used by the Google Calendar API.<br> |
| The same request URI and method will be used as in the original request,<br> |
| but a gsessionid URL parameter will be added to the request URI with<br> |
| the value provided in the server's 302 redirect response. If the 302<br> |
| redirect is not in the format specified by the Google Calendar API, a<br> |
| <a href="#RedirectError">RedirectError</a> will be raised containing the body of the server's<br> |
| response.<br> |
| <br> |
| The method calls the client's modify_request method to make any changes<br> |
| required by the client before the request is made. For example, a<br> |
| version 2 client could add a GData-Version: 2 header to the request in<br> |
| its modify_request method.<br> |
| <br> |
| Args:<br> |
| method: str The HTTP verb for this request, usually 'GET', 'POST',<br> |
| 'PUT', or 'DELETE'<br> |
| uri: atom.http_core.<a href="atom.http_core.html#Uri">Uri</a>, str, or unicode The URL being requested.<br> |
| auth_token: An <a href="__builtin__.html#object">object</a> which sets the Authorization HTTP header in its<br> |
| modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.<br> |
| http_request: (optional) atom.http_core.HttpRequest<br> |
| converter: function which takes the body of the response as its only<br> |
| argument and returns the desired <a href="__builtin__.html#object">object</a>.<br> |
| desired_class: class descended from atom.core.XmlElement to which a<br> |
| successful response should be converted. If there is no<br> |
| converter function specified (converter=None) then the<br> |
| desired_class will be used in calling the<br> |
| atom.core.parse function. If neither<br> |
| the desired_class nor the converter is specified, an<br> |
| HTTP reponse <a href="__builtin__.html#object">object</a> will be returned.<br> |
| redirects_remaining: (optional) int, if this number is 0 and the<br> |
| server sends a 302 redirect, the request method<br> |
| will raise an exception. This parameter is used in<br> |
| recursive request calls to avoid an infinite loop.<br> |
| <br> |
| Any additional arguments are passed through to<br> |
| atom.client.<a href="atom.client.html#AtomPubClient">AtomPubClient</a>.request.<br> |
| <br> |
| Returns:<br> |
| An HTTP response <a href="__builtin__.html#object">object</a> (see atom.http_core.HttpResponse for a<br> |
| description of the <a href="__builtin__.html#object">object</a>'s interface) if no converter was<br> |
| specified and no desired_class was specified. If a converter function<br> |
| was provided, the results of calling the converter are returned. If no<br> |
| converter was specified but a desired_class was provided, the response<br> |
| body will be converted to the class using<br> |
| atom.core.parse.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="GDClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br> |
| <br> |
| This method can be used for both AuthSub and OAuth tokens (to invalidate<br> |
| a ClientLogin token, the user must change their password).<br> |
| <br> |
| Returns:<br> |
| True if the server responded with a 200.<br> |
| <br> |
| Raises:<br> |
| A <a href="#RequestError">RequestError</a> if the server responds with a non-200 status.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br> |
| <br> |
| Performs a PUT and converts the response to a new entry <a href="__builtin__.html#object">object</a> with a<br> |
| matching class to the entry passed in.<br> |
| <br> |
| Args:<br> |
| entry:<br> |
| auth_token:<br> |
| force: boolean stating whether an update should be forced. Defaults to<br> |
| False. Normally, if a change has been made since the passed in<br> |
| entry was obtained, the server will not overwrite the entry since<br> |
| the changes were based on an obsolete version of the entry.<br> |
| Setting force to True will cause the update to silently<br> |
| overwrite whatever version is present.<br> |
| uri: The uri to put to. If provided, this uri is PUT to rather than the<br> |
| inferred uri from the entry's edit link.<br> |
| <br> |
| Returns:<br> |
| A new Entry <a href="__builtin__.html#object">object</a> of a matching type to the entry which was passed in.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
| <br> |
| For details on AuthSub, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br> |
| <br> |
| Args:<br> |
| token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br> |
| (optional) If no token is passed in, the client's auth_token member<br> |
| is used to request the new token. The token <a href="__builtin__.html#object">object</a> will be modified<br> |
| to contain the new session token string.<br> |
| url: str or atom.http_core.<a href="atom.http_core.html#Uri">Uri</a> (optional) The URL to which the token<br> |
| upgrade request should be sent. Defaults to:<br> |
| https://www.google.com/accounts/AuthSubSessionToken<br> |
| <br> |
| Returns:<br> |
| The upgraded gdata.gauth.AuthSubToken <a href="__builtin__.html#object">object</a>.</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>alt_auth_service</strong> = None</dl> |
| |
| <dl><dt><strong>api_version</strong> = None</dl> |
| |
| <dl><dt><strong>auth_scopes</strong> = None</dl> |
| |
| <dl><dt><strong>auth_service</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><a name="GDClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-__init__"><strong>__init__</strong></a>(self, http_client<font color="#909090">=None</font>, host<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, source<font color="#909090">=None</font>, xoauth_requestor_id<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new <a href="atom.client.html#AtomPubClient">AtomPubClient</a> instance.<br> |
| <br> |
| Args:<br> |
| source: The name of your application.<br> |
| http_client: An <a href="__builtin__.html#object">object</a> capable of performing HTTP requests through a<br> |
| request method. This <a href="__builtin__.html#object">object</a> is used to perform the request<br> |
| when the <a href="atom.client.html#AtomPubClient">AtomPubClient</a>'s request method is called. Used to<br> |
| allow HTTP requests to be directed to a mock server, or use<br> |
| an alternate library instead of the default of httplib to<br> |
| make HTTP requests.<br> |
| host: str The default host name to use if a host is not specified in the<br> |
| requested URI.<br> |
| auth_token: An <a href="__builtin__.html#object">object</a> which sets the HTTP Authorization header when its<br> |
| modify_request method is called.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="GDClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</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> |
| <hr> |
| Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><strong>auth_token</strong> = None</dl> |
| |
| <dl><dt><strong>host</strong> = None</dl> |
| |
| <dl><dt><strong>ssl</strong> = False</dl> |
| |
| <dl><dt><strong>xoauth_requestor_id</strong> = None</dl> |
| |
| </td></tr></table> <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="GDQuery">class <strong>GDQuery</strong></a>(<a href="atom.http_core.html#Uri">atom.http_core.Uri</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#GDQuery">GDQuery</a></dd> |
| <dd><a href="atom.http_core.html#Uri">atom.http_core.Uri</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>text_query</strong></dt> |
| <dd><tt>The q parameter for searching for an exact text match on content</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="atom.http_core.html#Uri">atom.http_core.Uri</a>:<br> |
| <dl><dt><a name="GDQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request<font color="#909090">=None</font>)</dt><dd><tt>Sets HTTP request components based on the URI.</tt></dd></dl> |
| |
| <dl><dt><a name="GDQuery-__init__"><strong>__init__</strong></a>(self, scheme<font color="#909090">=None</font>, host<font color="#909090">=None</font>, port<font color="#909090">=None</font>, path<font color="#909090">=None</font>, query<font color="#909090">=None</font>)</dt><dd><tt>Constructor for a URI.<br> |
| <br> |
| Args:<br> |
| scheme: str This is usually 'http' or 'https'.<br> |
| host: str The host name or IP address of the desired server.<br> |
| post: int The server's port number.<br> |
| path: str The path of the resource following the host. This begins with<br> |
| a /, example: '/calendar/feeds/default/allcalendars/full'<br> |
| query: dict of strings The URL query parameters. The keys and values are<br> |
| both escaped so this dict should contain the unescaped values.<br> |
| For example {'my key': 'val', 'second': '!!!'} will become<br> |
| '?my+key=val&second=%21%21%21' which is appended to the path.</tt></dd></dl> |
| |
| <dl><dt><a name="GDQuery-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="GDQuery-modify_request"><strong>modify_request</strong></a>(self, http_request<font color="#909090">=None</font>)</dt><dd><tt>Sets HTTP request components based on the URI.</tt></dd></dl> |
| |
| <hr> |
| Static methods inherited from <a href="atom.http_core.html#Uri">atom.http_core.Uri</a>:<br> |
| <dl><dt><a name="GDQuery-ParseUri"><strong>ParseUri</strong></a> = parse_uri(uri_string)</dt><dd><tt>Creates a <a href="atom.http_core.html#Uri">Uri</a> <a href="__builtin__.html#object">object</a> which corresponds to the URI string.<br> |
| <br> |
| This method can accept partial URIs, but it will leave missing<br> |
| members of the <a href="atom.http_core.html#Uri">Uri</a> unset.</tt></dd></dl> |
| |
| <dl><dt><a name="GDQuery-parse_uri"><strong>parse_uri</strong></a>(uri_string)</dt><dd><tt>Creates a <a href="atom.http_core.html#Uri">Uri</a> <a href="__builtin__.html#object">object</a> which corresponds to the URI string.<br> |
| <br> |
| This method can accept partial URIs, but it will leave missing<br> |
| members of the <a href="atom.http_core.html#Uri">Uri</a> unset.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.http_core.html#Uri">atom.http_core.Uri</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> |
| <hr> |
| Data and other attributes inherited from <a href="atom.http_core.html#Uri">atom.http_core.Uri</a>:<br> |
| <dl><dt><strong>host</strong> = None</dl> |
| |
| <dl><dt><strong>path</strong> = None</dl> |
| |
| <dl><dt><strong>port</strong> = None</dl> |
| |
| <dl><dt><strong>scheme</strong> = None</dl> |
| |
| </td></tr></table> <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="MissingOAuthParameters">class <strong>MissingOAuthParameters</strong></a>(<a href="gdata.client.html#Error">Error</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#MissingOAuthParameters">MissingOAuthParameters</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="MissingOAuthParameters-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MissingOAuthParameters-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="MissingOAuthParameters-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingOAuthParameters-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="MissingOAuthParameters-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="NotImplemented">class <strong>NotImplemented</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#NotImplemented">NotImplemented</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="NotImplemented-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#NotImplemented-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="NotImplemented-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="NotImplemented-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="NotImplemented-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NotImplemented-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="NotImplemented-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="NotModified">class <strong>NotModified</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#NotModified">NotModified</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="NotModified-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#NotModified-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="NotModified-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="NotModified-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="NotModified-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NotModified-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="NotModified-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="Query">class <strong>Query</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Query-AddCustomParameter"><strong>AddCustomParameter</strong></a> = <a href="#Query-add_custom_parameter">add_custom_parameter</a>(self, key, value)</dt></dl> |
| |
| <dl><dt><a name="Query-ModifyRequest"><strong>ModifyRequest</strong></a> = <a href="#Query-modify_request">modify_request</a>(self, http_request)</dt></dl> |
| |
| <dl><dt><a name="Query-__init__"><strong>__init__</strong></a>(self, text_query<font color="#909090">=None</font>, categories<font color="#909090">=None</font>, author<font color="#909090">=None</font>, alt<font color="#909090">=None</font>, updated_min<font color="#909090">=None</font>, updated_max<font color="#909090">=None</font>, pretty_print<font color="#909090">=False</font>, published_min<font color="#909090">=None</font>, published_max<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, max_results<font color="#909090">=None</font>, strict<font color="#909090">=False</font>, **custom_parameters)</dt><dd><tt>Constructs a Google Data <a href="#Query">Query</a> to filter feed contents serverside.<br> |
| <br> |
| Args:<br> |
| text_query: Full text search str (optional)<br> |
| categories: list of strings (optional). Each string is a required<br> |
| category. To include an 'or' query, put a | in the string between<br> |
| terms. For example, to find everything in the Fitz category and<br> |
| the Laurie or Jane category (Fitz and (Laurie or Jane)) you would<br> |
| set categories to ['Fitz', 'Laurie|Jane'].<br> |
| author: str (optional) The service returns entries where the author<br> |
| name and/or email address match your query string.<br> |
| alt: str (optional) for the Alternative representation type you'd like<br> |
| the feed in. If you don't specify an alt parameter, the service<br> |
| returns an Atom feed. This is equivalent to alt='atom'.<br> |
| alt='rss' returns an RSS 2.0 result feed.<br> |
| alt='json' returns a JSON representation of the feed.<br> |
| alt='json-in-script' Requests a response that wraps JSON in a script<br> |
| tag.<br> |
| alt='atom-in-script' Requests an Atom response that wraps an XML<br> |
| string in a script tag.<br> |
| alt='rss-in-script' Requests an RSS response that wraps an XML<br> |
| string in a script tag.<br> |
| updated_min: str (optional), <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp format, lower bounds.<br> |
| For example: 2005-08-09T10:57:00-08:00<br> |
| updated_max: str (optional) updated time must be earlier than timestamp.<br> |
| pretty_print: boolean (optional) If True the server's XML response will<br> |
| be indented to make it more human readable. Defaults to False.<br> |
| published_min: str (optional), Similar to updated_min but for published<br> |
| time.<br> |
| published_max: str (optional), Similar to updated_max but for published<br> |
| time.<br> |
| start_index: int or str (optional) 1-based index of the first result to<br> |
| be retrieved. Note that this isn't a general cursoring mechanism.<br> |
| If you first send a query with ?start-index=1&max-results=10 and<br> |
| then send another query with ?start-index=11&max-results=10, the<br> |
| service cannot guarantee that the results are equivalent to<br> |
| ?start-index=1&max-results=20, because insertions and deletions<br> |
| could have taken place in between the two queries.<br> |
| max_results: int or str (optional) Maximum number of results to be<br> |
| retrieved. Each service has a default max (usually 25) which can<br> |
| vary from service to service. There is also a service-specific<br> |
| limit to the max_results you can fetch in a request.<br> |
| strict: boolean (optional) If True, the server will return an error if<br> |
| the server does not recognize any of the parameters in the request<br> |
| URL. Defaults to False.<br> |
| custom_parameters: other query parameters that are not explicitly defined.</tt></dd></dl> |
| |
| <dl><dt><a name="Query-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl> |
| |
| <dl><dt><a name="Query-modify_request"><strong>modify_request</strong></a>(self, http_request)</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> <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="RedirectError">class <strong>RedirectError</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#RedirectError">RedirectError</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="RedirectError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#RedirectError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="RedirectError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="RedirectError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="RedirectError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#RedirectError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="RedirectError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="RequestError">class <strong>RequestError</strong></a>(<a href="gdata.client.html#Error">Error</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="RequestError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#RequestError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="RequestError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="RequestError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="RequestError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="RequestError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="ResumableUploader">class <strong>ResumableUploader</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>Resumable upload helper for the Google Data protocol.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="ResumableUploader-QueryUploadStatus"><strong>QueryUploadStatus</strong></a> = <a href="#ResumableUploader-query_upload_status">query_upload_status</a>(self, uri<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ResumableUploader-UpdateFile"><strong>UpdateFile</strong></a> = <a href="#ResumableUploader-update_file">update_file</a>(self, entry_or_resumable_edit_link, headers<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, update_metadata<font color="#909090">=False</font>, uri_params<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ResumableUploader-UploadChunk"><strong>UploadChunk</strong></a> = <a href="#ResumableUploader-upload_chunk">upload_chunk</a>(self, start_byte, content_bytes)</dt></dl> |
| |
| <dl><dt><a name="ResumableUploader-UploadFile"><strong>UploadFile</strong></a> = <a href="#ResumableUploader-upload_file">upload_file</a>(self, resumable_media_link, entry<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="ResumableUploader-__init__"><strong>__init__</strong></a>(self, client, file_handle, content_type, total_file_size, chunk_size<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>)</dt><dd><tt>Starts a resumable upload to a service that supports the protocol.<br> |
| <br> |
| Args:<br> |
| client: gdata.client.<a href="#GDClient">GDClient</a> A Google Data API service.<br> |
| file_handle: <a href="__builtin__.html#object">object</a> A file-like <a href="__builtin__.html#object">object</a> containing the file to upload.<br> |
| content_type: str The mimetype of the file to upload.<br> |
| total_file_size: int The file's total size in bytes.<br> |
| chunk_size: int The size of each upload chunk. If None, the<br> |
| DEFAULT_CHUNK_SIZE will be used.<br> |
| desired_class: <a href="__builtin__.html#object">object</a> (optional) The type of gdata.data.GDEntry to parse<br> |
| the completed entry as. This should be specific to the API.</tt></dd></dl> |
| |
| <dl><dt><a name="ResumableUploader-query_upload_status"><strong>query_upload_status</strong></a>(self, uri<font color="#909090">=None</font>)</dt><dd><tt>Queries the current status of a resumable upload request.<br> |
| <br> |
| Args:<br> |
| uri: str (optional) A resumable upload uri to query and override the one<br> |
| that is set in this <a href="__builtin__.html#object">object</a>.<br> |
| <br> |
| Returns:<br> |
| An integer representing the file position (byte) to resume the upload from<br> |
| or True if the upload is complete.<br> |
| <br> |
| Raises:<br> |
| <a href="#RequestError">RequestError</a> if anything other than a HTTP 308 is returned<br> |
| when the request raises an exception.</tt></dd></dl> |
| |
| <dl><dt><a name="ResumableUploader-update_file"><strong>update_file</strong></a>(self, entry_or_resumable_edit_link, headers<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, update_metadata<font color="#909090">=False</font>, uri_params<font color="#909090">=None</font>)</dt><dd><tt>Updates the contents of an existing file using the resumable protocol.<br> |
| <br> |
| If you are interested in pausing an upload or controlling the chunking<br> |
| yourself, use the <a href="#ResumableUploader-upload_chunk">upload_chunk</a>() method instead.<br> |
| <br> |
| Args:<br> |
| entry_or_resumable_edit_link: <a href="__builtin__.html#object">object</a> or string A gdata.data.GDEntry for<br> |
| the entry/file to update or the full uri of the link with rel<br> |
| #resumable-edit-media.<br> |
| headers: dict Additional headers to send in the initial request to create<br> |
| the resumable upload request. These headers will override any default<br> |
| headers sent in the request. For example: headers={'Slug': 'MyTitle'}.<br> |
| force boolean (optional) True to force an update and set the If-Match<br> |
| header to '*'. If False and entry_or_resumable_edit_link is a<br> |
| gdata.data.GDEntry <a href="__builtin__.html#object">object</a>, its etag value is used. Otherwise this<br> |
| parameter should be set to True to force the update.<br> |
| auth_token: (optional) An <a href="__builtin__.html#object">object</a> which sets the Authorization HTTP header<br> |
| in its modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.<br> |
| update_metadata: (optional) True to also update the entry's metadata<br> |
| with that in the given GDEntry <a href="__builtin__.html#object">object</a> in entry_or_resumable_edit_link.<br> |
| uri_params: (optional) Dict of additional parameters to attach to the URI.<br> |
| Some non-dict types are valid here, too, like list of tuple pairs.<br> |
| <br> |
| Returns:<br> |
| The final Atom entry created on the server. The entry <a href="__builtin__.html#object">object</a>'s type will<br> |
| be the class specified in self.<strong>desired_class</strong>.<br> |
| <br> |
| Raises:<br> |
| <a href="#RequestError">RequestError</a> if anything other than a HTTP 308 is returned when the<br> |
| request raises an exception.</tt></dd></dl> |
| |
| <dl><dt><a name="ResumableUploader-upload_chunk"><strong>upload_chunk</strong></a>(self, start_byte, content_bytes)</dt><dd><tt>Uploads a byte range (chunk) to the resumable upload server.<br> |
| <br> |
| Args:<br> |
| start_byte: int The byte offset of the total file where the byte range<br> |
| passed in lives.<br> |
| content_bytes: str The file contents of this chunk.<br> |
| <br> |
| Returns:<br> |
| The final Atom entry created on the server. The entry <a href="__builtin__.html#object">object</a>'s type will<br> |
| be the class specified in self.<strong>desired_class</strong>.<br> |
| <br> |
| Raises:<br> |
| <a href="#RequestError">RequestError</a> if the unique upload uri is not set or the<br> |
| server returns something other than an HTTP 308 when the upload is<br> |
| incomplete.</tt></dd></dl> |
| |
| <dl><dt><a name="ResumableUploader-upload_file"><strong>upload_file</strong></a>(self, resumable_media_link, entry<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Uploads an entire file in chunks using the resumable upload protocol.<br> |
| <br> |
| If you are interested in pausing an upload or controlling the chunking<br> |
| yourself, use the <a href="#ResumableUploader-upload_chunk">upload_chunk</a>() method instead.<br> |
| <br> |
| Args:<br> |
| resumable_media_link: str The full URL for the #resumable-create-media for<br> |
| starting a resumable upload request.<br> |
| entry: A (optional) gdata.data.GDEntry containging metadata to create the <br> |
| upload from.<br> |
| headers: dict Additional headers to send in the initial request to create<br> |
| the resumable upload request. These headers will override any default<br> |
| headers sent in the request. For example: headers={'Slug': 'MyTitle'}.<br> |
| auth_token: (optional) An <a href="__builtin__.html#object">object</a> which sets the Authorization HTTP header<br> |
| in its modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.<br> |
| kwargs: (optional) Other args to pass to self.<strong>_init_session</strong>.<br> |
| <br> |
| Returns:<br> |
| The final Atom entry created on the server. The entry <a href="__builtin__.html#object">object</a>'s type will<br> |
| be the class specified in self.<strong>desired_class</strong>.<br> |
| <br> |
| Raises:<br> |
| <a href="#RequestError">RequestError</a> if anything other than a HTTP 308 is returned<br> |
| when the request raises an exception.</tt></dd></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> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>DEFAULT_CHUNK_SIZE</strong> = 5242880</dl> |
| |
| <dl><dt><strong>MIN_CHUNK_SIZE</strong> = 262144</dl> |
| |
| </td></tr></table> <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="UnableToUpgradeToken">class <strong>UnableToUpgradeToken</strong></a>(<a href="gdata.client.html#RequestError">RequestError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#UnableToUpgradeToken">UnableToUpgradeToken</a></dd> |
| <dd><a href="gdata.client.html#RequestError">RequestError</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#RequestError">RequestError</a>:<br> |
| <dl><dt><strong>body</strong> = None</dl> |
| |
| <dl><dt><strong>headers</strong> = None</dl> |
| |
| <dl><dt><strong>reason</strong> = None</dl> |
| |
| <dl><dt><strong>status</strong> = None</dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="UnableToUpgradeToken-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#UnableToUpgradeToken-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="UnableToUpgradeToken-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#UnableToUpgradeToken-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="UnableToUpgradeToken-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <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="Unauthorized">class <strong>Unauthorized</strong></a>(<a href="gdata.client.html#Error">Error</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.client.html#Unauthorized">Unauthorized</a></dd> |
| <dd><a href="gdata.client.html#Error">Error</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data descriptors inherited from <a href="gdata.client.html#Error">Error</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><a name="Unauthorized-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Unauthorized-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="Unauthorized-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Unauthorized-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Unauthorized-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Unauthorized-__str__">__str__</a>() <==> str(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Unauthorized-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </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="-error_from_response"><strong>error_from_response</strong></a>(message, http_response, error_class, response_body<font color="#909090">=None</font>)</dt><dd><tt>Creates a new exception and sets the HTTP information in the error.<br> |
| <br> |
| Args:<br> |
| message: str human readable message to be displayed if the exception is<br> |
| not caught.<br> |
| http_response: The response from the server, contains error information.<br> |
| error_class: The exception to be instantiated and populated with<br> |
| information from the http_response<br> |
| response_body: str (optional) specify if the response has already been read<br> |
| from the http_response <a href="__builtin__.html#object">object</a>.</tt></dd></dl> |
| <dl><dt><a name="-get_xml_version"><strong>get_xml_version</strong></a>(version)</dt><dd><tt>Determines which XML schema to use based on the client API version.<br> |
| <br> |
| Args:<br> |
| version: string which is converted to an int. The version string is in<br> |
| the form 'Major.Minor.x.y.z' and only the major version number<br> |
| is considered. If None is provided assume version 1.</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>__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> |
