gdata.spreadsheet.service
index
/usr/local/svn/gdata-python-client-release/src/gdata/spreadsheet/service.py

SpreadsheetsService extends the GDataService to streamline Google
Spreadsheets operations.
 
  GBaseService: Provides methods to query feeds and manipulate items. Extends
                GDataService.
 
  DictionaryToParamList: Function which converts a dictionary into a list of
                         URL arguments (represented as strings). This is a
                         utility function used in CRUD operations.

 
Modules
       
cElementTree
atom
gdata
urllib

 
Classes
       
exceptions.Exception
Error
RequestError
gdata.service.GDataService(atom.service.AtomService)
SpreadsheetsService
gdata.service.Query(__builtin__.dict)
CellQuery
DocumentQuery
ListQuery

 
class CellQuery(gdata.service.Query)
    
Method resolution order:
CellQuery
gdata.service.Query
__builtin__.dict
__builtin__.object

Properties defined here:
max_col
The max-col query parameter
get = _GetMaxColQuery(self)
set = _SetMaxColQuery(self, cell_query)
max_row
The max-row query parameter
get = _GetMaxRowQuery(self)
set = _SetMaxRowQuery(self, cell_query)
min_col
The min-col query parameter
get = _GetMinColQuery(self)
set = _SetMinColQuery(self, cell_query)
min_row
The min-row query parameter
get = _GetMinRowQuery(self)
set = _SetMinRowQuery(self, cell_query)
range
The range query parameter
get = _GetRangeQuery(self)
set = _SetRangeQuery(self, cell_query)
return_empty
The return-empty query parameter
get = _GetReturnEmptyQuery(self)
set = _SetReturnEmptyQuery(self, cell_query)

Methods inherited from gdata.service.Query:
ToUri(self)
__init__(self, feed=None, text_query=None, params=None, categories=None)
Constructor for Query
 
Args:
  feed: str (optional) The path for the feed (Examples: 
      '/base/feeds/snippets' or 'calendar/feeds/jo@gmail.com/private/full'
  text_query: str (optional) The contents of the q query parameter. The
      contents of the text_query are URL escaped upon conversion to a URI.
  params: dict (optional) Parameter value string pairs which become URL
      params when translated to a URI. These parameters are added to the
      query's items (key-value pairs).
  categories: list (optional) List of category strings which should be
      included as query categories. See 
      http://code.google.com/apis/gdata/reference.html#Queries for 
      details. If you want to get results from category A or B (both 
      categories), specify a single list item 'A|B'.
__str__(self)

Properties inherited from gdata.service.Query:
alt
The feed query's alt parameter
get = _GetAlt(self)
set = _SetAlt(self, query)
author
The feed query's author parameter
get = _GetAuthor(self)
set = _SetAuthor(self, query)
max_results
The feed query's max-results parameter
get = _GetMaxResults(self)
set = _SetMaxResults(self, query)
orderby
The feed query's orderby parameter
get = _GetOrderBy(self)
set = _SetOrderBy(self, query)
published_max
The feed query's published-max parameter
get = _GetPublishedMax(self)
set = _SetPublishedMax(self, query)
published_min
The feed query's published-min parameter
get = _GetPublishedMin(self)
set = _SetPublishedMin(self, query)
start_index
The feed query's start-index parameter
get = _GetStartIndex(self)
set = _SetStartIndex(self, query)
text_query
The feed query's q parameter
get = _GetTextQuery(self)
set = _SetTextQuery(self, query)
updated_max
The feed query's updated-max parameter
get = _GetUpdatedMax(self)
set = _SetUpdatedMax(self, query)
updated_min
The feed query's updated-min parameter
get = _GetUpdatedMin(self)
set = _SetUpdatedMin(self, query)

Data and other attributes inherited from gdata.service.Query:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Query' objects>
list of weak references to the object (if defined)

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from E and F: for k in E: D[k] = E[k]
(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values

Data and other attributes inherited from __builtin__.dict:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class DocumentQuery(gdata.service.Query)
    
Method resolution order:
DocumentQuery
gdata.service.Query
__builtin__.dict
__builtin__.object

Properties defined here:
title
The title query parameter
get = _GetTitleQuery(self)
set = _SetTitleQuery(self, document_query)
title_exact
The title-exact query parameter
get = _GetTitleExactQuery(self)
set = _SetTitleExactQuery(self, document_query)

Methods inherited from gdata.service.Query:
ToUri(self)
__init__(self, feed=None, text_query=None, params=None, categories=None)
Constructor for Query
 
Args:
  feed: str (optional) The path for the feed (Examples: 
      '/base/feeds/snippets' or 'calendar/feeds/jo@gmail.com/private/full'
  text_query: str (optional) The contents of the q query parameter. The
      contents of the text_query are URL escaped upon conversion to a URI.
  params: dict (optional) Parameter value string pairs which become URL
      params when translated to a URI. These parameters are added to the
      query's items (key-value pairs).
  categories: list (optional) List of category strings which should be
      included as query categories. See 
      http://code.google.com/apis/gdata/reference.html#Queries for 
      details. If you want to get results from category A or B (both 
      categories), specify a single list item 'A|B'.
__str__(self)

Properties inherited from gdata.service.Query:
alt
The feed query's alt parameter
get = _GetAlt(self)
set = _SetAlt(self, query)
author
The feed query's author parameter
get = _GetAuthor(self)
set = _SetAuthor(self, query)
max_results
The feed query's max-results parameter
get = _GetMaxResults(self)
set = _SetMaxResults(self, query)
orderby
The feed query's orderby parameter
get = _GetOrderBy(self)
set = _SetOrderBy(self, query)
published_max
The feed query's published-max parameter
get = _GetPublishedMax(self)
set = _SetPublishedMax(self, query)
published_min
The feed query's published-min parameter
get = _GetPublishedMin(self)
set = _SetPublishedMin(self, query)
start_index
The feed query's start-index parameter
get = _GetStartIndex(self)
set = _SetStartIndex(self, query)
text_query
The feed query's q parameter
get = _GetTextQuery(self)
set = _SetTextQuery(self, query)
updated_max
The feed query's updated-max parameter
get = _GetUpdatedMax(self)
set = _SetUpdatedMax(self, query)
updated_min
The feed query's updated-min parameter
get = _GetUpdatedMin(self)
set = _SetUpdatedMin(self, query)

Data and other attributes inherited from gdata.service.Query:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Query' objects>
list of weak references to the object (if defined)

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from E and F: for k in E: D[k] = E[k]
(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values

Data and other attributes inherited from __builtin__.dict:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class Error(exceptions.Exception)
    Base class for exceptions in this module.
 
  Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)

 
class ListQuery(gdata.service.Query)
    
Method resolution order:
ListQuery
gdata.service.Query
__builtin__.dict
__builtin__.object

Properties defined here:
orderby
The orderby query parameter
get = _GetOrderByQuery(self)
set = _SetOrderByQuery(self, list_query)
reverse
The reverse query parameter
get = _GetReverseQuery(self)
set = _SetReverseQuery(self, list_query)
sq
The sq query parameter
get = _GetSpreadsheetQuery(self)
set = _SetSpreadsheetQuery(self, list_query)

Methods inherited from gdata.service.Query:
ToUri(self)
__init__(self, feed=None, text_query=None, params=None, categories=None)
Constructor for Query
 
Args:
  feed: str (optional) The path for the feed (Examples: 
      '/base/feeds/snippets' or 'calendar/feeds/jo@gmail.com/private/full'
  text_query: str (optional) The contents of the q query parameter. The
      contents of the text_query are URL escaped upon conversion to a URI.
  params: dict (optional) Parameter value string pairs which become URL
      params when translated to a URI. These parameters are added to the
      query's items (key-value pairs).
  categories: list (optional) List of category strings which should be
      included as query categories. See 
      http://code.google.com/apis/gdata/reference.html#Queries for 
      details. If you want to get results from category A or B (both 
      categories), specify a single list item 'A|B'.
__str__(self)

Properties inherited from gdata.service.Query:
alt
The feed query's alt parameter
get = _GetAlt(self)
set = _SetAlt(self, query)
author
The feed query's author parameter
get = _GetAuthor(self)
set = _SetAuthor(self, query)
max_results
The feed query's max-results parameter
get = _GetMaxResults(self)
set = _SetMaxResults(self, query)
published_max
The feed query's published-max parameter
get = _GetPublishedMax(self)
set = _SetPublishedMax(self, query)
published_min
The feed query's published-min parameter
get = _GetPublishedMin(self)
set = _SetPublishedMin(self, query)
start_index
The feed query's start-index parameter
get = _GetStartIndex(self)
set = _SetStartIndex(self, query)
text_query
The feed query's q parameter
get = _GetTextQuery(self)
set = _SetTextQuery(self, query)
updated_max
The feed query's updated-max parameter
get = _GetUpdatedMax(self)
set = _SetUpdatedMax(self, query)
updated_min
The feed query's updated-min parameter
get = _GetUpdatedMin(self)
set = _SetUpdatedMin(self, query)

Data and other attributes inherited from gdata.service.Query:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Query' objects>
list of weak references to the object (if defined)

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from E and F: for k in E: D[k] = E[k]
(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values

Data and other attributes inherited from __builtin__.dict:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class RequestError(Error)
    
Method resolution order:
RequestError
Error
exceptions.Exception

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)

 
class SpreadsheetsService(gdata.service.GDataService)
    Client for the Google Spreadsheets service.
 
 
Method resolution order:
SpreadsheetsService
gdata.service.GDataService
atom.service.AtomService
__builtin__.object

Methods defined here:
AddWorksheet(self, title, row_count, col_count, key)
Creates a new worksheet in the desired spreadsheet.
 
The new worksheet is appended to the end of the list of worksheets. The
new worksheet will only have the available number of columns and cells 
specified.
 
Args:
  title: str The title which will be displayed in the list of worksheets.
  row_count: int or str The number of rows in the new worksheet.
  col_count: int or str The number of columns in the new worksheet.
  key: str The spreadsheet key to the spreadsheet to which the new 
      worksheet should be added. 
 
Returns:
  A SpreadsheetsWorksheet if the new worksheet was created succesfully.
DeleteRow(self, entry)
Deletes a row, the provided entry
 
Args:
  entry: gdata.spreadsheet.SpreadsheetsList The row to be deleted
 
Returns:
  The delete response
DeleteWorksheet(self, worksheet_entry=None, url=None)
Removes the desired worksheet from the spreadsheet
 
Args:
  worksheet_entry: SpreadsheetWorksheet (optional) The worksheet to
      be deleted. If this is none, then the DELETE reqest is sent to 
      the url specified in the url parameter.
  url: str (optaional) The URL to which the DELETE request should be
      sent. If left as None, the worksheet's edit URL is used.
 
Returns:
  True if the worksheet was deleted successfully.
ExecuteBatch(self, batch_feed, url=None, spreadsheet_key=None, worksheet_id=None, converter=<function SpreadsheetsCellsFeedFromString>)
Sends a batch request feed to the server.
 
The batch request needs to be sent to the batch URL for a particular 
worksheet. You can specify the worksheet by providing the spreadsheet_key
and worksheet_id, or by sending the URL from the cells feed's batch link.
 
Args:
  batch_feed: gdata.spreadsheet.SpreadsheetsCellFeed A feed containing 
      BatchEntry elements which contain the desired CRUD operation and 
      any necessary data to modify a cell.
  url: str (optional) The batch URL for the cells feed to which these 
      changes should be applied. This can be found by calling 
      cells_feed.GetBatchLink().href.
  spreadsheet_key: str (optional) Used to generate the batch request URL
      if the url argument is None. If using the spreadsheet key to 
      generate the URL, the worksheet id is also required.
  worksheet_id: str (optional) Used if the url is not provided, it is 
      oart of the batch feed target URL. This is used with the spreadsheet
      key.
  converter: Function (optional) Function to be executed on the server's
      response. This function should take one string as a parameter. The
      default value is SpreadsheetsCellsFeedFromString which will turn the result
      into a gdata.base.GBaseItem object.
 
Returns:
  A gdata.BatchFeed containing the results.
GetCellsFeed(self, key, wksht_id='default', cell=None, query=None, visibility='private', projection='full')
Gets a cells feed or a specific entry if a cell is defined
Args:
  key: string The spreadsheet key defined in /ccc?key=
  wksht_id: string The id for a specific worksheet entry
  cell: string (optional) The R1C1 address of the cell
  query: DocumentQuery (optional) Query parameters
  
Returns:
  If there is no cell, then a SpreadsheetsCellsFeed.
  If there is a cell, then a SpreadsheetsCell.
GetListFeed(self, key, wksht_id='default', row_id=None, query=None, visibility='private', projection='full')
Gets a list feed or a specific entry if a row_id is defined
Args:
  key: string The spreadsheet key defined in /ccc?key=
  wksht_id: string The id for a specific worksheet entry
  row_id: string (optional) The row_id of a row in the list
  query: DocumentQuery (optional) Query parameters
  
Returns:
  If there is no row_id, then a SpreadsheetsListFeed.
  If there is a row_id, then a SpreadsheetsList.
GetSpreadsheetsFeed(self, key=None, query=None, visibility='private', projection='full')
Gets a spreadsheets feed or a specific entry if a key is defined
Args:
  key: string (optional) The spreadsheet key defined in /ccc?key=
  query: DocumentQuery (optional) Query parameters
  
Returns:
  If there is no key, then a SpreadsheetsSpreadsheetsFeed.
  If there is a key, then a SpreadsheetsSpreadsheet.
GetWorksheetsFeed(self, key, wksht_id=None, query=None, visibility='private', projection='full')
Gets a worksheets feed or a specific entry if a wksht is defined
Args:
  key: string The spreadsheet key defined in /ccc?key=
  wksht_id: string (optional) The id for a specific worksheet entry
  query: DocumentQuery (optional) Query parameters
  
Returns:
  If there is no wksht_id, then a SpreadsheetsWorksheetsFeed.
  If there is a wksht_id, then a SpreadsheetsWorksheet.
InsertRow(self, row_data, key, wksht_id='default')
Inserts a new row with the provided data
 
Args:
  uri: string The post uri of the list feed
  row_data: dict A dictionary of column header to row data
 
Returns:
  The inserted row
UpdateCell(self, row, col, inputValue, key, wksht_id='default')
Updates an existing cell.
 
Args:
  row: int The row the cell to be editted is in
  col: int The column the cell to be editted is in
  inputValue: str the new value of the cell
  key: str The key of the spreadsheet in which this cell resides.
  wksht_id: str The ID of the worksheet which holds this cell.
  
Returns:
  The updated cell entry
UpdateRow(self, entry, new_row_data)
Updates a row with the provided data
 
Args:
  entry: gdata.spreadsheet.SpreadsheetsList The entry to be updated
  new_row_data: dict A dictionary of column header to row data
  
Returns:
  The updated row
UpdateWorksheet(self, worksheet_entry, url=None)
Changes the size and/or title of the desired worksheet.
 
Args:
  worksheet_entry: SpreadsheetWorksheet The new contents of the 
      worksheet. 
  url: str (optional) The URL to which the edited worksheet entry should
      be sent. If the url is None, the edit URL from the worksheet will
      be used.
 
Returns: 
  A SpreadsheetsWorksheet with the new information about the worksheet.
__init__(self, email=None, password=None, source=None, server='spreadsheets.google.com', additional_headers=None)

Methods inherited from gdata.service.GDataService:
ClientLogin(self, username, password, account_type=None, service=None, source=None, captcha_token=None, captcha_response=None)
Convenience method for authenticating using ProgrammaticLogin. 
 
Sets values for email, password, and other optional members.
 
Args:
  username:
  password:
  account_type: string (optional)
  service: string (optional)
  captcha_token: string (optional)
  captcha_response: string (optional)
Delete(self, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4)
Deletes the entry at the given URI.
 
Args:
  uri: string The URI of the entry to be deleted. Example: 
       '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type and
                 Authorization headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
 
Returns:
  True if the entry was deleted.
GenerateAuthSubURL(self, next, scope, secure=False, session=True)
Generate a URL at which the user will login and be redirected back.
 
Users enter their credentials on a Google login page and a token is sent
to the URL specified in next. See documentation for AuthSub login at:
http://code.google.com/apis/accounts/AuthForWebApps.html
 
Args:
  next: string The URL user will be sent to after logging in.
  scope: string The URL of the service to be accessed.
  secure: boolean (optional) Determines whether or not the issued token
          is a secure token.
  session: boolean (optional) Determines whether or not the issued token
           can be upgraded to a session token.
Get(self, uri, extra_headers=None, redirects_remaining=4, encoding='UTF-8', converter=None)
Query the GData API with the given URI
 
The uri is the portion of the URI after the server value 
(ex: www.google.com).
 
To perform a query against Google Base, set the server to 
'base.google.com' and set the uri to '/base/feeds/...', where ... is 
your query. For example, to find snippets for all digital cameras uri 
should be set to: '/base/feeds/snippets?bq=digital+camera'
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to 
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and 
                 Authorization headers.
  redirects_remaining: int (optional) Tracks the number of additional
      redirects this method will allow. If the service object receives
      a redirect and remaining is 0, it will not follow the redirect. 
      This was added to avoid infinite redirect loops.
  encoding: string (optional) The character encoding for the server's
      response. Default is UTF-8
  converter: func (optional) A function which will transform
      the server's results before it is returned. Example: use 
      GDataFeedFromString to parse the server response as if it
      were a GDataFeed.
 
Returns:
  If there is no ResultsTransformer specified in the call, a GDataFeed 
  or GDataEntry depending on which is sent from the server. If the 
  response is niether a feed or entry and there is no ResultsTransformer,
  return a string. If there is a ResultsTransformer, the returned value 
  will be that of the ResultsTransformer function.
GetAuthSubToken(self)
GetClientLoginToken(self)
GetEntry(self, uri, extra_headers=None)
Query the GData API with the given URI and receive an Entry.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataEntry built from the XML in the server's response.
GetFeed(self, uri, extra_headers=None, converter=<function GDataFeedFromString>)
Query the GData API with the given URI and receive a Feed.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataFeed built from the XML in the server's response.
GetMedia(self, uri, extra_headers=None)
Returns a MediaSource containing media and its metadata from the given
URI string.
GetNext(self, feed)
Requests the next 'page' of results in the feed.
 
This method uses the feed's next link to request an additional feed
and uses the class of the feed to convert the results of the GET request.
 
Args:
  feed: atom.Feed or a subclass. The feed should contain a next link and
      the type of the feed will be applied to the results from the 
      server. The new feed which is returned will be of the same class
      as this feed which was passed in.
 
Returns:
  A new feed representing the next set of results in the server's feed.
  The type of this feed will match that of the feed argument.
Post(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert or update  data into a GData service at the given URI.
 
Args:
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri.
  uri: string The location (feed) to which the data should be inserted.
       Example: '/base/feeds/items'.
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the
      server's response. Often this is a function like
      GDataEntryFromString which will parse the body of the server's
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert data into a GData service at the given URI.
 
Args:
  verb: string, either 'POST' or 'PUT'
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri. 
  uri: string The location (feed) to which the data should be inserted. 
       Example: '/base/feeds/items'. 
  extra_headers: dict (optional) HTTP headers which are to be included. 
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
ProgrammaticLogin(self, captcha_token=None, captcha_response=None)
Authenticates the user and sets the GData Auth token.
 
Login retreives a temporary auth token which must be used with all
requests to GData services. The auth token is stored in the GData client
object.
 
Login is also used to respond to a captcha challenge. If the user's login
attempt failed with a CaptchaRequired error, the user can respond by
calling Login with the captcha token and the answer to the challenge.
 
Args:
  captcha_token: string (optional) The identifier for the captcha challenge
                 which was presented to the user.
  captcha_response: string (optional) The user's answer to the captch 
                    challenge.
 
Raises:
  CaptchaRequired if the login service will require a captcha response
  BadAuthentication if the login service rejected the username or password
  Error if the login service responded with a 403 different from the above
Put(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=3, media_source=None, converter=None)
Updates an entry at the given URI.
 
Args:
  data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The 
        XML containing the updated data.
  uri: string A URI indicating entry to which the update will be applied.
       Example: '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the put succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
RevokeAuthSubToken(self)
Revokes an existing AuthSub token.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
SetAuthSubToken(self, token)
SetClientLoginToken(self, token)
UpgradeToSessionToken(self)
Upgrades a single use AuthSub token to a session token.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token

Properties inherited from gdata.service.GDataService:
auth_token
Get or set the token used for authentication.
get = __GetAuthToken(self)
set = __SetAuthSubToken(self, auth_token)
captcha_token
Get the captcha token for a login request.
get = __GetCaptchaToken(self)
captcha_url
Get the captcha URL for a login request.
get = __GetCaptchaURL(self)
source
The source is the name of the application making the request. 
It should be in the form company_id-app_name-app_version
get = __GetSource(self)
# Private methods to create the source property.
set = __SetSource(self, new_source)

Methods inherited from atom.service.AtomService:
PrepareConnection(self, full_uri)
Opens a connection to the server based on the full URI.
 
Examines the target URI and the proxy settings, which are set as 
environment variables, to open a connection with the server. This 
connection is used to make an HTTP request.
 
Args:
  full_uri: str Which is the target relative (lacks protocol and host) or
  absolute URL to be opened. Example:
  'https://www.google.com/accounts/ClientLogin' or
  'base/feeds/snippets' where the server is set to www.google.com.
 
Returns:
  A tuple containing the httplib.HTTPConnection and the full_uri for the
  request.
UseBasicAuth(self, username, password, for_proxy=False)
Sets an Authenticaiton: Basic HTTP header containing plaintext.
 
The username and password are base64 encoded and added to an HTTP header
which will be included in each request. Note that your username and 
password are sent in plaintext.
 
Args:
  username: str
  password: str

Data and other attributes inherited from atom.service.AtomService:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'AtomService' objects>
list of weak references to the object (if defined)
debug = False
port = 80
ssl = False

 
Data
        __author__ = 'api.laurabeth@gmail.com (Laura Beth Lincoln)'

 
Author
        api.laurabeth@gmail.com (Laura Beth Lincoln)