Remove key parameter (#643)

CHANGES.rst

@@ -4,6 +4,19 @@ CHANGES
 
 .. towncrier release notes start
 
+1.0.0 (2023-xx-xx)
+==================
+
+Migration instructions
+++++++++++++++++++++++
+
+There are a number of backwards-incompatible changes. These points should help with migrating from an older release:
+
+* The ``key`` parameter has been removed from the ``cached`` decorator. The behaviour can be easily reimplemented with ``key_builder=lambda *a, **kw: "foo"``
+* When using the ``key_builder`` parameter in ``@multicached``, the function will now return the original, unmodified keys, only using the transformed keys in the cache (this has always been the documented behaviour, but not the implemented behaviour).
+* ``BaseSerializer`` is now an ``ABC``, so cannot be instantiated directly.
+
+
 0.12.0 (2023-01-13)
 ===================
 
@@ -20,6 +33,7 @@ CHANGES
 * Fixed ``from aiocache import *``.
 * Fixed ``.delete()`` when values are falsy.
 
+
 0.11.1 (2019-07-31)
 ===================
 

aiocache/decorators.py

@@ -34,9 +34,6 @@ class cached:
                                        happens in the background. Enabled by default
 
     :param ttl: int seconds to store the function call. Default is None which means no expiration.
-    :param key: str value to set as key for the function return. Takes precedence over
-        key_builder param. If key and key_builder are not passed, it will use module_name
-        + function_name + args + kwargs
     :param namespace: string to use as default prefix for the key used in all operations of
         the backend. Default is None
     :param key_builder: Callable that allows to build the function dynamically. It receives
@@ -59,7 +56,6 @@ class cached:
     def __init__(
         self,
         ttl=SENTINEL,
-        key=None,
         namespace=None,
         key_builder=None,
         cache=Cache.MEMORY,
@@ -70,7 +66,6 @@ def __init__(
         **kwargs,
     ):
         self.ttl = ttl
-        self.key = key
         self.key_builder = key_builder
         self.noself = noself
         self.alias = alias
@@ -126,8 +121,6 @@ async def decorator(
         return result
 
     def get_cache_key(self, f, args, kwargs):
-        if self.key:
-            return self.key
         if self.key_builder:
             return self.key_builder(f, *args, **kwargs)
 
@@ -172,9 +165,6 @@ class cached_stampede(cached):
         If 0 or None, no locking happens (default is 2). redis and memory backends support
         float ttls
     :param ttl: int seconds to store the function call. Default is None which means no expiration.
-    :param key: str value to set as key for the function return. Takes precedence over
-        key_from_attr param. If key and key_from_attr are not passed, it will use module_name
-        + function_name + args + kwargs
     :param key_from_attr: str arg or kwarg name from the function to use as a key.
     :param namespace: string to use as default prefix for the key used in all operations of
         the backend. Default is None

examples/cached_decorator.py

@@ -9,8 +9,8 @@
 
 
 @cached(
-    ttl=10, cache=Cache.REDIS, key="key", serializer=PickleSerializer(),
-    port=6379, namespace="main")
+    ttl=10, cache=Cache.REDIS, key_builder=lambda *args, **kw: "key",
+    serializer=PickleSerializer(), port=6379, namespace="main")
 async def cached_call():
     return Result("content", 200)
 

tests/acceptance/test_decorators.py

@@ -27,7 +27,7 @@ def default_cache(self, mocker, cache):
         mocker.patch("aiocache.decorators._get_cache", autospec=True, return_value=cache)
 
     async def test_cached_ttl(self, cache):
-        @cached(ttl=2, key=Keys.KEY)
+        @cached(ttl=2, key_builder=lambda *args, **kw: Keys.KEY)
         async def fn():
             return str(random.randint(1, 50))
 

tests/ut/test_decorators.py

@@ -39,8 +39,7 @@ def spy_stub(self, mocker):
     def test_init(self):
         c = cached(
             ttl=1,
-            key="key",
-            key_builder="fn",
+            key_builder=lambda *args, **kw: "key",
             cache=SimpleMemoryCache,
             plugins=None,
             alias=None,
@@ -50,8 +49,7 @@ def test_init(self):
         )
 
         assert c.ttl == 1
-        assert c.key == "key"
-        assert c.key_builder == "fn"
+        assert c.key_builder() == "key"
         assert c.cache is None
         assert c._cache == SimpleMemoryCache
         assert c._serializer is None
@@ -76,8 +74,7 @@ def test_alias_takes_precedence(self, mock_cache):
             assert c.cache is mock_cache
 
     def test_get_cache_key_with_key(self, decorator):
-        decorator.key = "key"
-        decorator.key_builder = "fn"
+        decorator.key_builder = lambda *args, **kw: "key"
         assert decorator.get_cache_key(stub, (1, 2), {"a": 1, "b": 2}) == "key"
 
     def test_get_cache_key_without_key_and_attr(self, decorator):
@@ -258,8 +255,7 @@ def test_init(self):
         c = cached_stampede(
             lease=3,
             ttl=1,
-            key="key",
-            key_builder="fn",
+            key_builder=lambda *args, **kw: "key",
             cache=SimpleMemoryCache,
             plugins=None,
             alias=None,
@@ -269,8 +265,7 @@ def test_init(self):
         )
 
         assert c.ttl == 1
-        assert c.key == "key"
-        assert c.key_builder == "fn"
+        assert c.key_builder() == "key"
         assert c.cache is None
         assert c._cache == SimpleMemoryCache
         assert c._serializer is None