Ticket #10793: paginator_doc.diff

django/contrib/sitemaps/__init__.py

@@ -2 +2 @@
 from django.core import urlresolvers, paginator
 from django.core.exceptions import ImproperlyConfigured
 import urllib
+from datetime import timedelta
+from django.utils.timezone import now
 
 PING_URL = "http://www.google.com/webmasters/tools/ping"
 
@@ -39 +41 @@
     # This limit is defined by Google. See the index documentation at
     # http://sitemaps.org/protocol.php#index.
     limit = 50000
+    counter_delta = timedelta(seconds = 60)
+    reload_delta = timedelta(seconds = 600)
 
     # If protocol is None, the URLs in the sitemap will use the protocol
     # with which the sitemap was requested.
@@ -59 +63 @@
     def location(self, obj):
         return obj.get_absolute_url()
 
+    def _paginator_reload(self, __now):
+        """
+        Determines whether to recreate paginator. Called from _get_paginator,
+        can be overriden in child classes.
+
+        Arguments:
+        __now -- current timestamp
+        """
+        return (
+            # paginator very old or
+            (self.__paginator_validate_timestamp > __now) or
+            # paginator not so new and items count in DB changed
+            (self.__counter_validate_timestamp > __now and self.__counter != len(self.items())))
+
     def _get_paginator(self):
-        if not hasattr(self, "_paginator"):
+        __now = now()
+        if not hasattr(self, "_paginator") or self._paginator_reload(__now):
+            self.__counter_validate_timestamp = __now + self.counter_delta
+            self.__paginator_validate_timestamp = __now + self.reload_delta
+            self.__counter = len(self.items())
             self._paginator = paginator.Paginator(self.items(), self.limit)
         return self._paginator
     paginator = property(_get_paginator)

docs/ref/contrib/sitemaps.txt

@@ -131 +131 @@
 
     A ``Sitemap`` class can define the following methods/attributes:
 
+    .. attribute:: Sitemap.reload_delta
+
+        Timedelta between recreation paginator storing objects from database.
+        Default 600 seconds.
+
+    .. attribute:: Sitemap.counter_delta
+
+        Timedelta between checks whether number of database objects stored
+        in paginator differs from number in database. Difference means
+        paginator recreation. Default 60 seconds.
+
+    .. attribute:: Sitemap._paginator_reload
+
+        Function governing whether to create new paginator replacing existing one.
+        Can be overridden in child classes.
+
     .. attribute:: Sitemap.items
 
         **Required.** A method that returns a list of objects. The framework