Deprecate Page.cache_key

matthiask · matthiask · commit 885a4bd2195d · 2015-03-10T13:43:27.000+01:00
diff --git a/docs/deprecation.rst b/docs/deprecation.rst
@@ -116,3 +116,7 @@ No deprecations.
 
 * The automatic discovery of subclasses of ``NavigationExtension`` has been
   replaced with an explicit mechanism of defining navigation extensions.
+
+* ``Page.cache_key`` has never been used by FeinCMS itself and will therefore
+  be removed in a future release. Comparable functionality has been available
+  for a long time with ``Page.path_to_cache_key``.
diff --git a/docs/releases/1.11.rst b/docs/releases/1.11.rst
@@ -94,6 +94,10 @@ New deprecations
 * The automatic discovery of subclasses of ``NavigationExtension`` has been
   replaced with an explicit mechanism of defining navigation extensions.
 
+* ``Page.cache_key`` has never been used by FeinCMS itself and will therefore
+  be removed in a future release. Comparable functionality has been available
+  for a long time with ``Page.path_to_cache_key``.
+
 
 Notable features and improvements
 =================================
diff --git a/feincms/module/page/models.py b/feincms/module/page/models.py
@@ -5,6 +5,7 @@
 from __future__ import absolute_import, unicode_literals
 
 import re
+import warnings
 
 from django.core.cache import cache as django_cache
 from django.core.exceptions import PermissionDenied
@@ -347,6 +348,11 @@ def cache_key(self):
         This function is here purely for your convenience. FeinCMS itself
         does not use it in any way.
         """
+        warnings.warn(
+            'Page.cache_key has never been used and has therefore been'
+            ' deprecated and will be removed in a future release. Have a'
+            ' look at Page.path_to_cache_key if you require comparable'
+            ' functionality.', DeprecationWarning, stacklevel=2)
         return '-'.join(str(fn(self)) for fn in self.cache_key_components)
 
     def etag(self, request):
