Commits

Mike Bayer committed 325aee8

document utilities

Comments (0)

Files changed (5)

docs/build/api.rst

 
 .. automodule:: dogpile.cache.plugins.mako_cache
     :members:
+
+Utilities
+=========
+
+.. currentmodule:: dogpile.cache.util
+
+.. autofunction:: function_key_generator
+
+.. autofunction:: sha1_mangle_key
+
+.. autofunction:: length_conditional_mangler
+

docs/build/usage.rst

         expiration_time = 3600,
         arguments = {
             'url':["127.0.0.1"],
-            'binary':True,
-            'behaviors':{"tcp_nodelay": True,"ketama":True}
         }
     )
 

dogpile/cache/backends/memcached.py

     `pylibmc <http://sendapatch.se/projects/pylibmc/index.html>`_ 
     memcached client.
     
-    E.g.::
+    A configuration illustrating several of the optional
+    arguments described in the pylibmc documentation::
     
         from dogpile.cache import make_region
 
     dictionary include:
     
     :param url: the string URL to connect to.  Can be a single
-     string or a list of strings.
+     string or a list of strings.  This is the only argument
+     that's required.
     :param distributed_lock: boolean, when True, will use a
      memcached-lock as the dogpile lock (see :class:`.MemcachedLock`).   
      Use this when multiple

dogpile/cache/region.py

      keys before passing to the backend.  Defaults to ``None``,
      in which case the key mangling function recommended by
      the cache backend will be used.    A typical mangler
-     is the SHA1 mangler found at found at :meth:`.sha1_mangle_key` 
+     is the SHA1 mangler found at :func:`.sha1_mangle_key` 
      which coerces keys into a SHA1
      hash, so that the string length is fixed.  To
      disable all key mangling, set to ``False``.

tests/test_pylibmc_backend.py

     }
     config_args = {
         "arguments":{
-            "url":"127.0.0.1:11211"
+            "url":"127.0.0.1"
         }
     }
 
     }
     config_args = {
         "arguments":{
-            "url":"127.0.0.1:11211",
+            "url":"127.0.0.1",
             "distributed_lock":True
         }
     }
 
     config_args = {
         "arguments":{
-            "url":"127.0.0.1:11211",
+            "url":"127.0.0.1",
             "distributed_lock":True
         }
     }
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.