Browse files

Deprecated legacy ways of calling cache_page

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
spookylukey committed Jun 8, 2011
1 parent b67ff14 commit bb12a02bd8cd6e33b947b2cfa01292822099bb19
@@ -39,8 +39,16 @@ def cache_page(*args, **kwargs):
cache_alias = kwargs.pop('cache', None)
key_prefix = kwargs.pop('key_prefix', None)
assert not kwargs, "The only keyword arguments are cache and key_prefix"
+ def warn():
+ import warnings
+ warnings.warn('The cache_page decorator must be called like: '
+ 'cache_page(timeout, [cache=cache name], [key_prefix=key prefix]). '
+ 'All other ways are deprecated.',
+ PendingDeprecationWarning)
if len(args) > 1:
assert len(args) == 2, "cache_page accepts at most 2 arguments"
+ warn()
if callable(args[0]):
return decorator_from_middleware_with_args(CacheMiddleware)(cache_timeout=args[1], cache_alias=cache_alias, key_prefix=key_prefix)(args[0])
elif callable(args[1]):
@@ -49,10 +57,13 @@ def cache_page(*args, **kwargs):
assert False, "cache_page must be passed a view function if called with two arguments"
elif len(args) == 1:
if callable(args[0]):
+ warn()
return decorator_from_middleware_with_args(CacheMiddleware)(cache_alias=cache_alias, key_prefix=key_prefix)(args[0])
+ # The One True Way
return decorator_from_middleware_with_args(CacheMiddleware)(cache_timeout=args[0], cache_alias=cache_alias, key_prefix=key_prefix)
+ warn()
return decorator_from_middleware_with_args(CacheMiddleware)(cache_alias=cache_alias, key_prefix=key_prefix)
@@ -207,6 +207,9 @@ their deprecation, as per the :ref:`Django deprecation policy
refactored to use class based views with pluggable backends in 1.4.
The previous implementation will be deprecated.
+ * Legacy ways of calling
+ :func:`~django.views.decorators.cache.cache_page` will be removed.
* 2.0
* ``django.views.defaults.shortcut()``. This function has been moved
to ``django.contrib.contenttypes.views.shortcut()`` as part of the
@@ -8,10 +8,14 @@ up-to-date information for those who are following trunk.
Django 1.4 includes various `new features`_ and some minor `backwards
incompatible changes`_. There are also some features that have been dropped,
-which are detailed in :doc:`our deprecation plan </internals/deprecation>`.
+which are detailed in :doc:`our deprecation plan </internals/deprecation>`, and
+we've `begun the deprecation process for some features`_.
.. _new features: `What's new in Django 1.4`_
.. _backwards incompatible changes: backwards-incompatible-changes-1.4_
+.. _begun the deprecation process for some features: deprecated-features-1.4_
What's new in Django 1.4
@@ -283,4 +287,16 @@ If you using PUT or DELETE methods in AJAX applications, please see the
This was an alias to ``django.template.loader`` since 2005, it has been removed
without emitting a warning due to the length of the deprecation. If your code
-still referenced this please use ``django.template.loader`` instead.
+still referenced this please use ``django.template.loader`` instead.
+.. _deprecated-features-1.4:
+Features deprecated in 1.4
+Old styles of calling ``cache_page`` decorator
+Some legacy ways of calling :func:`~django.views.decorators.cache.cache_page`
+have been deprecated, please see the docs for the correct way to use this
@@ -494,7 +494,7 @@ __ `Controlling cache: Using other headers`_
The per-view cache
-.. function ``django.views.decorators.cache.cache_page``
+.. function:: django.views.decorators.cache.cache_page
A more granular way to use the caching framework is by caching the output of
individual views. ``django.views.decorators.cache`` defines a ``cache_page``
@@ -571,7 +571,7 @@ Here's the same thing, with ``my_view`` wrapped in ``cache_page``::
from django.views.decorators.cache import cache_page
urlpatterns = ('',
- (r'^foo/(\d{1,2})/$', cache_page(my_view, 60 * 15)),
+ (r'^foo/(\d{1,2})/$', cache_page(60 * 15)(my_view)),
If you take this approach, don't forget to import ``cache_page`` within your
@@ -1,8 +1,10 @@
from functools import wraps
+import warnings
from django.contrib.auth.decorators import login_required, permission_required, user_passes_test
from django.contrib.admin.views.decorators import staff_member_required
from django.http import HttpResponse, HttpRequest, HttpResponseNotAllowed
+from django.test.utils import get_warnings_state, restore_warnings_state
from django.utils.decorators import method_decorator
from django.utils.functional import allow_lazy, lazy, memoize
from django.utils.unittest import TestCase
@@ -65,6 +67,14 @@ def _inner(*args, **kwargs):
class DecoratorsTest(TestCase):
+ def setUp(self):
+ self.warning_state = get_warnings_state()
+ warnings.filterwarnings('ignore', category=PendingDeprecationWarning,
+ module='django.views.decorators.cache')
+ def tearDown(self):
+ restore_warnings_state(self.warning_state)
def test_attributes(self):
Tests that django decorators set certain attributes of the wrapped

0 comments on commit bb12a02

Please sign in to comment.