From 6b8c8d7e18bf46def3d6c9be3f9b77f52c5d85b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=BCttler?= Date: Wed, 11 Feb 2015 16:00:12 +0100 Subject: [PATCH] [1.8.x] Clarified timeout=0 in cache docs. Backport of e519ee1d352e0e36fcb8edc9d33ec2845f663d3a from master --- docs/topics/cache.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index d62b9519ee..a9e7f2585e 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -366,14 +366,14 @@ Each cache backend can be given additional arguments to control caching behavior. These arguments are provided as additional keys in the :setting:`CACHES` setting. Valid arguments are as follows: - * :setting:`TIMEOUT `: The default timeout, in seconds, to use for the cache. This argument defaults to ``300`` seconds (5 minutes). .. versionadded:: 1.7 You can set ``TIMEOUT`` to ``None`` so that, by default, cache keys never - expire. + expire. A value of ``0`` causes keys to immediately expire (effectively + "don't cache"). * :setting:`OPTIONS `: Any options that should be passed to the cache backend. The list of valid options will vary @@ -774,7 +774,8 @@ The basic interface is ``set(key, value, timeout)`` and ``get(key)``:: The ``timeout`` argument is optional and defaults to the ``timeout`` argument of the appropriate backend in the :setting:`CACHES` setting (explained above). It's the number of seconds the value should be stored in the cache. Passing in -``None`` for ``timeout`` will cache the value forever. +``None`` for ``timeout`` will cache the value forever. A ``timeout`` of ``0`` +won't cache the value. If the object doesn't exist in the cache, ``cache.get()`` returns ``None``::