# $SnapHashLicense:
#
# SnapLogic - Open source data services
#
# Copyright (C) 2008, SnapLogic, Inc. All rights reserved.
#
# See http://www.snaplogic.org for more information about
# the SnapLogic project.
#
# This program is free software, distributed under the terms of
# the GNU General Public License Version 2. See the LEGAL file
# at the top of the source tree.
#
# "SnapLogic" is a trademark of SnapLogic, Inc.
#
#
# $
# $Id: RssItem.py 1438 2008-03-10 19:02:16Z dhiraj $
"""
Module for RSS Item object.
This module contains the RssItem object for use in accessing and formating a RSS Item or Atom Entry element.
The RssItem object shields the underlying 3rdparty feedparser entry from the users, so that the user code does
not tightly depend on the 3rdparty package, which may or may not be replaced in the future.
"""
# Imports
import xml.dom.minidom
import RssUtils
from RssElem import RssElem
from RssDocument import RssDocument
from feedparser import FeedParserDict
from snaplogic.common.snap_exceptions import *
class RssItem(RssElem):
"""
This class provides intefaces for the users to access information of a RSS Item or Atom Entry element.
"""
def __init__(self):
"""
Initialization.
"""
RssElem.__init__(self)
self._item = self._elem
# Read only property
theItemDict = property(lambda self: self._item)
def __str__(self):
"""
Print the item contents.
"""
r = RssElem.__str__(self).split('\n')
r[0] = "---- RssItem ----"
r[-1] = "-----------------"
return '\n'.join(r)
def serialize(self, protocol = 'atom10', format = 'xml', encoding = 'utf-8'):
"""
Serialize the item information.
@param doc: The document object containing the DOM. If this parameter is provided, protocol is omitted.
@type doc: xml.dom.minidom.Document
@param protocol: The protocol of the serialized document. The valid values are 'rss20' and 'atom10'.
@type protocol: string
@param format: The document format, valid values are 'xml', 'pretty-xml'.
@type format: string
@param encoding: The encoding scheme, default to 'utf-8'.
@type encoding: string
@return: The serialized string.
@raise SnapValueError: On invalid protocol or format value.
"""
if format != 'xml' and format != 'pretty-xml':
raise SnapValueError("RssItem", "serialize", "format", format)
rssdoc = RssDocument()
xmldoc = rssdoc.createItem(self.theItemDict, protocol)
# Note that empty string of encoding will cause toxml/toprettyxml to raise exception.
# If encoding is not desired, pass None as the value.
if format == 'xml': docstr = xmldoc.toxml(encoding)
else: docstr = xmldoc.toprettyxml(' ', '', encoding)
return docstr
|