Changeset 5643

Timestamp:

07/10/07 07:33:55 (1 year ago)

Author:

mtredinnick

Message:

Fixed #3760 -- Added the ability to manually set feed- and item-level id
elements in Atom feeds. This is fully backwards compatible. Based on a patch
from spark343@cs.ubc.ca.

Files:

• django/trunk/django/contrib/syndication/feeds.py (modified) (2 diffs)
• django/trunk/django/utils/feedgenerator.py (modified) (3 diffs)
• django/trunk/docs/syndication_feeds.txt (modified) (2 diffs)

django/trunk/django/contrib/syndication/feeds.py

@@ -84 +84 @@
-            categories = self.__get_dynamic_attr('categories', obj),
-            feed_copyright = self.__get_dynamic_attr('feed_copyright', obj),
+            feed_guid = self.__get_dynamic_attr('feed_guid', obj),
-        )
-
@@ -115 +116 @@
-                link = link,
-                description = description_tmp.render(Context({'obj': item, 'site': current_site})),
-link
+self.__get_dynamic_attr('item_guid', item, link)
-                enclosure = enc,
-                pubdate = self.__get_dynamic_attr('item_pubdate', item),

django/trunk/django/utils/feedgenerator.py

@@ -42 +42 @@
-    def __init__(self, title, link, description, language=None, author_email=None,
-            author_name=None, author_link=None, subtitle=None, categories=None,
-
+, feed_guid=None
-        to_unicode = lambda s: force_unicode(s, strings_only=True)
-        if categories:
@@ -58 +58 @@
-            'feed_url': iri_to_uri(feed_url),
-            'feed_copyright': to_unicode(feed_copyright),
+            'id': feed_guid or link,
-        }
-        self.items = []
@@ -214 +215 @@
-        if self.feed['feed_url'] is not None:
-            handler.addQuickElement(u"link", "", {u"rel": u"self", u"href": self.feed['feed_url']})
-link
+id
-        handler.addQuickElement(u"updated", rfc3339_date(self.latest_post_date()).decode('ascii'))
-        if self.feed['author_name'] is not None:

django/trunk/docs/syndication_feeds.txt

@@ -417 +417 @@
-        link = '/foo/bar/' # Hard-coded link.
-
+        # GUID -- One of the following three is optional. The framework looks
+        # for them in this order. This property is only used for Atom feeds
+        # (where it is the feed-level id element). If not provided, the feed
+        # link is used as the id.
+
+        def feed_guid(self, obj):
+            """
+            Takes the object returned by get_object() and returns the globally
+            unique id for the feed as a normal Python string.
+            """
+
+        def feed_guid(self):
+            """
+            Returns the feed's globally unique id as a normal Python string.
+            """
+
+        feed_guid = '/foo/bar/1234' # Hard-coded guid.
+
-        # DESCRIPTION -- One of the following three is required. The framework
-        # looks for them in this order.
@@ -555 +573 @@
-            """
-            Returns the URL for every item in the feed.
+            """
+
+        # ITEM_GUID -- The following method is optional. This property is
+        # only used for Atom feeds (it is the id element for an item in an
+        # Atom feed). If not provided, the item's link is used by default.
+
+        def item_guid(self, obj):
+            """
+            Takes an item, as return by items(), and returns the item's id.
-            """
-