| | |
- __builtin__.object
-
- ItemAttributeContainer
-
- GBaseItem(ItemAttributeContainer, gdata.BatchEntry)
-
- GBaseSnippet
- atom.AtomBase(atom.ExtensionContainer)
-
- Attributes
- Label
- Thumbnail
- Value
- atom.Text(atom.AtomBase)
-
- Attribute
- ImageLink
- ItemAttribute
- ItemType
-
- MetaItemType
- gdata.BatchFeed(gdata.GDataFeed)
-
- GBaseItemFeed
- gdata.GDataEntry(atom.Entry, gdata.LinkFinder)
-
- GBaseAttributeEntry
- GBaseItemTypeEntry
- gdata.GDataFeed(atom.Feed, gdata.LinkFinder)
-
- GBaseAttributesFeed
- GBaseItemTypesFeed
- GBaseLocalesFeed
- GBaseSnippetFeed
class Attribute(atom.Text) |
| |
Metadata about an attribute from the attributes feed
An entry from the attributes feed contains a list of attributes. Each
attribute describes the attribute's type and count of the items which
use the attribute.
|
| |
- Method resolution order:
- Attribute
- atom.Text
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, name=None, attribute_type=None, count=None, value=None, text=None, extension_elements=None, extension_attributes=None)
- Constructor for Attribute metadata element
Args:
name: str (optional) The name of the attribute
attribute_type: str (optional) The type for the attribute. Examples:
test, float, etc.
count: str (optional) The number of times this attribute appears in
the query results.
value: list (optional) The values which are often used for this
attirbute.
text: str (optional) The text contents of the XML for this attribute.
extension_elements: list (optional) A list of ExtensionElement
instances
extension_attributes: dict (optional) A dictionary of attribute value
string pairs
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Attributes(atom.AtomBase) |
| |
A collection of Google Base metadata attributes
|
| |
- Method resolution order:
- Attributes
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, attribute=None, extension_elements=None, extension_attributes=None, text=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class GBaseAttributeEntry(gdata.GDataEntry) |
| |
An Atom Entry from the attributes feed
|
| |
- Method resolution order:
- GBaseAttributeEntry
- gdata.GDataEntry
- atom.Entry
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods defined here:
- __init__(self, author=None, category=None, content=None, contributor=None, atom_id=None, link=None, published=None, rights=None, source=None, summary=None, title=None, updated=None, label=None, attribute=None, control=None, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from gdata.GDataEntry:
- GetMediaURL(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- IsMedia(self)
- Determines whether or not an entry is a GData Media entry.
Data descriptors inherited from gdata.GDataEntry:
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseAttributesFeed(gdata.GDataFeed) |
| |
A feed containing Google Base Attributes
A query sent to the attributes feed will return a feed of
attributes which are present in the items that match the
query.
|
| |
- Method resolution order:
- GBaseAttributesFeed
- gdata.GDataFeed
- atom.Feed
- atom.Source
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from gdata.GDataFeed:
- __init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
- Constructor for Source
Args:
author: list (optional) A list of Author instances which belong to this
class.
category: list (optional) A list of Category instances
contributor: list (optional) A list on Contributor instances
generator: Generator (optional)
icon: Icon (optional)
id: Id (optional) The entry's Id element
link: list (optional) A list of Link instances
logo: Logo (optional)
rights: Rights (optional) The entry's Rights element
subtitle: Subtitle (optional) The entry's subtitle element
title: Title (optional) the entry's title element
updated: Updated (optional) the entry's updated element
entry: list (optional) A list of the Entry instances contained in the
feed.
text: String (optional) The text contents of the element. This is the
contents of the Entry's XML text node.
(Example: <foo>This is the text</foo>)
extension_elements: list (optional) A list of ExtensionElement instances
which are children of this element.
extension_attributes: dict (optional) A dictionary of strings which are
the values for additional XML attributes of this element.
Data descriptors inherited from gdata.GDataFeed:
- generator
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseItem(ItemAttributeContainer, gdata.BatchEntry) |
| |
An Google Base flavor of an Atom Entry.
Google Base items have required attributes, recommended attributes, and user
defined attributes. The required attributes are stored in this class as
members, and other attributes are stored as extension elements. You can
access the recommended and user defined attributes by using
AddItemAttribute, SetItemAttribute, FindItemAttribute, and
RemoveItemAttribute.
The Base Item
|
| |
- Method resolution order:
- GBaseItem
- ItemAttributeContainer
- gdata.BatchEntry
- gdata.GDataEntry
- atom.Entry
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods defined here:
- __init__(self, author=None, category=None, content=None, contributor=None, atom_id=None, link=None, published=None, rights=None, source=None, summary=None, title=None, updated=None, control=None, label=None, item_type=None, item_attributes=None, batch_operation=None, batch_id=None, batch_status=None, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from ItemAttributeContainer:
- AddItemAttribute(self, name, value, value_type=None, access=None)
- Adds a new item attribute tag containing the value.
Creates a new extension element in the GBase namespace to represent a
Google Base item attribute.
Args:
name: str The tag name for the new attribute. This must be a valid xml
tag name. The tag will be placed in the GBase namespace.
value: str Contents for the item attribute
value_type: str (optional) The type of data in the vlaue, Examples: text
float
access: str (optional) Used to hide attributes. The attribute is not
exposed in the snippets feed if access is set to 'private'.
- FindItemAttribute(self, name)
- Get the contents of the first Base item attribute which matches name.
This method is deprecated, please use GetItemAttributes instead.
Args:
name: str The tag of the desired base attribute. For example, calling
this method with name = 'rating' would search for a tag rating
in the GBase namespace in the item attributes.
Returns:
The text contents of the item attribute, or none if the attribute was
not found.
- GetItemAttributes(self, name)
- Returns a list of all item attributes which have the desired name.
Args:
name: str The tag of the desired base attributes. For example, calling
this method with 'rating' would return a list of ItemAttributes
represented by a 'g:rating' tag.
Returns:
A list of matching ItemAttribute objects.
- RemoveItemAttribute(self, name)
- Deletes the first extension element which matches name.
Deletes the first extension element which matches name.
- SetItemAttribute(self, name, value)
- Changes an existing item attribute's value.
Data descriptors inherited from ItemAttributeContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.GDataEntry:
- GetMediaURL(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- IsMedia(self)
- Determines whether or not an entry is a GData Media entry.
Data descriptors inherited from gdata.GDataEntry:
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseItemFeed(gdata.BatchFeed) |
| |
A feed containing Google Base Items
|
| |
- Method resolution order:
- GBaseItemFeed
- gdata.BatchFeed
- gdata.GDataFeed
- atom.Feed
- atom.Source
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from gdata.BatchFeed:
- AddBatchEntry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None)
- Logic for populating members of a BatchEntry and adding to the feed.
If the entry is not a BatchEntry, it is converted to a BatchEntry so
that the batch specific members will be present.
The id_url_string can be used in place of an entry if the batch operation
applies to a URL. For example query and delete operations require just
the URL of an entry, no body is sent in the HTTP request. If an
id_url_string is sent instead of an entry, a BatchEntry is created and
added to the feed.
This method also assigns the desired batch id to the entry so that it
can be referenced in the server's response. If the batch_id_string is
None, this method will assign a batch_id to be the index at which this
entry will be in the feed's entry list.
Args:
entry: BatchEntry, atom.Entry, or another Entry flavor (optional) The
entry which will be sent to the server as part of the batch request.
The item must have a valid atom id so that the server knows which
entry this request references.
id_url_string: str (optional) The URL of the entry to be acted on. You
can find this URL in the text member of the atom id for an entry.
If an entry is not sent, this id will be used to construct a new
BatchEntry which will be added to the request feed.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
operation_string: str (optional) The desired batch operation which will
set the batch_operation.type member of the entry. Options are
'insert', 'update', 'delete', and 'query'
Raises:
MissingRequiredParameters: Raised if neither an id_ url_string nor an
entry are provided in the request.
Returns:
The added entry.
- AddDelete(self, url_string=None, entry=None, batch_id_string=None)
- Adds a delete request to the batch request feed.
This method takes either the url_string which is the atom id of the item
to be deleted, or the entry itself. The atom id of the entry must be
present so that the server knows which entry should be deleted.
Args:
url_string: str (optional) The URL of the entry to be deleted. You can
find this URL in the text member of the atom id for an entry.
entry: BatchEntry (optional) The entry to be deleted.
batch_id_string: str (optional)
Raises:
MissingRequiredParameters: Raised if neither a url_string nor an entry
are provided in the request.
- AddInsert(self, entry, batch_id_string=None)
- Add an insert request to the operations in this batch request feed.
If the entry doesn't yet have an operation or a batch id, these will
be set to the insert operation and a batch_id specified as a parameter.
Args:
entry: BatchEntry The entry which will be sent in the batch feed as an
insert request.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. Note that batch_ids should either always be specified or
never, mixing could potentially result in duplicate batch ids.
- AddQuery(self, url_string=None, entry=None, batch_id_string=None)
- Adds a query request to the batch request feed.
This method takes either the url_string which is the query URL
whose results will be added to the result feed. The query URL will
be encapsulated in a BatchEntry, and you may pass in the BatchEntry
with a query URL instead of sending a url_string.
Args:
url_string: str (optional)
entry: BatchEntry (optional)
batch_id_string: str (optional)
Raises:
MissingRequiredParameters
- AddUpdate(self, entry, batch_id_string=None)
- Add an update request to the list of batch operations in this feed.
Sets the operation type of the entry to insert if it is not already set
and assigns the desired batch id to the entry so that it can be
referenced in the server's response.
Args:
entry: BatchEntry The entry which will be sent to the server as an
update (HTTP PUT) request. The item must have a valid atom id
so that the server knows which entry to replace.
batch_id_string: str (optional) The batch ID to be used to reference
this batch operation in the results feed. If this parameter is None,
the current length of the feed's entry array will be used as a
count. See also comments for AddInsert.
- GetBatchLink(self)
- __init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, interrupted=None, extension_elements=None, extension_attributes=None, text=None)
Data descriptors inherited from gdata.GDataFeed:
- generator
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseItemTypeEntry(gdata.GDataEntry) |
| |
An Atom entry from the item types feed
These entries contain a list of attributes which are stored in one
XML node called attributes. This class simplifies the data structure
by treating attributes as a list of attribute instances.
Note that the item_type for an item type entry is in the Google Base meta
namespace as opposed to item_types encountered in other feeds.
|
| |
- Method resolution order:
- GBaseItemTypeEntry
- gdata.GDataEntry
- atom.Entry
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods defined here:
- __init__(self, author=None, category=None, content=None, contributor=None, atom_id=None, link=None, published=None, rights=None, source=None, summary=None, title=None, updated=None, label=None, item_type=None, control=None, attribute=None, attributes=None, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from gdata.GDataEntry:
- GetMediaURL(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- IsMedia(self)
- Determines whether or not an entry is a GData Media entry.
Data descriptors inherited from gdata.GDataEntry:
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseItemTypesFeed(gdata.GDataFeed) |
| |
A feed from the Google Base item types feed
|
| |
- Method resolution order:
- GBaseItemTypesFeed
- gdata.GDataFeed
- atom.Feed
- atom.Source
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from gdata.GDataFeed:
- __init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
- Constructor for Source
Args:
author: list (optional) A list of Author instances which belong to this
class.
category: list (optional) A list of Category instances
contributor: list (optional) A list on Contributor instances
generator: Generator (optional)
icon: Icon (optional)
id: Id (optional) The entry's Id element
link: list (optional) A list of Link instances
logo: Logo (optional)
rights: Rights (optional) The entry's Rights element
subtitle: Subtitle (optional) The entry's subtitle element
title: Title (optional) the entry's title element
updated: Updated (optional) the entry's updated element
entry: list (optional) A list of the Entry instances contained in the
feed.
text: String (optional) The text contents of the element. This is the
contents of the Entry's XML text node.
(Example: <foo>This is the text</foo>)
extension_elements: list (optional) A list of ExtensionElement instances
which are children of this element.
extension_attributes: dict (optional) A dictionary of strings which are
the values for additional XML attributes of this element.
Data descriptors inherited from gdata.GDataFeed:
- generator
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseLocalesFeed(gdata.GDataFeed) |
| |
The locales feed from Google Base.
This read-only feed defines the permitted locales for Google Base. The
locale value identifies the language, currency, and date formats used in a
feed.
|
| |
- Method resolution order:
- GBaseLocalesFeed
- gdata.GDataFeed
- atom.Feed
- atom.Source
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from gdata.GDataFeed:
- __init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
- Constructor for Source
Args:
author: list (optional) A list of Author instances which belong to this
class.
category: list (optional) A list of Category instances
contributor: list (optional) A list on Contributor instances
generator: Generator (optional)
icon: Icon (optional)
id: Id (optional) The entry's Id element
link: list (optional) A list of Link instances
logo: Logo (optional)
rights: Rights (optional) The entry's Rights element
subtitle: Subtitle (optional) The entry's subtitle element
title: Title (optional) the entry's title element
updated: Updated (optional) the entry's updated element
entry: list (optional) A list of the Entry instances contained in the
feed.
text: String (optional) The text contents of the element. This is the
contents of the Entry's XML text node.
(Example: <foo>This is the text</foo>)
extension_elements: list (optional) A list of ExtensionElement instances
which are children of this element.
extension_attributes: dict (optional) A dictionary of strings which are
the values for additional XML attributes of this element.
Data descriptors inherited from gdata.GDataFeed:
- generator
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseSnippet(GBaseItem) |
| | |
- Method resolution order:
- GBaseSnippet
- GBaseItem
- ItemAttributeContainer
- gdata.BatchEntry
- gdata.GDataEntry
- atom.Entry
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from GBaseItem:
- __init__(self, author=None, category=None, content=None, contributor=None, atom_id=None, link=None, published=None, rights=None, source=None, summary=None, title=None, updated=None, control=None, label=None, item_type=None, item_attributes=None, batch_operation=None, batch_id=None, batch_status=None, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from ItemAttributeContainer:
- AddItemAttribute(self, name, value, value_type=None, access=None)
- Adds a new item attribute tag containing the value.
Creates a new extension element in the GBase namespace to represent a
Google Base item attribute.
Args:
name: str The tag name for the new attribute. This must be a valid xml
tag name. The tag will be placed in the GBase namespace.
value: str Contents for the item attribute
value_type: str (optional) The type of data in the vlaue, Examples: text
float
access: str (optional) Used to hide attributes. The attribute is not
exposed in the snippets feed if access is set to 'private'.
- FindItemAttribute(self, name)
- Get the contents of the first Base item attribute which matches name.
This method is deprecated, please use GetItemAttributes instead.
Args:
name: str The tag of the desired base attribute. For example, calling
this method with name = 'rating' would search for a tag rating
in the GBase namespace in the item attributes.
Returns:
The text contents of the item attribute, or none if the attribute was
not found.
- GetItemAttributes(self, name)
- Returns a list of all item attributes which have the desired name.
Args:
name: str The tag of the desired base attributes. For example, calling
this method with 'rating' would return a list of ItemAttributes
represented by a 'g:rating' tag.
Returns:
A list of matching ItemAttribute objects.
- RemoveItemAttribute(self, name)
- Deletes the first extension element which matches name.
Deletes the first extension element which matches name.
- SetItemAttribute(self, name, value)
- Changes an existing item attribute's value.
Data descriptors inherited from ItemAttributeContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.GDataEntry:
- GetMediaURL(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- IsMedia(self)
- Determines whether or not an entry is a GData Media entry.
Data descriptors inherited from gdata.GDataEntry:
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class GBaseSnippetFeed(gdata.GDataFeed) |
| |
A feed containing Google Base Snippets
|
| |
- Method resolution order:
- GBaseSnippetFeed
- gdata.GDataFeed
- atom.Feed
- atom.Source
- atom.FeedEntryParent
- atom.AtomBase
- atom.ExtensionContainer
- gdata.LinkFinder
- atom.LinkFinder
- __builtin__.object
Methods inherited from gdata.GDataFeed:
- __init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
- Constructor for Source
Args:
author: list (optional) A list of Author instances which belong to this
class.
category: list (optional) A list of Category instances
contributor: list (optional) A list on Contributor instances
generator: Generator (optional)
icon: Icon (optional)
id: Id (optional) The entry's Id element
link: list (optional) A list of Link instances
logo: Logo (optional)
rights: Rights (optional) The entry's Rights element
subtitle: Subtitle (optional) The entry's subtitle element
title: Title (optional) the entry's title element
updated: Updated (optional) the entry's updated element
entry: list (optional) A list of the Entry instances contained in the
feed.
text: String (optional) The text contents of the element. This is the
contents of the Entry's XML text node.
(Example: <foo>This is the text</foo>)
extension_elements: list (optional) A list of ExtensionElement instances
which are children of this element.
extension_attributes: dict (optional) A dictionary of strings which are
the values for additional XML attributes of this element.
Data descriptors inherited from gdata.GDataFeed:
- generator
- id
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from gdata.LinkFinder:
- GetAclLink(self)
- GetEditLink(self)
- GetEditMediaLink(self)
- The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
- GetFeedLink(self)
- GetHtmlLink(self)
- Find the first link with rel of alternate and type of text/html
Returns:
An atom.Link or None if no links matched
- GetNextLink(self)
- GetPostLink(self)
- Get a link containing the POST target URL.
The POST target URL is used to insert new entries.
Returns:
A link object with a rel matching the POST type.
- GetPrevLink(self)
- GetSelfLink(self)
- Find the first link with rel set to 'self'
Returns:
An atom.Link or none if none of the links had rel equal to 'self'
Methods inherited from atom.LinkFinder:
- GetAlternateLink(self)
- GetLicenseLink(self)
|
class ImageLink(atom.Text) |
| |
The Google Base image_link element
|
| |
- Method resolution order:
- ImageLink
- atom.Text
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, thumbnail=None, text=None, extension_elements=None, text_type=None, extension_attributes=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class ItemAttribute(atom.Text) |
| |
An optional or user defined attribute for a GBase item.
Google Base allows items to have custom attribute child nodes. These nodes
have contents and a type attribute which tells Google Base whether the
contents are text, a float value with units, etc. The Atom text class has
the same structure, so this class inherits from Text.
|
| |
- Method resolution order:
- ItemAttribute
- atom.Text
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, name, text_type=None, access=None, text=None, extension_elements=None, extension_attributes=None)
- Constructor for a GBase item attribute
Args:
name: str The name of the attribute. Examples include
price, color, make, model, pages, salary, etc.
text_type: str (optional) The type associated with the text contents
access: str (optional) If the access attribute is set to 'private', the
attribute will not be included in the item's description in the
snippets feed
text: str (optional) The text data in the this element
extension_elements: list (optional) A list of ExtensionElement
instances
extension_attributes: dict (optional) A dictionary of attribute
value string pairs
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class ItemAttributeContainer(__builtin__.object) |
| |
Provides methods for finding Google Base Item attributes.
Google Base item attributes are child nodes in the gbase namespace. Google
Base allows you to define your own item attributes and this class provides
methods to interact with the custom attributes.
|
| |
Methods defined here:
- AddItemAttribute(self, name, value, value_type=None, access=None)
- Adds a new item attribute tag containing the value.
Creates a new extension element in the GBase namespace to represent a
Google Base item attribute.
Args:
name: str The tag name for the new attribute. This must be a valid xml
tag name. The tag will be placed in the GBase namespace.
value: str Contents for the item attribute
value_type: str (optional) The type of data in the vlaue, Examples: text
float
access: str (optional) Used to hide attributes. The attribute is not
exposed in the snippets feed if access is set to 'private'.
- FindItemAttribute(self, name)
- Get the contents of the first Base item attribute which matches name.
This method is deprecated, please use GetItemAttributes instead.
Args:
name: str The tag of the desired base attribute. For example, calling
this method with name = 'rating' would search for a tag rating
in the GBase namespace in the item attributes.
Returns:
The text contents of the item attribute, or none if the attribute was
not found.
- GetItemAttributes(self, name)
- Returns a list of all item attributes which have the desired name.
Args:
name: str The tag of the desired base attributes. For example, calling
this method with 'rating' would return a list of ItemAttributes
represented by a 'g:rating' tag.
Returns:
A list of matching ItemAttribute objects.
- RemoveItemAttribute(self, name)
- Deletes the first extension element which matches name.
Deletes the first extension element which matches name.
- SetItemAttribute(self, name, value)
- Changes an existing item attribute's value.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class ItemType(atom.Text) |
| |
The Google Base item_type element
|
| |
- Method resolution order:
- ItemType
- atom.Text
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, text=None, extension_elements=None, text_type=None, extension_attributes=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Label(atom.AtomBase) |
| |
The Google Base label element
|
| |
- Method resolution order:
- Label
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class MetaItemType(ItemType) |
| |
The Google Base item_type element
|
| |
- Method resolution order:
- MetaItemType
- ItemType
- atom.Text
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods inherited from ItemType:
- __init__(self, text=None, extension_elements=None, text_type=None, extension_attributes=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Thumbnail(atom.AtomBase) |
| |
The Google Base thumbnail element
|
| |
- Method resolution order:
- Thumbnail
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, width=None, height=None, text=None, extension_elements=None, extension_attributes=None)
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Value(atom.AtomBase) |
| |
Metadata about common values for a given attribute
A value is a child of an attribute which comes from the attributes feed.
The value's text is a commonly used value paired with an attribute name
and the value's count tells how often this value appears for the given
attribute in the search results.
|
| |
- Method resolution order:
- Value
- atom.AtomBase
- atom.ExtensionContainer
- __builtin__.object
Methods defined here:
- __init__(self, count=None, text=None, extension_elements=None, extension_attributes=None)
- Constructor for Attribute metadata element
Args:
count: str (optional) The number of times the value in text is given
for the parent attribute.
text: str (optional) The value which appears in the search results.
extension_elements: list (optional) A list of ExtensionElement
instances
extension_attributes: dict (optional) A dictionary of attribute value
string pairs
Methods inherited from atom.AtomBase:
- ToString(self, string_encoding='UTF-8')
- Converts the Atom object to a string containing XML.
- __str__(self)
Methods inherited from atom.ExtensionContainer:
- FindExtensions(self, tag=None, namespace=None)
- Searches extension elements for child nodes with the desired name.
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
Args:
tag: str (optional) The desired tag
namespace: str (optional) The desired namespace
Returns:
A list of elements whose tag and/or namespace match the parameters
values
Data descriptors inherited from atom.ExtensionContainer:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |