summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2020-12-17 07:26:30 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-12-17 10:39:21 +0100
commitb044b417d22f8fc341fd6d2c4e1613ec3d7cb01c (patch)
tree5ddb26fdc87eb8afed5fec5dd6d4eea1f9d7386a
parentda42df9378ce012d72747fbf1160a6afdf5f5095 (diff)
[3.1.x] Refs #30181 -- Corrected note about storing None in the cache.
Backport of d23dad5778b3610a5f870b4757ba628780924dd1 from master
-rw-r--r--docs/topics/cache.txt18
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index f8e9f34380..cb5d21e7b0 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -824,9 +824,21 @@ If the object doesn't exist in the cache, ``cache.get()`` returns ``None``::
>>> cache.get('my_key')
None
-We advise against storing the literal value ``None`` in the cache, because you
-won't be able to distinguish between your stored ``None`` value and a cache
-miss signified by a return value of ``None``.
+If you need to determine whether the object exists in the cache and you have
+stored a literal value ``None``, use a sentinel object as the default::
+
+ >>> sentinel = object()
+ >>> cache.get('my_key', sentinel) is sentinel
+ False
+ >>> # Wait 30 seconds for 'my_key' to expire...
+ >>> cache.get('my_key', sentinel) is sentinel
+ True
+
+.. admonition:: ``MemcachedCache``
+
+ Due to a ``python-memcached`` limitation, it's not possible to distinguish
+ between stored ``None`` value and a cache miss signified by a return value
+ of ``None`` on the deprecated ``MemcachedCache`` backend.
``cache.get()`` can take a ``default`` argument. This specifies which value to
return if the object doesn't exist in the cache::