gdata.docs
index
/usr/local/svn/gdata-python-client/src/gdata/docs/__init__.py

Contains extensions to Atom objects used with Google Documents.

 
Package Contents
       
client
data
service

 
Classes
       
atom.AtomBase(atom.ExtensionContainer)
FeedLink
ResourceId
Role
Scope
WritersCanInvite
atom.Person(atom.AtomBase)
LastModifiedBy
LastViewed
gdata.GDataEntry(atom.Entry, gdata.LinkFinder)
DocumentListAclEntry
DocumentListEntry
gdata.GDataFeed(atom.Feed, gdata.LinkFinder)
DocumentListAclFeed
DocumentListFeed

 
class DocumentListAclEntry(gdata.GDataEntry)
    A DocList ACL Entry flavor of an Atom Entry
 
 
Method resolution order:
DocumentListAclEntry
gdata.GDataEntry
atom.Entry
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
__init__(self, category=None, atom_id=None, link=None, title=None, updated=None, scope=None, role=None, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from gdata.GDataEntry:
GetMediaURL(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
IsMedia(self)
Determines whether or not an entry is a GData Media entry.

Data descriptors inherited from gdata.GDataEntry:
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class DocumentListAclFeed(gdata.GDataFeed)
    A DocList ACL feed flavor of a Atom feed
 
 
Method resolution order:
DocumentListAclFeed
gdata.GDataFeed
atom.Feed
atom.Source
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods inherited from gdata.GDataFeed:
__init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
Constructor for Source
 
Args:
  author: list (optional) A list of Author instances which belong to this
      class.
  category: list (optional) A list of Category instances
  contributor: list (optional) A list on Contributor instances
  generator: Generator (optional)
  icon: Icon (optional)
  id: Id (optional) The entry's Id element
  link: list (optional) A list of Link instances
  logo: Logo (optional)
  rights: Rights (optional) The entry's Rights element
  subtitle: Subtitle (optional) The entry's subtitle element
  title: Title (optional) the entry's title element
  updated: Updated (optional) the entry's updated element
  entry: list (optional) A list of the Entry instances contained in the
      feed.
  text: String (optional) The text contents of the element. This is the
      contents of the Entry's XML text node.
      (Example: <foo>This is the text</foo>)
  extension_elements: list (optional) A list of ExtensionElement instances
      which are children of this element.
  extension_attributes: dict (optional) A dictionary of strings which are
      the values for additional XML attributes of this element.

Data descriptors inherited from gdata.GDataFeed:
generator
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class DocumentListEntry(gdata.GDataEntry)
    The Google Documents version of an Atom Entry
 
 
Method resolution order:
DocumentListEntry
gdata.GDataEntry
atom.Entry
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
GetAclLink(self)
Extracts the DocListEntry's <gd:feedLink>.
 
Returns:
  A FeedLink object.
GetDocumentType(self)
Extracts the type of document from the DocListEntry.
 
This method returns the type of document the DocListEntry
represents.  Possible values are document, presentation,
spreadsheet, folder, or pdf.
 
Returns:
  A string representing the type of document.
__init__(self, resourceId=None, feedLink=None, lastViewed=None, lastModifiedBy=None, writersCanInvite=None, author=None, category=None, content=None, atom_id=None, link=None, published=None, title=None, updated=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from gdata.GDataEntry:
GetMediaURL(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
IsMedia(self)
Determines whether or not an entry is a GData Media entry.

Data descriptors inherited from gdata.GDataEntry:
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class DocumentListFeed(gdata.GDataFeed)
    A feed containing a list of Google Documents Items
 
 
Method resolution order:
DocumentListFeed
gdata.GDataFeed
atom.Feed
atom.Source
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods inherited from gdata.GDataFeed:
__init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)
Constructor for Source
 
Args:
  author: list (optional) A list of Author instances which belong to this
      class.
  category: list (optional) A list of Category instances
  contributor: list (optional) A list on Contributor instances
  generator: Generator (optional)
  icon: Icon (optional)
  id: Id (optional) The entry's Id element
  link: list (optional) A list of Link instances
  logo: Logo (optional)
  rights: Rights (optional) The entry's Rights element
  subtitle: Subtitle (optional) The entry's subtitle element
  title: Title (optional) the entry's title element
  updated: Updated (optional) the entry's updated element
  entry: list (optional) A list of the Entry instances contained in the
      feed.
  text: String (optional) The text contents of the element. This is the
      contents of the Entry's XML text node.
      (Example: <foo>This is the text</foo>)
  extension_elements: list (optional) A list of ExtensionElement instances
      which are children of this element.
  extension_attributes: dict (optional) A dictionary of strings which are
      the values for additional XML attributes of this element.

Data descriptors inherited from gdata.GDataFeed:
generator
id

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetPrevLink(self)
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class FeedLink(atom.AtomBase)
    The DocList gd:feedLink element
 
 
Method resolution order:
FeedLink
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, href=None, rel=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class LastModifiedBy(atom.Person)
    The DocList gd:lastModifiedBy element
 
 
Method resolution order:
LastModifiedBy
atom.Person
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods inherited from atom.Person:
__init__(self, name=None, email=None, uri=None, extension_elements=None, extension_attributes=None, text=None)
Foundation from which author and contributor are derived.
 
The constructor is provided for illustrative purposes, you should not
need to instantiate a Person.
 
Args:
  name: Name The person's name
  email: Email The person's email address
  uri: Uri The URI of the person's webpage
  extension_elements: list A list of ExtensionElement instances which are
      children of this element.
  extension_attributes: dict A dictionary of strings which are the values
      for additional XML attributes of this element.
  text: String The text contents of the element. This is the contents
      of the Entry's XML text node. (Example: <foo>This is the text</foo>)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class LastViewed(atom.Person)
    The DocList gd:lastViewed element
 
 
Method resolution order:
LastViewed
atom.Person
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods inherited from atom.Person:
__init__(self, name=None, email=None, uri=None, extension_elements=None, extension_attributes=None, text=None)
Foundation from which author and contributor are derived.
 
The constructor is provided for illustrative purposes, you should not
need to instantiate a Person.
 
Args:
  name: Name The person's name
  email: Email The person's email address
  uri: Uri The URI of the person's webpage
  extension_elements: list A list of ExtensionElement instances which are
      children of this element.
  extension_attributes: dict A dictionary of strings which are the values
      for additional XML attributes of this element.
  text: String The text contents of the element. This is the contents
      of the Entry's XML text node. (Example: <foo>This is the text</foo>)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ResourceId(atom.AtomBase)
    The DocList gd:resourceId element
 
 
Method resolution order:
ResourceId
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, value=None, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Role(atom.AtomBase)
    The DocList ACL role element
 
 
Method resolution order:
Role
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, value=None, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class Scope(atom.AtomBase)
    The DocList ACL scope element
 
 
Method resolution order:
Scope
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, value=None, type=None, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class WritersCanInvite(atom.AtomBase)
    The DocList docs:writersCanInvite element
 
 
Method resolution order:
WritersCanInvite
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__init__(*args, **kwargs)
# The deprecated_function wraps the actual call to f.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data descriptors inherited from atom.ExtensionContainer:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
DocumentListAclEntryFromString(xml_string)
Converts an XML string into a DocumentListAclEntry object.
 
Args:
  xml_string: string The XML describing a Document List ACL feed entry.
 
Returns:
  A DocumentListAclEntry object corresponding to the given XML.
DocumentListAclFeedFromString(xml_string)
Converts an XML string into a DocumentListAclFeed object.
 
Args:
  xml_string: string The XML describing a DocumentList feed.
 
Returns:
  A DocumentListFeed object corresponding to the given XML.
DocumentListEntryFromString(xml_string)
Converts an XML string into a DocumentListEntry object.
 
Args:
  xml_string: string The XML describing a Document List feed entry.
 
Returns:
  A DocumentListEntry object corresponding to the given XML.
DocumentListFeedFromString(xml_string)
Converts an XML string into a DocumentListFeed object.
 
Args:
  xml_string: string The XML describing a DocumentList feed.
 
Returns:
  A DocumentListFeed object corresponding to the given XML.

 
Data
        DOCUMENTS_NAMESPACE = 'http://schemas.google.com/docs/2007'
__author__ = 'api.jfisher (Jeff Fisher), api.eric@google.com (Eric Bidelman)'

 
Author
        api.jfisher (Jeff Fisher), api.eric@google.com (Eric Bidelman)