| | |
- atom.core.XmlElement(__builtin__.object)
-
- Embeddability
- OpenAccess
- Review
- Viewability
- gdata.data.BatchFeed(gdata.data.GDFeed)
-
- CollectionFeed
- VolumeFeed
- gdata.data.GDEntry(atom.data.Entry, gdata.data.LinkFinder)
-
- CollectionEntry
- VolumeEntry
class CollectionEntry(gdata.data.GDEntry) |
| |
Describes an entry in a feed of collections.
|
| |
- Method resolution order:
- CollectionEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods inherited from gdata.data.GDEntry:
- FindMediaLink = find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- GetId = get_id(self)
- IsMedia = is_media(self)
- find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- get_id(self)
- is_media(self)
Data and other attributes inherited from gdata.data.GDEntry:
- etag = '{http://schemas.google.com/g/2005}etag'
Data and other attributes inherited from atom.data.Entry:
- content = <class 'atom.data.Content'>
- The atom:content element.
- control = <class 'atom.data.Control'>
- The app:control element indicating restrictions on publication.
The APP control element may contain a draft element indicating whether or
not this entry should be publicly available.
- published = <class 'atom.data.Published'>
- The atom:published element.
- source = <class 'atom.data.Source'>
- The atom:source element.
- summary = <class 'atom.data.Summary'>
- The atom:summary element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
|
class CollectionFeed(gdata.data.BatchFeed) |
| |
Describes a Book Search collection feed.
|
| |
- Method resolution order:
- CollectionFeed
- gdata.data.BatchFeed
- gdata.data.GDFeed
- atom.data.Feed
- atom.data.Source
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Data and other attributes defined here:
- entry = [<class 'gdata.books.data.CollectionEntry'>]
Methods inherited from gdata.data.BatchFeed:
- AddBatchEntry = add_batch_entry(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.data.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 = add_delete(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 = add_insert(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 = add_query(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 = add_update(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.
- FindBatchLink = find_batch_link(self)
- add_batch_entry(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.data.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.
- add_delete(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.
- add_insert(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.
- add_query(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
- add_update(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.
- find_batch_link(self)
Data and other attributes inherited from gdata.data.BatchFeed:
- interrupted = <class 'gdata.data.BatchInterrupted'>
- The batch:interrupted element sent if batch request was interrupted.
Only appears in a feed if some of the batch entries could not be processed.
See: http://code.google.com/apis/gdata/batch.html#Handling_Errors
Methods inherited from gdata.data.GDFeed:
- GetId = get_id(self)
- get_generator(self)
- get_id(self)
Data and other attributes inherited from gdata.data.GDFeed:
- etag = '{http://schemas.google.com/g/2005}etag'
- items_per_page = <class 'gdata.data.ItemsPerPage'>
- The opensearch:itemsPerPage element in GData feed.
- start_index = <class 'gdata.data.StartIndex'>
- The opensearch:startIndex element in GData feed.
- total_results = <class 'gdata.data.TotalResults'>
- opensearch:TotalResults for a GData feed.
Data and other attributes inherited from atom.data.Source:
- generator = <class 'atom.data.Generator'>
- The atom:generator element.
- icon = <class 'atom.data.Icon'>
- The atom:icon element.
- logo = <class 'atom.data.Logo'>
- The atom:logo element.
- subtitle = <class 'atom.data.Subtitle'>
- The atom:subtitle element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
|
class Embeddability(atom.core.XmlElement) |
| |
Describes an embeddability.
|
| |
- Method resolution order:
- Embeddability
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- value = 'value'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class OpenAccess(atom.core.XmlElement) |
| |
Describes an open access.
|
| |
- Method resolution order:
- OpenAccess
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- value = 'value'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Review(atom.core.XmlElement) |
| |
User-provided review.
|
| |
- Method resolution order:
- Review
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- lang = 'lang'
- type = 'type'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class Viewability(atom.core.XmlElement) |
| |
Describes a viewability.
|
| |
- Method resolution order:
- Viewability
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- value = 'value'
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __init__(self, text=None, *args, **kwargs)
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
|
class VolumeEntry(gdata.data.GDEntry) |
| |
Describes an entry in a feed of Book Search volumes.
|
| |
- Method resolution order:
- VolumeEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Data and other attributes defined here:
- comments = <class 'gdata.data.Comments'>
- The gd:comments element.
Contains a comments feed for the enclosing entry (such as a calendar event).
- creator = [<class 'gdata.dublincore.data.Creator'>]
- date = [<class 'gdata.dublincore.data.Date'>]
- dc_title = [<class 'gdata.dublincore.data.Title'>]
- description = [<class 'gdata.dublincore.data.Description'>]
- embeddability = <class 'gdata.books.data.Embeddability'>
- Describes an embeddability.
- format = [<class 'gdata.dublincore.data.Format'>]
- identifier = [<class 'gdata.dublincore.data.Identifier'>]
- language = [<class 'gdata.dublincore.data.Language'>]
- open_access = <class 'gdata.books.data.OpenAccess'>
- Describes an open access.
- publisher = [<class 'gdata.dublincore.data.Publisher'>]
- rating = <class 'gdata.data.Rating'>
- The gd:rating element.
Represents a numeric rating of the enclosing entity, such as a
comment. Each rating supplies its own scale, although it may be
normalized by a service; for example, some services might convert all
ratings to a scale from 1 to 5.
- review = <class 'gdata.books.data.Review'>
- User-provided review.
- subject = [<class 'gdata.dublincore.data.Subject'>]
- viewability = <class 'gdata.books.data.Viewability'>
- Describes a viewability.
Methods inherited from gdata.data.GDEntry:
- FindMediaLink = find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- GetId = get_id(self)
- IsMedia = is_media(self)
- find_media_link(self)
- Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
- get_id(self)
- is_media(self)
Data and other attributes inherited from gdata.data.GDEntry:
- etag = '{http://schemas.google.com/g/2005}etag'
Data and other attributes inherited from atom.data.Entry:
- content = <class 'atom.data.Content'>
- The atom:content element.
- control = <class 'atom.data.Control'>
- The app:control element indicating restrictions on publication.
The APP control element may contain a draft element indicating whether or
not this entry should be publicly available.
- published = <class 'atom.data.Published'>
- The atom:published element.
- source = <class 'atom.data.Source'>
- The atom:source element.
- summary = <class 'atom.data.Summary'>
- The atom:summary element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
|
class VolumeFeed(gdata.data.BatchFeed) |
| |
Describes a Book Search volume feed.
|
| |
- Method resolution order:
- VolumeFeed
- gdata.data.BatchFeed
- gdata.data.GDFeed
- atom.data.Feed
- atom.data.Source
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Data and other attributes defined here:
- entry = [<class 'gdata.books.data.VolumeEntry'>]
Methods inherited from gdata.data.BatchFeed:
- AddBatchEntry = add_batch_entry(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.data.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 = add_delete(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 = add_insert(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 = add_query(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 = add_update(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.
- FindBatchLink = find_batch_link(self)
- add_batch_entry(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.data.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.
- add_delete(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.
- add_insert(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.
- add_query(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
- add_update(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.
- find_batch_link(self)
Data and other attributes inherited from gdata.data.BatchFeed:
- interrupted = <class 'gdata.data.BatchInterrupted'>
- The batch:interrupted element sent if batch request was interrupted.
Only appears in a feed if some of the batch entries could not be processed.
See: http://code.google.com/apis/gdata/batch.html#Handling_Errors
Methods inherited from gdata.data.GDFeed:
- GetId = get_id(self)
- get_generator(self)
- get_id(self)
Data and other attributes inherited from gdata.data.GDFeed:
- etag = '{http://schemas.google.com/g/2005}etag'
- items_per_page = <class 'gdata.data.ItemsPerPage'>
- The opensearch:itemsPerPage element in GData feed.
- start_index = <class 'gdata.data.StartIndex'>
- The opensearch:startIndex element in GData feed.
- total_results = <class 'gdata.data.TotalResults'>
- opensearch:TotalResults for a GData feed.
Data and other attributes inherited from atom.data.Source:
- generator = <class 'atom.data.Generator'>
- The atom:generator element.
- icon = <class 'atom.data.Icon'>
- The atom:icon element.
- logo = <class 'atom.data.Logo'>
- The atom:logo element.
- subtitle = <class 'atom.data.Subtitle'>
- The atom:subtitle element.
Methods inherited from atom.data.FeedEntryParent:
- __init__(self, atom_id=None, text=None, *args, **kwargs)
Data and other attributes inherited from atom.data.FeedEntryParent:
- author = [<class 'atom.data.Author'>]
- category = [<class 'atom.data.Category'>]
- contributor = [<class 'atom.data.Contributor'>]
- id = <class 'atom.data.Id'>
- The atom:id element.
- link = [<class 'atom.data.Link'>]
- rights = <class 'atom.data.Rights'>
- The atom:rights element.
- title = <class 'atom.data.Title'>
- The atom:title element.
- updated = <class 'atom.data.Updated'>
- The atom:updated element.
Methods inherited from atom.core.XmlElement:
- FindChildren = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- FindExtensions = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- GetAttributes = get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- GetElements = get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- ToString = to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
- __str__(self)
- get_attributes(self, tag=None, namespace=None, version=1)
- Find all attributes which match the tag and namespace.
To find all attributes in this object, call get_attributes with the tag
and namespace both set to None (the default). This method searches
through the object's members and the attributes stored in
_other_attributes which did not fit any of the XML parsing rules for this
class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching attributes.
Returns:
A list of XmlAttribute objects for the matching attributes.
- get_elements(self, tag=None, namespace=None, version=1)
- Find all sub elements which match the tag and namespace.
To find all elements in this object, call get_elements with the tag and
namespace both set to None (the default). This method searches through
the object's members and the elements stored in _other_elements which
did not match any of the XML parsing rules for this class.
Args:
tag: str
namespace: str
version: int Specifies the version of the XML rules to be used when
searching for matching elements.
Returns:
A list of the matching XmlElements.
- to_string(self, version=1, encoding=None, pretty_print=None)
- Converts this object to XML.
Data descriptors inherited from atom.core.XmlElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- attributes
- children
- extension_attributes
- extension_elements
- namespace
- tag
Data and other attributes inherited from atom.core.XmlElement:
- text = None
Methods inherited from gdata.data.LinkFinder:
- FindAclLink = find_acl_link(self)
- FindFeedLink = find_feed_link(self)
- FindHtmlLink = find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- FindPostLink = find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- FindPreviousLink = find_previous_link(self)
- GetAclLink = get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- GetFeedLink = get_feed_link(self)
- GetHtmlLink = get_html_link(self)
- GetPostLink = get_post_link(self)
- GetPreviousLink = get_previous_link(self)
- find_acl_link(self)
- find_feed_link(self)
- find_html_link(self)
- Finds the first link with rel of alternate and type of text/html.
- find_post_link(self)
- Get the URL to which new entries should be POSTed.
The POST target URL is used to insert new entries.
Returns:
A str for the URL in the link with a rel matching the POST type.
- find_previous_link(self)
- get_acl_link(self)
- Searches for a link or feed_link (if present) with the rel for ACL.
- get_feed_link(self)
- get_html_link(self)
- get_post_link(self)
- get_previous_link(self)
Methods inherited from atom.data.LinkFinder:
- FindAlternateLink = find_alternate_link(self)
- FindEditLink = find_edit_link(self)
- FindEditMediaLink = find_edit_media_link(self)
- FindLicenseLink = find_license_link(self)
- FindNextLink = find_next_link(self)
- FindSelfLink = find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- FindUrl = find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- GetAlternateLink = get_alternate_link(self)
- GetEditLink = get_edit_link(self)
- GetEditMediaLink = get_edit_media_link(self)
- GetLicenseLink = get_license_link(self)
- GetLink = get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- GetNextLink = get_next_link(self)
- GetSelfLink = get_self_link(self)
- find_alternate_link(self)
- find_edit_link(self)
- find_edit_media_link(self)
- find_license_link(self)
- find_next_link(self)
- find_self_link(self)
- Find the first link with rel set to 'self'
Returns:
A str containing the link's href or None if none of the links had rel
equal to 'self'
- find_url(self, rel)
- Returns the URL (as a string) in a link with the desired rel value.
- get_alternate_link(self)
- get_edit_link(self)
- get_edit_media_link(self)
- get_license_link(self)
- get_link(self, rel)
- Returns a link object which has the desired rel value.
If you are interested in the URL instead of the link object,
consider using find_url instead.
- get_next_link(self)
- get_self_link(self)
| |