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

# Copyright (C) 2009 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

 
Modules
       
atom

 
Classes
       
atom.core.XmlElement(__builtin__.object)
FeedEntryParent
GEntry
GEntry
GFeed
GFeed
Link

 
class FeedEntryParent(atom.core.XmlElement)
    # TODO: remove this once atom Entry and Feed exist.
 
 
Method resolution order:
FeedEntryParent
atom.core.XmlElement
__builtin__.object

Methods defined here:
find_url(self, rel)

Data and other attributes defined here:
etag = '{http://schemas.google.com/g/2005}etag'
link = [<class 'gdata.data.Link'>]

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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

 
GDEntry = class GEntry(FeedEntryParent)
    # TODO: once atom Entry exists, inherit from that.
 
 
Method resolution order:
GEntry
FeedEntryParent
atom.core.XmlElement
__builtin__.object

Methods defined here:
GetEditUrl = get_edit_url(self)
get_edit_url(self)

Methods inherited from FeedEntryParent:
find_url(self, rel)

Data and other attributes inherited from FeedEntryParent:
etag = '{http://schemas.google.com/g/2005}etag'
link = [<class 'gdata.data.Link'>]

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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

 
GDFeed = class GFeed(FeedEntryParent)
    # TODO: once atom Feed exists, inherit from that.
 
 
Method resolution order:
GFeed
FeedEntryParent
atom.core.XmlElement
__builtin__.object

Methods defined here:
GetNextUrl = get_next_url(self)
get_next_url(self)

Data and other attributes defined here:
entry = [<class 'gdata.data.GEntry'>]

Methods inherited from FeedEntryParent:
find_url(self, rel)

Data and other attributes inherited from FeedEntryParent:
etag = '{http://schemas.google.com/g/2005}etag'
link = [<class 'gdata.data.Link'>]

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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 GEntry(FeedEntryParent)
    # TODO: once atom Entry exists, inherit from that.
 
 
Method resolution order:
GEntry
FeedEntryParent
atom.core.XmlElement
__builtin__.object

Methods defined here:
GetEditUrl = get_edit_url(self)
get_edit_url(self)

Methods inherited from FeedEntryParent:
find_url(self, rel)

Data and other attributes inherited from FeedEntryParent:
etag = '{http://schemas.google.com/g/2005}etag'
link = [<class 'gdata.data.Link'>]

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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 GFeed(FeedEntryParent)
    # TODO: once atom Feed exists, inherit from that.
 
 
Method resolution order:
GFeed
FeedEntryParent
atom.core.XmlElement
__builtin__.object

Methods defined here:
GetNextUrl = get_next_url(self)
get_next_url(self)

Data and other attributes defined here:
entry = [<class 'gdata.data.GEntry'>]

Methods inherited from FeedEntryParent:
find_url(self, rel)

Data and other attributes inherited from FeedEntryParent:
etag = '{http://schemas.google.com/g/2005}etag'
link = [<class 'gdata.data.Link'>]

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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 Link(atom.core.XmlElement)
    # TODO: once atom Link exists, inherit from that.
 
 
Method resolution order:
Link
atom.core.XmlElement
__builtin__.object

Data and other attributes defined here:
href = 'href'
rel = 'rel'

Methods inherited from atom.core.XmlElement:
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)
Converts this object to XML.
__init__(self, text=None, *args, **kwargs)
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)
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

 
Functions
       
EntryFromString = entry_from_string(xml_string, version=1, encoding='UTF-8')
FeedFromString = feed_from_string(xml_string, version=1, encoding='UTF-8')
entry_from_string(xml_string, version=1, encoding='UTF-8')
feed_from_string(xml_string, version=1, encoding='UTF-8')

 
Data
        __author__ = 'j.s@google.com (Jeff Scudder)'

 
Author
        j.s@google.com (Jeff Scudder)