Thelie/python-feedgen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add Permalink Attribute To RSS GUID

Browse source 
The `isPermalink` attribute can now be set using the `guid()` function
for entries. Note that this only effects RSS feeds. This patch does not
change Atom feeds in any way.

This fixes #60
This commit is contained in:
Lars Kiesow 2017-10-14 19:24:16 +02:00
parent 4a0a2663e9
commit 281765fefd
No known key found for this signature in database
GPG key ID: 5DAFE8D9C823CE73
2 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
feedgen/entry.py
View file

@ -48,7 +48,7 @@ class FeedEntry(object):
self.__rss_description = None self.__rss_description = None
self.__rss_content = None self.__rss_content = None
self.__rss_enclosure = None self.__rss_enclosure = None
self.__rss_guid = None self.__rss_guid = {}
self.__rss_link = None self.__rss_link = None
self.__rss_pubDate = None self.__rss_pubDate = None
self.__rss_source = None self.__rss_source = None
@ -207,10 +207,11 @@ class FeedEntry(object):
for a in self.__rss_author or []: for a in self.__rss_author or []:
author = etree.SubElement(entry, 'author') author = etree.SubElement(entry, 'author')
author.text = a author.text = a
if self.__rss_guid: if self.__rss_guid.get('guid'):
guid = etree.SubElement(entry, 'guid') guid = etree.SubElement(entry, 'guid')
guid.text = self.__rss_guid guid.text = self.__rss_guid['guid']
guid.attrib['isPermaLink'] = 'false' permaLink = str(self.__rss_guid.get('permalink', False)).lower()
guid.attrib['isPermaLink'] = permaLink
for cat in self.__rss_category or []: for cat in self.__rss_category or []:
category = etree.SubElement(entry, 'category') category = etree.SubElement(entry, 'category')
category.text = cat['value'] category.text = cat['value']
@ -252,25 +253,29 @@ class FeedEntry(object):
'''Get or set the entry id which identifies the entry using a '''Get or set the entry id which identifies the entry using a
universally unique and permanent URI. Two entries in a feed can have universally unique and permanent URI. Two entries in a feed can have
the same value for id if they represent the same entry at different the same value for id if they represent the same entry at different
points in time. This method will also set rss:guid. Id is mandatory points in time. This method will also set rss:guid with permalink set
for an ATOM entry. to False. Id is mandatory for an ATOM entry.
:param id: New Id of the entry. :param id: New Id of the entry.
:returns: Id of the entry. :returns: Id of the entry.
''' '''
if id is not None: if id is not None:
self.__atom_id = id self.__atom_id = id
self.__rss_guid = id self.__rss_guid = {'guid': id, 'permalink': False}
return self.__atom_id return self.__atom_id
def guid(self, guid=None): def guid(self, guid=None, permalink=False):
'''Get or set the entries guid which is a string that uniquely '''Get or set the entries guid which is a string that uniquely
identifies the item. This will also set atom:id. identifies the item. This will also set atom:id.
:param guid: Id of the entry. :param guid: Id of the entry.
:returns: Id of the entry. :param permalink: If this is a permanent identifier for this item
:returns: Id and permalink setting of the entry.
''' '''
return self.id(guid) if guid is not None:
self.__atom_id = guid
self.__rss_guid = {'guid': guid, 'permalink': permalink}
return self.__rss_guid
def updated(self, updated=None): def updated(self, updated=None):
'''Set or get the updated value which indicates the last time the entry '''Set or get the updated value which indicates the last time the entry

2
tests/test_entry.py
View file

@ -75,7 +75,7 @@ class TestSequenceFunctions(unittest.TestCase):
assert link.get('href') == 'http://lkiesow.de' assert link.get('href') == 'http://lkiesow.de'
assert link.get('rel') == 'alternate' assert link.get('rel') == 'alternate'
fe.guid('123') fe.guid('123')
assert fe.guid() == '123' assert fe.guid().get('guid') == '123'
fe.updated('2017-02-05 13:26:58+01:00') fe.updated('2017-02-05 13:26:58+01:00')
assert fe.updated().year == 2017 assert fe.updated().year == 2017
fe.summary('asdf') fe.summary('asdf')