From dd98ccd4821f71543a5489d421ea2dee28901f17 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 16 Jan 2014 21:13:08 -0500 Subject: Fixed #16785 -- Documented some of the design decisions of the cache framework. Thanks jamesp for the draft patch. --- docs/misc/design-philosophies.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'docs/misc') diff --git a/docs/misc/design-philosophies.txt b/docs/misc/design-philosophies.txt index 8664d4e7ed..39807ed3d0 100644 --- a/docs/misc/design-philosophies.txt +++ b/docs/misc/design-philosophies.txt @@ -307,3 +307,29 @@ Differentiate between GET and POST GET and POST are distinct; developers should explicitly use one or the other. The framework should make it easy to distinguish between GET and POST data. + +.. _cache-design-philosophy: + +Cache Framework +=============== + +The core goals of Django's :doc:`cache framework ` are: + +Less code +--------- + +A cache should be as fast as possible. Hence, all framework code surrounding +the cache backend should be kept to the absolute minimum, especially for +``get()`` operations. + +Consistency +----------- + +The cache API should provide a consistent interface across the different +cache backends. + +Extensibility +------------- + +The cache API should be extensible at the application level based on the +developer's needs (for example, see :ref:`cache_key_transformation`). -- cgit v1.3