| | |
- atom.core.XmlElement(__builtin__.object)
-
- Cell
- ColCount
- Data
- Field
-
- Column
- Header
- ListRow
- RowCount
- Worksheet
- exceptions.Exception(exceptions.BaseException)
-
- Error
-
- HeaderNotSet
- FieldMissing
- gdata.data.BatchEntry(gdata.data.GDEntry)
-
- CellEntry
- gdata.data.BatchFeed(gdata.data.GDFeed)
-
- CellsFeed
- gdata.data.GDEntry(atom.data.Entry, gdata.data.LinkFinder)
-
- ListEntry
- Record
- Spreadsheet
- Table
- WorksheetEntry
- gdata.data.GDFeed(atom.data.Feed, gdata.data.LinkFinder)
-
- ListsFeed
- RecordsFeed
- SpreadsheetsFeed
- TablesFeed
- WorksheetsFeed
class Cell(atom.core.XmlElement) |
| |
The gs:cell element.
A cell in the worksheet. The <gs:cell> element can appear only as a child
of <atom:entry>.
|
| |
- Method resolution order:
- Cell
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- col = 'col'
- input_value = 'inputValue'
- numeric_value = 'numericValue'
- row = 'row'
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 CellEntry(gdata.data.BatchEntry) |
| |
An Atom entry representing a single cell in a worksheet.
|
| |
- Method resolution order:
- CellEntry
- gdata.data.BatchEntry
- 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:
- cell = <class 'gdata.spreadsheets.data.Cell'>
- The gs:cell element.
A cell in the worksheet. The <gs:cell> element can appear only as a child
of <atom:entry>.
Data and other attributes inherited from gdata.data.BatchEntry:
- batch_id = <class 'gdata.data.BatchId'>
- Identifies a single operation in a batch request.
- batch_operation = <class 'gdata.data.BatchOperation'>
- The CRUD operation which this batch entry represents.
- batch_status = <class 'gdata.data.BatchStatus'>
- The batch:status element present in a batch response entry.
A status element contains the code (HTTP response code) and
reason as elements. In a single request these fields would
be part of the HTTP response, but in a batch request each
Entry operation has a corresponding Entry in the response
feed which includes status information.
See http://code.google.com/apis/gdata/batch.html#Handling_Errors
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 CellsFeed(gdata.data.BatchFeed) |
| |
An Atom feed contains one entry per cell in a worksheet.
The cell feed supports batch operations, you can send multiple cell
operations in one HTTP request.
|
| |
- Method resolution order:
- CellsFeed
- 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
Methods defined here:
- AddSetCell = add_set_cell(self, row, col, input_value)
- add_set_cell(self, row, col, input_value)
- Adds a request to change the contents of a cell to this batch request.
Args:
row: int, The row number for this cell. Numbering starts at 1.
col: int, The column number for this cell. Starts at 1.
input_value: str, The desired formula/content this cell should contain.
Data and other attributes defined here:
- entry = [<class 'gdata.spreadsheets.data.CellEntry'>]
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 ColCount(atom.core.XmlElement) |
| |
The gs:colCount element.
Indicates the number of columns in the worksheet, including columns that
contain only empty cells. The <gs:colCount> element can appear as a child
of <atom:entry> or <atom:feed>
|
| |
- Method resolution order:
- ColCount
- atom.core.XmlElement
- __builtin__.object
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 Column(Field) |
| |
The gs:column element.
|
| |
- Method resolution order:
- Column
- Field
- atom.core.XmlElement
- __builtin__.object
Data and other attributes inherited from Field:
- index = 'index'
- name = 'name'
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 Data(atom.core.XmlElement) |
| |
The gs:data element.
A data region of a table. Contained in an <atom:entry> element.
|
| |
- Method resolution order:
- Data
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- column = [<class 'gdata.spreadsheets.data.Column'>]
- insertion_mode = 'insertionMode'
- num_rows = 'numRows'
- start_row = 'startRow'
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 Field(atom.core.XmlElement) |
| |
The gs:field element.
A field single cell within a record. Contained in an <atom:entry>.
|
| |
- Method resolution order:
- Field
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- index = 'index'
- name = 'name'
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 Header(atom.core.XmlElement) |
| |
The gs:header element.
Indicates which row is the header row. Contained in an <atom:entry>.
|
| |
- Method resolution order:
- Header
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- row = 'row'
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 ListEntry(gdata.data.GDEntry) |
| |
An Atom entry representing a worksheet row in the list feed.
The values for a particular column can be get and set using
x.get_value('columnheader') and x.set_value('columnheader', 'value').
See also the explanation of column names in the ListFeed class.
|
| |
- Method resolution order:
- ListEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- from_dict(self, values)
- Sets values for this row from the dictionary.
Old values which are already in the entry will not be removed unless
they are overwritten with new values from the dict.
- get_value(self, column_name)
- Returns the displayed text for the desired column in this row.
The formula or input which generated the displayed value is not accessible
through the list feed, to see the user's input, use the cells feed.
If a column is not present in this spreadsheet, or there is no value
for a column in this row, this method will return None.
- set_value(self, column_name, value)
- Changes the value of cell in this row under the desired column name.
Warning: if the cell contained a formula, it will be wiped out by setting
the value using the list feed since the list feed only works with
displayed values.
No client side checking is performed on the column_name, you need to
ensure that the column_name is the local tag name in the gsx tag for the
column. For example, the column_name will not contain special characters,
spaces, uppercase letters, etc.
- to_dict(self)
- Converts this row to a mapping of column names to their values.
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 ListRow(atom.core.XmlElement) |
| |
A gsx column value within a row.
The local tag in the _qname is blank and must be set to the column
name. For example, when adding to a ListEntry, do:
col_value = ListRow(text='something')
col_value._qname = col_value._qname % 'mycolumnname'
|
| |
- Method resolution order:
- ListRow
- atom.core.XmlElement
- __builtin__.object
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 ListsFeed(gdata.data.GDFeed) |
| |
An Atom feed in which each entry represents a row in a worksheet.
The first row in the worksheet is used as the column names for the values
in each row. If a header cell is empty, then a unique column ID is used
for the gsx element name.
Spaces in a column name are removed from the name of the corresponding
gsx element.
Caution: The columnNames are case-insensitive. For example, if you see
a <gsx:e-mail> element in a feed, you can't know whether the column
heading in the original worksheet was "e-mail" or "E-Mail".
Note: If two or more columns have the same name, then subsequent columns
of the same name have _n appended to the columnName. For example, if the
first column name is "e-mail", followed by columns named "E-Mail" and
"E-mail", then the columnNames will be gsx:e-mail, gsx:e-mail_2, and
gsx:e-mail_3 respectively.
|
| |
- Method resolution order:
- ListsFeed
- 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.spreadsheets.data.ListEntry'>]
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 Record(gdata.data.GDEntry) |
| |
An Atom entry representing a single record in a table.
Note that the order of items in each record is the same as the order of
columns in the table definition, which may not match the order of
columns in the GUI.
|
| |
- Method resolution order:
- Record
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- ValueForIndex = value_for_index(self, column_index)
- ValueForName = value_for_name(self, name)
- get_record_id(self)
- value_for_index(self, column_index)
- value_for_name(self, name)
Data and other attributes defined here:
- field = [<class 'gdata.spreadsheets.data.Field'>]
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 RecordsFeed(gdata.data.GDFeed) |
| |
An Atom feed containing the individuals records in a table.
|
| |
- Method resolution order:
- RecordsFeed
- 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.spreadsheets.data.Record'>]
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 RowCount(atom.core.XmlElement) |
| |
The gs:rowCount element.
Indicates the number of total rows in the worksheet, including rows that
contain only empty cells. The <gs:rowCount> element can appear as a
child of <atom:entry> or <atom:feed>.
|
| |
- Method resolution order:
- RowCount
- atom.core.XmlElement
- __builtin__.object
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 Spreadsheet(gdata.data.GDEntry) |
| |
An Atom entry which represents a Google Spreadsheet.
|
| |
- Method resolution order:
- Spreadsheet
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- FindWorksheetsFeed = find_worksheets_feed(self)
- GetSpreadsheetKey = get_spreadsheet_key(self)
- find_worksheets_feed(self)
- get_spreadsheet_key(self)
- Extracts the spreadsheet key unique to this spreadsheet.
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 SpreadsheetsFeed(gdata.data.GDFeed) |
| |
An Atom feed listing a user's Google Spreadsheets.
|
| |
- Method resolution order:
- SpreadsheetsFeed
- 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.spreadsheets.data.Spreadsheet'>]
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 Table(gdata.data.GDEntry) |
| |
An Atom entry that represents a subsection of a worksheet.
A table allows you to treat part or all of a worksheet somewhat like a
table in a database that is, as a set of structured data items. Tables
don't exist until you explicitly create them before you can use a table
feed, you have to explicitly define where the table data comes from.
|
| |
- Method resolution order:
- Table
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetTableId = get_table_id(self)
- get_table_id(self)
Data and other attributes defined here:
- data = <class 'gdata.spreadsheets.data.Data'>
- The gs:data element.
A data region of a table. Contained in an <atom:entry> element.
- header = <class 'gdata.spreadsheets.data.Header'>
- The gs:header element.
Indicates which row is the header row. Contained in an <atom:entry>.
- worksheet = <class 'gdata.spreadsheets.data.Worksheet'>
- The gs:worksheet element.
The worksheet where the table lives.Contained in an <atom:entry>.
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 TablesFeed(gdata.data.GDFeed) |
| |
An Atom feed containing the tables defined within a worksheet.
|
| |
- Method resolution order:
- TablesFeed
- 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.spreadsheets.data.Table'>]
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 Worksheet(atom.core.XmlElement) |
| |
The gs:worksheet element.
The worksheet where the table lives.Contained in an <atom:entry>.
|
| |
- Method resolution order:
- Worksheet
- atom.core.XmlElement
- __builtin__.object
Data and other attributes defined here:
- name = 'name'
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 WorksheetEntry(gdata.data.GDEntry) |
| |
An Atom entry representing a single worksheet in a spreadsheet.
|
| |
- Method resolution order:
- WorksheetEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetWorksheetId = get_worksheet_id(self)
- get_worksheet_id(self)
- The worksheet ID identifies this worksheet in its spreadsheet.
Data and other attributes defined here:
- col_count = <class 'gdata.spreadsheets.data.ColCount'>
- The gs:colCount element.
Indicates the number of columns in the worksheet, including columns that
contain only empty cells. The <gs:colCount> element can appear as a child
of <atom:entry> or <atom:feed>
- row_count = <class 'gdata.spreadsheets.data.RowCount'>
- The gs:rowCount element.
Indicates the number of total rows in the worksheet, including rows that
contain only empty cells. The <gs:rowCount> element can appear as a
child of <atom:entry> or <atom:feed>.
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 WorksheetsFeed(gdata.data.GDFeed) |
| |
A feed containing the worksheets in a single spreadsheet.
|
| |
- Method resolution order:
- WorksheetsFeed
- 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.spreadsheets.data.WorksheetEntry'>]
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)
| |