feat: on-get callback (#38)

* feat: on-get callback

* style: add alias types for callbacks

* style: rename callback types

Author: uncle-lv

src/cacheout/cache.py

@@ -23,6 +23,7 @@
 T_TTL = t.Union[int, float]
 T_FILTER = t.Union[str, t.List[t.Hashable], t.Pattern, t.Callable]
 
+
 UNSET = object()
 
 
@@ -46,6 +47,21 @@ class RemovalCause(Enum):
     POPITEM = auto()
 
 
+#: Callback that will be executed when a cache entry is retrieved.
+
+#: It is called with arguments ``(key, value, exists)`` where `key` is the cache key,
+#: `value` is the value retrieved (could be the default),
+#: and `exists` is whether the cache key exists or not.
+T_ON_GET_CALLBACK = t.Optional[t.Callable[[t.Hashable, t.Any, bool], None]]
+
+#: Callback that will be executed when a cache entry is removed.
+
+#: It is called with arguments ``(key, value, cause)`` where `key` is the cache key,
+#: `value` is the cached value at the time of deletion,
+#: and `cause` is the reason the key was removed (see :class:`RemovalCause` for enumerated causes).
+T_ON_DELETE_CALLBACK = t.Optional[t.Callable[[t.Hashable, t.Any, RemovalCause], None]]
+
+
 class Cache:
     """
     An in-memory, FIFO cache object.
@@ -74,7 +90,10 @@ class Cache:
         default: Default value or function to use in :meth:`get` when key is not found. If callable,
             it will be passed a single argument, ``key``, and its return value will be set for that
             cache key.
+        on_get: Callback which will be executed when a cache entry is retrieved.
+            See :class:`T_ON_GET_CALLBACK` for details.
         on_delete: Callback which will be executed when a cache entry is removed.
+            See :class:`T_ON_DELETE_CALLBACK` for details.
         stats: Cache statistics.
     """
 
@@ -90,12 +109,14 @@ def __init__(
         timer: t.Callable[[], T_TTL] = time.time,
         default: t.Any = None,
         enable_stats: bool = False,
-        on_delete: t.Optional[t.Callable[[t.Hashable, t.Any, RemovalCause], None]] = None,
+        on_get: T_ON_GET_CALLBACK = None,
+        on_delete: T_ON_DELETE_CALLBACK = None,
     ):
         self.maxsize = maxsize
         self.ttl = ttl
         self.timer = timer
         self.default = default
+        self.on_get = on_get
         self.on_delete = on_delete
         self.stats = CacheStatsTracker(self, enable=enable_stats)
 
@@ -255,6 +276,7 @@ def get(self, key: t.Hashable, default: t.Any = None) -> t.Any:
             return self._get(key, default=default)
 
     def _get(self, key: t.Hashable, default: t.Any = None) -> t.Any:
+        existed = True
         try:
             value = self._cache[key]
 
@@ -263,6 +285,7 @@ def _get(self, key: t.Hashable, default: t.Any = None) -> t.Any:
                 raise KeyError
             self.stats.inc_hit_count()
         except KeyError:
+            existed = False
             self.stats.inc_miss_count()
             if default is None:
                 default = self.default
@@ -273,6 +296,9 @@ def _get(self, key: t.Hashable, default: t.Any = None) -> t.Any:
             else:
                 value = default
 
+        if self.on_get:
+            self.on_get(key, value, existed)
+
         return value
 
     def get_many(self, iteratee: T_FILTER) -> dict:

tests/test_cache.py

@@ -719,32 +719,50 @@ def test_cache_on_delete(cache: Cache, timer: Timer):
 
     def on_delete(key, value, cause):
         nonlocal log
-        log = f"{key}:{value} {cause.value}"
+        log = f"{key}={value}, RemovalCause={cause.value}"
 
     cache.on_delete = on_delete
     cache.set("DELETE", 1)
     cache.delete("DELETE")
-    assert log == f"DELETE:1 {RemovalCause.DELETE.value}"
+    assert log == f"DELETE=1, RemovalCause={RemovalCause.DELETE.value}"
 
     cache.set("SET", 1)
     cache.set("SET", 2)
-    assert log == f"SET:1 {RemovalCause.SET.value}"
+    assert log == f"SET=1, RemovalCause={RemovalCause.SET.value}"
 
     cache.clear()
     cache.set("POPITEM", 1)
     cache.popitem()
-    assert log == f"POPITEM:1 {RemovalCause.POPITEM.value}"
+    assert log == f"POPITEM=1, RemovalCause={RemovalCause.POPITEM.value}"
 
     cache.set("EXPIRED", 1, ttl=1)
     timer.time = 1
     cache.delete_expired()
-    assert log == f"EXPIRED:1 {RemovalCause.EXPIRED.value}"
+    assert log == f"EXPIRED=1, RemovalCause={RemovalCause.EXPIRED.value}"
 
     cache.clear()
     cache.maxsize = 1
     cache.set("FULL", 1)
     cache.set("OVERFLOW", 2)
-    assert log == f"FULL:1 {RemovalCause.FULL.value}"
+    assert log == f"FULL=1, RemovalCause={RemovalCause.FULL.value}"
+
+
+def test_cache_on_get(cache: Cache):
+    """Test that on_get(cache) callback."""
+    log = ""
+
+    def on_get(key, value, existed):
+        nonlocal log
+        log = f"{key}={value}, existed={existed}"
+
+    cache.on_get = on_get
+    cache.set("hit", 1)
+
+    cache.get("hit")
+    assert log == "hit=1, existed=True"
+
+    cache.get("miss")
+    assert log == "miss=None, existed=False"
 
 
 def test_cache_stats__disabled_by_default(cache: Cache):