Repository URL to install this package:
|
Version:
2.0.18 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package gdata</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>gdata</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/__init__.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/__init__.py</a></font></td></tr></table>
<p><tt>Contains classes representing Google Data elements.<br>
<br>
Extends Atom classes to add Google Data specific elements.</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>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gdata.acl.html"><strong>acl</strong> (package)</a><br>
<a href="gdata.alt.html"><strong>alt</strong> (package)</a><br>
<a href="gdata.analytics.html"><strong>analytics</strong> (package)</a><br>
<a href="gdata.apps.html"><strong>apps</strong> (package)</a><br>
<a href="gdata.apps_property.html">apps_property</a><br>
<a href="gdata.auth.html">auth</a><br>
<a href="gdata.blogger.html"><strong>blogger</strong> (package)</a><br>
<a href="gdata.books.html"><strong>books</strong> (package)</a><br>
<a href="gdata.calendar.html"><strong>calendar</strong> (package)</a><br>
<a href="gdata.calendar_resource.html"><strong>calendar_resource</strong> (package)</a><br>
</td><td width="25%" valign=top><a href="gdata.client.html">client</a><br>
<a href="gdata.codesearch.html"><strong>codesearch</strong> (package)</a><br>
<a href="gdata.contacts.html"><strong>contacts</strong> (package)</a><br>
<a href="gdata.contentforshopping.html"><strong>contentforshopping</strong> (package)</a><br>
<a href="gdata.core.html">core</a><br>
<a href="gdata.data.html">data</a><br>
<a href="gdata.docs.html"><strong>docs</strong> (package)</a><br>
<a href="gdata.dublincore.html"><strong>dublincore</strong> (package)</a><br>
<a href="gdata.exif.html"><strong>exif</strong> (package)</a><br>
<a href="gdata.finance.html"><strong>finance</strong> (package)</a><br>
<a href="gdata.gauth.html">gauth</a><br>
</td><td width="25%" valign=top><a href="gdata.geo.html"><strong>geo</strong> (package)</a><br>
<a href="gdata.health.html"><strong>health</strong> (package)</a><br>
<a href="gdata.marketplace.html"><strong>marketplace</strong> (package)</a><br>
<a href="gdata.media.html"><strong>media</strong> (package)</a><br>
<a href="gdata.notebook.html"><strong>notebook</strong> (package)</a><br>
<a href="gdata.oauth.html"><strong>oauth</strong> (package)</a><br>
<a href="gdata.opensearch.html"><strong>opensearch</strong> (package)</a><br>
<a href="gdata.photos.html"><strong>photos</strong> (package)</a><br>
<a href="gdata.projecthosting.html"><strong>projecthosting</strong> (package)</a><br>
<a href="gdata.sample_util.html">sample_util</a><br>
<a href="gdata.service.html">service</a><br>
</td><td width="25%" valign=top><a href="gdata.sites.html"><strong>sites</strong> (package)</a><br>
<a href="gdata.spreadsheet.html"><strong>spreadsheet</strong> (package)</a><br>
<a href="gdata.spreadsheets.html"><strong>spreadsheets</strong> (package)</a><br>
<a href="gdata.test_config.html">test_config</a><br>
<a href="gdata.test_data.html">test_data</a><br>
<a href="gdata.urlfetch.html">urlfetch</a><br>
<a href="gdata.webmastertools.html"><strong>webmastertools</strong> (package)</a><br>
<a href="gdata.youtube.html"><strong>youtube</strong> (package)</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#MediaSource">MediaSource</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#AtomBase">atom.AtomBase</a>(<a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchId">BatchId</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchInterrupted">BatchInterrupted</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchOperation">BatchOperation</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchStatus">BatchStatus</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#EntryLink">EntryLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#ExtendedProperty">ExtendedProperty</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#FeedLink">FeedLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#ItemsPerPage">ItemsPerPage</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#StartIndex">StartIndex</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#TotalResults">TotalResults</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#Entry">atom.Entry</a>(<a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchEntry">BatchEntry</a>
</font></dt></dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#Feed">atom.Feed</a>(<a href="atom.html#Source">atom.Source</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataFeed">GDataFeed</a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchFeed">BatchFeed</a>
</font></dt></dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#LinkFinder">atom.LinkFinder</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#LinkFinder">LinkFinder</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchEntry">BatchEntry</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataFeed">GDataFeed</a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchFeed">BatchFeed</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</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.html#Error">Error</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#MissingRequiredParameters">MissingRequiredParameters</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="BatchEntry">class <strong>BatchEntry</strong></a>(<a href="gdata.html#GDataEntry">GDataEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An atom:entry for use in batch requests.<br>
<br>
The <a href="#BatchEntry">BatchEntry</a> contains additional members to specify the operation to be<br>
performed on this entry and a batch ID so that the server can reference<br>
individual operations in the response feed. For more information, see:<br>
<a href="http://code.google.com/apis/gdata/batch.html">http://code.google.com/apis/gdata/batch.html</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchEntry">BatchEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchEntry-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, content<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, published<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, source<font color="#909090">=None</font>, summary<font color="#909090">=None</font>, control<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, batch_operation<font color="#909090">=None</font>, batch_id<font color="#909090">=None</font>, batch_status<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#GDataEntry">GDataEntry</a>:<br>
<dl><dt><a name="BatchEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="BatchEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataEntry">GDataEntry</a>:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="BatchEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</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="BatchFeed">class <strong>BatchFeed</strong></a>(<a href="gdata.html#GDataFeed">GDataFeed</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A feed containing a list of batch request entries.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchFeed">BatchFeed</a></dd>
<dd><a href="gdata.html#GDataFeed">GDataFeed</a></dd>
<dd><a href="atom.html#Feed">atom.Feed</a></dd>
<dd><a href="atom.html#Source">atom.Source</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchFeed-AddBatchEntry"><strong>AddBatchEntry</strong></a>(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a <a href="#BatchEntry">BatchEntry</a> and adding to the feed.<br>
<br>
<br>
If the entry is not a <a href="#BatchEntry">BatchEntry</a>, it is converted to a <a href="#BatchEntry">BatchEntry</a> so<br>
that the batch specific members will be present.<br>
<br>
The id_url_string can be used in place of an entry if the batch operation<br>
applies to a URL. For example query and delete operations require just<br>
the URL of an entry, no body is sent in the HTTP request. If an<br>
id_url_string is sent instead of an entry, a <a href="#BatchEntry">BatchEntry</a> is created and<br>
added to the feed.<br>
<br>
This method also assigns the desired batch id to the entry so that it<br>
can be referenced in the server's response. If the batch_id_string is<br>
None, this method will assign a batch_id to be the index at which this<br>
entry will be in the feed's entry list.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a>, atom.<a href="atom.html#Entry">Entry</a>, or another <a href="atom.html#Entry">Entry</a> flavor (optional) The<br>
entry which will be sent to the server as part of the batch request.<br>
The item must have a valid atom id so that the server knows which<br>
entry this request references.<br>
id_url_string: str (optional) The URL of the entry to be acted on. You<br>
can find this URL in the text member of the atom id for an entry.<br>
If an entry is not sent, this id will be used to construct a new<br>
<a href="#BatchEntry">BatchEntry</a> which will be added to the request feed.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.<br>
operation_string: str (optional) The desired batch operation which will<br>
set the batch_operation.type member of the entry. Options are<br>
'insert', 'update', 'delete', and 'query'<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a>: Raised if neither an id_ url_string nor an<br>
entry are provided in the request.<br>
<br>
Returns:<br>
The added entry.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddDelete"><strong>AddDelete</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br>
<br>
This method takes either the url_string which is the atom id of the item<br>
to be deleted, or the entry itself. The atom id of the entry must be<br>
present so that the server knows which entry should be deleted.<br>
<br>
Args:<br>
url_string: str (optional) The URL of the entry to be deleted. You can<br>
find this URL in the text member of the atom id for an entry.<br>
entry: <a href="#BatchEntry">BatchEntry</a> (optional) The entry to be deleted.<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a>: Raised if neither a url_string nor an entry<br>
are provided in the request.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddInsert"><strong>AddInsert</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br>
<br>
If the entry doesn't yet have an operation or a batch id, these will<br>
be set to the insert operation and a batch_id specified as a parameter.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a> The entry which will be sent in the batch feed as an<br>
insert request.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddQuery"><strong>AddQuery</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br>
<br>
This method takes either the url_string which is the query URL<br>
whose results will be added to the result feed. The query URL will<br>
be encapsulated in a <a href="#BatchEntry">BatchEntry</a>, and you may pass in the <a href="#BatchEntry">BatchEntry</a><br>
with a query URL instead of sending a url_string.<br>
<br>
Args:<br>
url_string: str (optional)<br>
entry: <a href="#BatchEntry">BatchEntry</a> (optional)<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a></tt></dd></dl>
<dl><dt><a name="BatchFeed-AddUpdate"><strong>AddUpdate</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br>
<br>
Sets the operation type of the entry to insert if it is not already set<br>
and assigns the desired batch id to the entry so that it can be<br>
referenced in the server's response.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a> The entry which will be sent to the server as an<br>
update (HTTP PUT) request. The item must have a valid atom id<br>
so that the server knows which entry to replace.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. See also comments for AddInsert.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetBatchLink"><strong>GetBatchLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, generator<font color="#909090">=None</font>, icon<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, logo<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, subtitle<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, total_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, items_per_page<font color="#909090">=None</font>, interrupted<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataFeed">GDataFeed</a>:<br>
<dl><dt><strong>generator</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchFeed-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="BatchFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</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="BatchId">class <strong>BatchId</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</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.html#BatchId">BatchId</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchId-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchId-__init__"><strong>__init__</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl>
<dl><dt><a name="BatchId-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchId-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="BatchInterrupted">class <strong>BatchInterrupted</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The batch:interrupted element sent if batch request was interrupted.<br>
<br>
Only appears in a feed if some of the batch entries could not be processed.<br>
See: <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchInterrupted">BatchInterrupted</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchInterrupted-__init__"><strong>__init__</strong></a>(self, reason<font color="#909090">=None</font>, success<font color="#909090">=None</font>, failures<font color="#909090">=None</font>, parsed<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchInterrupted-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchInterrupted-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchInterrupted-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="BatchOperation">class <strong>BatchOperation</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</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.html#BatchOperation">BatchOperation</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchOperation-__init__"><strong>__init__</strong></a>(self, op_type<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchOperation-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchOperation-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchOperation-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="BatchStatus">class <strong>BatchStatus</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The batch:status element present in a batch response entry.<br>
<br>
A status element contains the code (HTTP response code) and<br>
reason as elements. In a single request these fields would<br>
be part of the HTTP response, but in a batch request each<br>
<a href="atom.html#Entry">Entry</a> operation has a corresponding <a href="atom.html#Entry">Entry</a> in the response<br>
feed which includes status information.<br>
<br>
See <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchStatus">BatchStatus</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchStatus-__init__"><strong>__init__</strong></a>(self, code<font color="#909090">=None</font>, reason<font color="#909090">=None</font>, content_type<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchStatus-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchStatus-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchStatus-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="EntryLink">class <strong>EntryLink</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The gd:entryLink element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#EntryLink">EntryLink</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="EntryLink-__init__"><strong>__init__</strong></a>(self, href<font color="#909090">=None</font>, read_only<font color="#909090">=None</font>, rel<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="EntryLink-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="EntryLink-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="EntryLink-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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.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="ExtendedProperty">class <strong>ExtendedProperty</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Google Data extendedProperty element.<br>
<br>
Used to store arbitrary key-value information specific to your<br>
application. The value can either be a text string stored as an XML<br>
attribute (.value), or an XML node (XmlBlob) as a child element.<br>
<br>
This element is used in the Google Calendar data API and the Google<br>
Contacts data API.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#ExtendedProperty">ExtendedProperty</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ExtendedProperty-GetXmlBlobExtensionElement"><strong>GetXmlBlobExtensionElement</strong></a>(self)</dt><dd><tt>Returns the XML blob as an atom.ExtensionElement.<br>
<br>
Returns:<br>
An atom.ExtensionElement representing the blob's XML, or None if no<br>
blob was set.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-GetXmlBlobString"><strong>GetXmlBlobString</strong></a>(self)</dt><dd><tt>Returns the XML blob as a string.<br>
<br>
Returns:<br>
A string containing the blob's XML, or None if no blob was set.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-SetXmlBlob"><strong>SetXmlBlob</strong></a>(self, blob)</dt><dd><tt>Sets the contents of the extendedProperty to XML as a child node.<br>
<br>
Since the extendedProperty is only allowed one child element as an XML<br>
blob, setting the XML blob will erase any preexisting extension elements<br>
in this <a href="__builtin__.html#object">object</a>.<br>
<br>
Args:<br>
blob: str, ElementTree Element or atom.ExtensionElement representing<br>
the XML blob stored in the extendedProperty.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-__init__"><strong>__init__</strong></a>(self, name<font color="#909090">=None</font>, value<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="ExtendedProperty-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="ExtendedProperty-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="FeedLink">class <strong>FeedLink</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The gd:feedLink element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#FeedLink">FeedLink</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FeedLink-__init__"><strong>__init__</strong></a>(self, count_hint<font color="#909090">=None</font>, href<font color="#909090">=None</font>, read_only<font color="#909090">=None</font>, rel<font color="#909090">=None</font>, feed<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="FeedLink-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="FeedLink-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="FeedLink-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="GDataEntry">class <strong>GDataEntry</strong></a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Extends Atom <a href="atom.html#Entry">Entry</a> to provide data processing<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#GDataEntry">GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="GDataEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="GDataEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#Entry">atom.Entry</a>:<br>
<dl><dt><a name="GDataEntry-__init__"><strong>__init__</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="GDataEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="GDataEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="GDataEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="GDataEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="GDataEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="GDataEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="GDataEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="GDataEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</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="GDataFeed">class <strong>GDataFeed</strong></a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A <a href="atom.html#Feed">Feed</a> from a GData service<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#GDataFeed">GDataFeed</a></dd>
<dd><a href="atom.html#Feed">atom.Feed</a></dd>
<dd><a href="atom.html#Source">atom.Source</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="GDataFeed-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, generator<font color="#909090">=None</font>, icon<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, logo<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, subtitle<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, total_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, items_per_page<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt><dd><tt>Constructor for Source<br>
<br>
Args:<br>
author: list (optional) A list of Author instances which belong to this<br>
class.<br>
category: list (optional) A list of Category instances<br>
contributor: list (optional) A list on Contributor instances<br>
generator: Generator (optional)<br>
icon: Icon (optional)<br>
id: Id (optional) The entry's Id element<br>
link: list (optional) A list of Link instances<br>
logo: Logo (optional)<br>
rights: Rights (optional) The entry's Rights element<br>
subtitle: Subtitle (optional) The entry's subtitle element<br>
title: Title (optional) the entry's title element<br>
updated: Updated (optional) the entry's updated element<br>
entry: list (optional) A list of the <a href="atom.html#Entry">Entry</a> instances contained in the<br>
feed.<br>
text: String (optional) The text contents of the element. This is the<br>
contents of the <a href="atom.html#Entry">Entry</a>'s XML text node.<br>
(Example: <foo>This is the text</foo>)<br>
extension_elements: list (optional) A list of ExtensionElement instances<br>
which are children of this element.<br>
extension_attributes: dict (optional) A dictionary of strings which are<br>
the values for additional XML attributes of this element.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>generator</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="GDataFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="GDataFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="GDataFeed-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</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>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="GDataFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="GDataFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="GDataFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="GDataFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="GDataFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</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="ItemsPerPage">class <strong>ItemsPerPage</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The opensearch:itemsPerPage element in GData feed<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#ItemsPerPage">ItemsPerPage</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ItemsPerPage-__init__"><strong>__init__</strong></a>(self, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="ItemsPerPage-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="ItemsPerPage-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="ItemsPerPage-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="LinkFinder">class <strong>LinkFinder</strong></a>(<a href="atom.html#LinkFinder">atom.LinkFinder</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An "interface" providing methods to find link elements<br>
<br>
GData <a href="atom.html#Entry">Entry</a> elements often contain multiple links which differ in the rel<br>
attribute or content type. Often, developers are interested in a specific<br>
type of link so this class provides methods to find specific classes of<br>
links.<br>
<br>
This class is used as a mixin in GData entries.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="LinkFinder-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="LinkFinder-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="LinkFinder-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="LinkFinder-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="LinkFinder-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="LinkFinder-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="MediaSource">class <strong>MediaSource</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>GData Entries can refer to media sources, so this class provides a<br>
place to store references to these objects along with some metadata.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="MediaSource-__init__"><strong>__init__</strong></a>(self, file_handle<font color="#909090">=None</font>, content_type<font color="#909090">=None</font>, content_length<font color="#909090">=None</font>, file_path<font color="#909090">=None</font>, file_name<font color="#909090">=None</font>)</dt><dd><tt>Creates an <a href="__builtin__.html#object">object</a> of type <a href="#MediaSource">MediaSource</a>.<br>
<br>
Args:<br>
file_handle: A file handle pointing to the file to be encapsulated in the<br>
<a href="#MediaSource">MediaSource</a><br>
content_type: string The MIME type of the file. Required if a file_handle<br>
is given.<br>
content_length: int The size of the file. Required if a file_handle is<br>
given.<br>
file_path: string (optional) A full path name to the file. Used in<br>
place of a file_handle.<br>
file_name: string The name of the file without any path information.<br>
Required if a file_handle is given.</tt></dd></dl>
<dl><dt><a name="MediaSource-setFile"><strong>setFile</strong></a>(self, file_name, content_type)</dt><dd><tt>A helper function which can create a file handle from a given filename<br>
and set the content type and length all at once.<br>
<br>
Args:<br>
file_name: string The path and file name to the file containing the media<br>
content_type: string A MIME type representing the type of the media</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>
</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="MissingRequiredParameters">class <strong>MissingRequiredParameters</strong></a>(<a href="gdata.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.html#MissingRequiredParameters">MissingRequiredParameters</a></dd>
<dd><a href="gdata.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.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="MissingRequiredParameters-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__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="#MissingRequiredParameters-__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="MissingRequiredParameters-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="MissingRequiredParameters-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="MissingRequiredParameters-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingRequiredParameters-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="MissingRequiredParameters-__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="StartIndex">class <strong>StartIndex</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The opensearch:startIndex element in GData feed<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#StartIndex">StartIndex</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="StartIndex-__init__"><strong>__init__</strong></a>(self, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="StartIndex-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="StartIndex-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="StartIndex-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <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="TotalResults">class <strong>TotalResults</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>opensearch:<a href="#TotalResults">TotalResults</a> for a GData feed<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#TotalResults">TotalResults</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="TotalResults-__init__"><strong>__init__</strong></a>(self, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="TotalResults-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="TotalResults-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="TotalResults-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#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="-BatchEntryFromString"><strong>BatchEntryFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-BatchFeedFromString"><strong>BatchFeedFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-BatchIdFromString"><strong>BatchIdFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-BatchInterruptedFromString"><strong>BatchInterruptedFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-BatchOperationFromString"><strong>BatchOperationFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-BatchStatusFromString"><strong>BatchStatusFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-EntryLinkFromString"><strong>EntryLinkFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-ExtendedPropertyFromString"><strong>ExtendedPropertyFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-FeedLinkFromString"><strong>FeedLinkFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-GDataEntryFromString"><strong>GDataEntryFromString</strong></a>(xml_string)</dt><dd><tt>Creates a new <a href="#GDataEntry">GDataEntry</a> instance given a string of XML.</tt></dd></dl>
<dl><dt><a name="-GDataFeedFromString"><strong>GDataFeedFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-ItemsPerPageFromString"><strong>ItemsPerPageFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-StartIndexFromString"><strong>StartIndexFromString</strong></a>(xml_string)</dt></dl>
<dl><dt><a name="-TotalResultsFromString"><strong>TotalResultsFromString</strong></a>(xml_string)</dt></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>BATCH_DELETE</strong> = 'delete'<br>
<strong>BATCH_INSERT</strong> = 'insert'<br>
<strong>BATCH_NAMESPACE</strong> = 'http://schemas.google.com/gdata/batch'<br>
<strong>BATCH_QUERY</strong> = 'query'<br>
<strong>BATCH_UPDATE</strong> = 'update'<br>
<strong>GACL_NAMESPACE</strong> = 'http://schemas.google.com/acl/2007'<br>
<strong>GACL_TEMPLATE</strong> = '{http://schemas.google.com/acl/2007}%s'<br>
<strong>GDATA_NAMESPACE</strong> = 'http://schemas.google.com/g/2005'<br>
<strong>GDATA_TEMPLATE</strong> = '{http://schemas.google.com/g/2005}%s'<br>
<strong>OPENSEARCH_NAMESPACE</strong> = 'http://a9.com/-/spec/opensearchrss/1.0/'<br>
<strong>OPENSEARCH_TEMPLATE</strong> = '{http://a9.com/-/spec/opensearchrss/1.0/}%s'<br>
<strong>__author__</strong> = 'j.s@google.com (Jeffrey 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 (Jeffrey Scudder)</td></tr></table>
</body></html>