@ -37,15 +37,15 @@ def _xmlcharref_encode(unicode_data, encoding):
class RSS : class RSS :
# """ # """
# RSS # RSS
# #
# This class encapsulates the creation of an RSS 2.0 feed # This class encapsulates the creation of an RSS 2.0 feed
# #
# The RSS2.0 spec can be found here: # The RSS2.0 spec can be found here:
# http://blogs.law.harvard.edu/tech/rss # http://blogs.law.harvard.edu/tech/rss
# #
# #
# RSS validator : http://rss.scripting.com # RSS validator : http://rss.scripting.com
# #
# #
@ -56,26 +56,26 @@ class RSS:
# rss.channel.link = "http://channel.com" # rss.channel.link = "http://channel.com"
# rss.channel.title = "my channel title" # rss.channel.title = "my channel title"
# rss.channel.description = "my channel description" # rss.channel.description = "my channel description"
# #
# ns = Namespace( "foobar", "http://foobar.baz" ) # ns = Namespace( "foobar", "http://foobar.baz" )
# rss.channel.namespaces.append( ns ) # rss.channel.namespaces.append( ns )
# #
# item = Item() # item = Item()
# item.link = "http://link.com" # item.link = "http://link.com"
# item.description = "my link description" # item.description = "my link description"
# item.title ="my item title" # item.title ="my item title"
# item.nsItems[ns.name + ":foo"] = "bar" # item.nsItems[ns.name + ":foo"] = "bar"
# rss.channel.items.append( item ) # rss.channel.items.append( item )
# #
# item = Item() # item = Item()
# item.link = "http://link2.com" # item.link = "http://link2.com"
# item.description = "my link2 description" # item.description = "my link2 description"
# item.title ="my item2 title" # item.title ="my item2 title"
# item.nsItems[ns.name +":foo"] = "foo bar baz" # item.nsItems[ns.name +":foo"] = "foo bar baz"
# rss.channel.items.append( item ) # rss.channel.items.append( item )
# #
# print rss.write() # print rss.write()
# #
# output: # output:
# <?xml version="1.0" encoding="UTF-8"?> # <?xml version="1.0" encoding="UTF-8"?>
# <rss version="2.0" xmlns:foobar=http://foobar.baz > # <rss version="2.0" xmlns:foobar=http://foobar.baz >
@ -83,76 +83,76 @@ class RSS:
# <title>my channel title</title> # <title>my channel title</title>
# <link>http://channel.com</link> # <link>http://channel.com</link>
# <description>my channel description</description> # <description>my channel description</description>
# #
# <item><title>my item title</title> # <item><title>my item title</title>
# <link>http://link.com</link> # <link>http://link.com</link>
# <description>my link description</description> # <description>my link description</description>
# <foobar:foo>bar</foobar:foo> # <foobar:foo>bar</foobar:foo>
# </item> # </item>
# #
# <item><title>my item2 title</title> # <item><title>my item2 title</title>
# <link>http://link2.com</link> # <link>http://link2.com</link>
# <description>my link2 description</description> # <description>my link2 description</description>
# <foobar:foo>foo bar baz</foobar:foo> # <foobar:foo>foo bar baz</foobar:foo>
# </item> # </item>
# #
# </channel> # </channel>
# </rss> # </rss>
# #
# author: cmallory /a t/ berserk /dot/ o r g # author: cmallory /a t/ berserk /dot/ o r g
# """ # """
def __init__ ( self ) : def __init__ ( self ) :
self . channel = Channel ( ) self . channel = Channel ( )
self . version = " 2.0 " self . version = " 2.0 "
self . contents = None self . contents = None
# if __name__ == "__main__" : # if __name__ == "__main__" :
# from rsslib import RSS, Item, Namespace # from rsslib import RSS, Item, Namespace
# rss = RSS() # rss = RSS()
# rss.channel.link = "http://channel.com" # rss.channel.link = "http://channel.com"
# rss.channel.title = "my channel title" # rss.channel.title = "my channel title"
# rss.channel.description = "my channel description" # rss.channel.description = "my channel description"
# #
# ns = Namespace( "foobar", "http://foobar.baz" ) # ns = Namespace( "foobar", "http://foobar.baz" )
# rss.addNamespace( ns ) # rss.addNamespace( ns )
# #
# item = Item() # item = Item()
# item.link = "http://link.com" # item.link = "http://link.com"
# item.description = "my link description" # item.description = "my link description"
# item.title ="my item title" # item.title ="my item title"
# #
# item.enclosure.url = "http://enclosure.url.com" # item.enclosure.url = "http://enclosure.url.com"
# item.enclosure.length = 12345 # item.enclosure.length = 12345
# item.enclosure.type = "audio/mpeg" # item.enclosure.type = "audio/mpeg"
# #
# item.nsItems[ns.name + ":foo"] = "bar" # item.nsItems[ns.name + ":foo"] = "bar"
# rss.addItem( item ) # rss.addItem( item )
# #
# item = Item() # item = Item()
# item.link = "http://link2.com" # item.link = "http://link2.com"
# item.description = "my link2 description" # item.description = "my link2 description"
# item.title ="my item2 title" # item.title ="my item2 title"
# item.nsItems[ns.name +":foo"] = "foo bar baz" # item.nsItems[ns.name +":foo"] = "foo bar baz"
# rss.addItem( item ) # rss.addItem( item )
# #
# print rss.write() # print rss.write()
#Write out the rss document #Write out the rss document
def write ( self ) : def write ( self ) :
self . contents = " <?xml version= \" 1.0 \" encoding= \" UTF-8 \" ?> \n " self . contents = " <?xml version= \" 1.0 \" encoding= \" UTF-8 \" ?> \n "
#contents += "<!--\n Last " + cnt + " urls to be shrunk \n-->\n" #contents += "<!--\n Last " + cnt + " urls to be shrunk \n-->\n"
self . contents + = " <rss version= \" " + self . version + " \" " self . contents + = " <rss version= \" " + self . version + " \" "
if ( self . channel is not None and self . channel . namespaces is not None ) : if ( self . channel is not None and self . channel . namespaces is not None ) :
for ns in self . channel . namespaces : for ns in self . channel . namespaces :
self . contents + = " xmlns: " + ns . name + " = \" " + ns . url + " \" " self . contents + = " xmlns: " + ns . name + " = \" " + ns . url + " \" "
self . contents + = " > \n " self . contents + = " > \n "
self . contents + = self . generateChannel ( ) self . contents + = self . generateChannel ( )
self . contents + = " </rss> \n " ; self . contents + = " </rss> \n " ;
return self . contents return self . contents
#Generates everything contained in a <channel> element #Generates everything contained in a <channel> element
def generateChannel ( self ) : def generateChannel ( self ) :
contents = " " contents = " "
@ -161,7 +161,7 @@ class RSS:
contents + = self . optionalWrite ( " title " , self . channel . title ) ; contents + = self . optionalWrite ( " title " , self . channel . title ) ;
contents + = self . optionalWrite ( " link " , self . channel . link ) ; contents + = self . optionalWrite ( " link " , self . channel . link ) ;
contents + = self . optionalWrite ( " description " , self . channel . description ) ; contents + = self . optionalWrite ( " description " , self . channel . description ) ;
contents + = self . optionalWrite ( " language " , self . channel . language ) ; contents + = self . optionalWrite ( " language " , self . channel . language ) ;
contents + = self . optionalWrite ( " copyright " , self . channel . copyright ) ; contents + = self . optionalWrite ( " copyright " , self . channel . copyright ) ;
contents + = self . optionalWrite ( " category " , self . channel . category ) ; contents + = self . optionalWrite ( " category " , self . channel . category ) ;
@ -172,18 +172,18 @@ class RSS:
contents + = self . optionalWrite ( " docs " , self . channel . docs ) ; contents + = self . optionalWrite ( " docs " , self . channel . docs ) ;
contents + = self . optionalWrite ( " cloud " , self . channel . cloud ) ; contents + = self . optionalWrite ( " cloud " , self . channel . cloud ) ;
contents + = self . optionalWrite ( " ttl " , self . channel . ttl ) ; contents + = self . optionalWrite ( " ttl " , self . channel . ttl ) ;
contents + = self . optionalWrite ( " generator " , self . channel . generator ) ; contents + = self . optionalWrite ( " generator " , self . channel . generator ) ;
contents + = self . optionalWrite ( " image " , self . channel . image ) ; contents + = self . optionalWrite ( " image " , self . channel . image ) ;
contents + = self . optionalWrite ( " rating " , self . channel . rating ) ; contents + = self . optionalWrite ( " rating " , self . channel . rating ) ;
contents + = self . optionalWrite ( " textInput " , self . channel . textInput ) ; contents + = self . optionalWrite ( " textInput " , self . channel . textInput ) ;
contents + = self . optionalWrite ( " skipHours " , self . channel . skipHours ) ; contents + = self . optionalWrite ( " skipHours " , self . channel . skipHours ) ;
contents + = self . optionalWrite ( " skipDays " , self . channel . skipDays ) ; contents + = self . optionalWrite ( " skipDays " , self . channel . skipDays ) ;
contents + = " \n " + self . generateItems ( ) + " </channel> \n " contents + = " \n " + self . generateItems ( ) + " </channel> \n "
else : else :
contents = " [Channel not properly initialized. " contents = " [Channel not properly initialized. "
contents + = " A required field is not set.(title/link/description] " contents + = " A required field is not set.(title/link/description] "
return contents return contents
#Generates all items within a channel #Generates all items within a channel
@ -202,17 +202,17 @@ class RSS:
c + = self . optionalWrite ( " comments " , i . comments ) c + = self . optionalWrite ( " comments " , i . comments )
c + = self . optionalWrite ( " guid " , i . guid ) c + = self . optionalWrite ( " guid " , i . guid )
c + = self . optionalWrite ( " source " , i . source ) c + = self . optionalWrite ( " source " , i . source )
if ( i . enclosure . url != " " ) : if ( i . enclosure . url != " " ) :
c + = " <enclosure url= \" " + i . enclosure . url + " \" " c + = " <enclosure url= \" " + i . enclosure . url + " \" "
c + = " length= \" " + str ( i . enclosure . length ) + " \" " c + = " length= \" " + str ( i . enclosure . length ) + " \" "
c + = " type= \" " + i . enclosure . type + " \" /> \n " c + = " type= \" " + i . enclosure . type + " \" /> \n "
for k in i . nsItems . keys ( ) : for k in i . nsItems . keys ( ) :
c + = self . optionalWrite ( k , i . nsItems [ k ] ) c + = self . optionalWrite ( k , i . nsItems [ k ] )
c + = " </item> \n \n " c + = " </item> \n \n "
return c return c
@ -223,8 +223,8 @@ class RSS:
def addItem ( self , item ) : def addItem ( self , item ) :
if ( self . channel is not None ) : if ( self . channel is not None ) :
self . channel . items . append ( item ) self . channel . items . append ( item )
def optionalWrite ( self , key , val ) : def optionalWrite ( self , key , val ) :
if ( val is not None and val != " " ) : if ( val is not None and val != " " ) :
return " < " + key + " > " + encode_for_xml ( xml . sax . saxutils . escape ( val ) ) + " </ " + key + " > \n " return " < " + key + " > " + encode_for_xml ( xml . sax . saxutils . escape ( val ) ) + " </ " + key + " > \n "
@ -238,13 +238,13 @@ class Namespace:
self . url = url self . url = url
self . name = name self . name = name
class Channel : class Channel :
# """ # """
# Channel # Channel
# #
# (http://blogs.law.harvard.edu/tech/rss) # (http://blogs.law.harvard.edu/tech/rss)
# #
# This object represents an RSS channel (as of ver2.0) # This object represents an RSS channel (as of ver2.0)
# """ # """
@ -274,26 +274,26 @@ class Channel:
self . textInput = " " self . textInput = " "
self . skipHours = " " self . skipHours = " "
self . skipDays = " " self . skipDays = " "
self . items = [ ] self . items = [ ]
self . namespaces = [ ] self . namespaces = [ ]
def initialized ( self ) : def initialized ( self ) :
return self . title is not None and self . link is not None and self . description is not None return self . title is not None and self . link is not None and self . description is not None
class Item : class Item :
# """ # """
# Item # Item
# #
# http://blogs.law.harvard.edu/tech/rss#hrelementsOfLtitemgt # http://blogs.law.harvard.edu/tech/rss#hrelementsOfLtitemgt
# #
# A channel may contain any number of <item>s. An item may # A channel may contain any number of <item>s. An item may
# represent a "story" -- much like a story in a newspaper or magazine; # represent a "story" -- much like a story in a newspaper or magazine;
# if so its description is a synopsis of the story, and the link # if so its description is a synopsis of the story, and the link
# points to the full story. An item may also be complete in itself, # points to the full story. An item may also be complete in itself,
# if so, the description contains the text (entity-encoded HTML is # if so, the description contains the text (entity-encoded HTML is
# allowed; see examples), and the link and title may be omitted. # allowed; see examples), and the link and title may be omitted.
# All elements of an item are optional, however at least one of # All elements of an item are optional, however at least one of
# title or description must be present. # title or description must be present.
# """ # """
def __init__ ( self ) : def __init__ ( self ) :
@ -309,32 +309,32 @@ class Item:
self . pubDate = " " self . pubDate = " "
self . source = " " self . source = " "
self . enclosure = Enclosure ( ) self . enclosure = Enclosure ( )
self . nsItems = { } self . nsItems = { }
class Enclosure : class Enclosure :
# """ # """
# Enclosure # Enclosure
# #
# <enclosure> sub-element of <item> # <enclosure> sub-element of <item>
# #
# <enclosure> is an optional sub-element of <item>. # <enclosure> is an optional sub-element of <item>.
# #
# It has three required attributes: # It has three required attributes:
# #
# url: says where the enclosure is located, # url: says where the enclosure is located,
# length: says how big it is in bytes, and # length: says how big it is in bytes, and
# type: says what its type is, a standard MIME type. # type: says what its type is, a standard MIME type.
# #
# The url must be an http url. # The url must be an http url.
# #
# Example: <enclosure url="http://www.scripting.com/mp3s/weatherReportSuite.mp3" length="12216320" type="audio/mpeg" /> # Example: <enclosure url="http://www.scripting.com/mp3s/weatherReportSuite.mp3" length="12216320" type="audio/mpeg" />
# #
# """ # """
def __init__ ( self ) : def __init__ ( self ) :
self . url = " " self . url = " "
self . length = 0 self . length = 0
self . type = " " self . type = " "
shypike
9 years ago