src/pyams_utils/cache.py
changeset 380 c062ab4db6cd
parent 292 b338586588ad
child 408 cf2304af0fab
--- a/src/pyams_utils/cache.py	Tue Jun 18 16:53:34 2019 +0200
+++ b/src/pyams_utils/cache.py	Wed Jun 26 10:39:34 2019 +0200
@@ -10,20 +10,26 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
+"""PyAMS_utils.cache module
+
+This module provides a small set of adapters which can be used to provide a "cache key" value
+to any kind of object.
+
+The goal of such a cache key value is to provide a string representation, as stable as possible,
+of a given object; this string can be used as a cache key, but also to define an object ID inside
+an HTML page.
+A TALES helper extension is also provided to get an object's cache key from a Chameleon template.
+"""
+
 __docformat__ = 'restructuredtext'
 
-
-# import standard library
+from persistent.interfaces import IPersistent
+from zope.interface import Interface
 
-# import interfaces
-from persistent.interfaces import IPersistent
+from pyams_utils.adapter import ContextRequestViewAdapter, adapter_config
 from pyams_utils.interfaces import ICacheKeyValue
 from pyams_utils.interfaces.tales import ITALESExtension
 
-# import packages
-from pyams_utils.adapter import adapter_config, ContextRequestViewAdapter
-from zope.interface import Interface
-
 
 @adapter_config(context=object, provides=ICacheKeyValue)
 def object_cache_key_adapter(obj):