docs(cache): update parameter names for excluding arguments from cache key

- Rename `exclude_positional_args` to `exclude_args_indices`
- Rename `exclude_keyword_args` to `exclude_args_names`
- Update README.md to reflect new parameter names
- Update cache.py to use new parameter names

Author: tanbro

CHANGELOG.md

@@ -7,6 +7,9 @@
 - ✨ **New Features:**
   - Added arguments excluding support for the `RedisFuncCache` class, which makes it possible to cache functions with arguments that cannot be serialized.
 
+- 💔 **Breaking Changes:**
+  - Rename `redis_func_cache.mixins.policies` to `redis_func_cache.mixins.scripts`.
+
 ## v0.4
 
 > 📅 2025-06-24

README.md

@@ -728,7 +728,7 @@ However, you can work around this issue by:
 
 - Splitting the function into two parts: one with fully serializable arguments (apply the cache decorator to this part), and another that may contain un-serializable arguments (this part calls the first one).
 
-- Using `exclude_keyword_args` or `exclude_positional_args` to exclude un-serializable arguments from key and hash calculations.
+- Using `exclude_args_names` or `exclude_args_indices` to exclude un-serializable arguments from key and hash calculations.
 
 This approach is particularly useful for functions such as a database query.
 
@@ -737,20 +737,21 @@ For example, the `pool` argument in the following function is not serializable:
 ```python
 def get_book(pool: ConnectionPool, book_id: int):
     connection = pool.get_connection()
-    return connection.execute("SELECT * FROM books WHERE book_id = %s", book_id)
+    book = connection.execute("SELECT * FROM books WHERE book_id = %s", book_id).fetchone()
+    return json.dumps(book.to_dict())
 ```
 
 However, we can exclude the `pool` argument from the key and hash calculations, so the function can be cached:
 
 ```python
-@cache(exclude_keyword_args=["pool"])
+@cache(exclude_args_names=["pool"])
 def get_book(pool: ConnectionPool, book_id: int):
     ...
 ```
 
 Important:
-    - When using the `exclude_keyword_args` parameter, ensure that the argument is passed using keyword way.
-    - When using the `exclude_positional_args` parameter, ensure that the argument is passed using positional way.
+    - When using the `exclude_args_names` parameter, ensure that the argument is passed in a keyword way.
+    - When using the `exclude_args_indices` parameter, ensure that the argument is passed in a positional way.
 
 ## Known Issues
 

src/redis_func_cache/cache.py

@@ -446,11 +446,11 @@ def _before_get(
         user_function,
         user_args,
         user_kwds,
-        exclude_positional_args: Optional[Sequence[int]] = None,
-        exclude_keyword_args: Optional[Sequence[str]] = None,
+        exclude_args_indices: Optional[Sequence[int]] = None,
+        exclude_args_names: Optional[Sequence[str]] = None,
     ):
-        args = [x for i, x in enumerate(user_args) if i not in (exclude_positional_args or [])]
-        kwds = {k: v for k, v in user_kwds.items() if k not in (exclude_keyword_args or {})}
+        args = [x for i, x in enumerate(user_args) if i not in (exclude_args_indices or [])]
+        kwds = {k: v for k, v in user_kwds.items() if k not in (exclude_args_names or {})}
         keys = self.policy.calc_keys(user_function, args, kwds)
         hash_value = self.policy.calc_hash(user_function, args, kwds)
         ext_args = self.policy.calc_ext_args(user_function, args, kwds) or ()
@@ -463,8 +463,8 @@ def exec(
         user_kwds: Mapping[str, Any],
         serialize_func: Optional[SerializerT] = None,
         deserialize_func: Optional[DeserializerT] = None,
-        exclude_positional_args: Optional[Sequence[int]] = None,
-        exclude_keyword_args: Optional[Sequence[str]] = None,
+        exclude_args_indices: Optional[Sequence[int]] = None,
+        exclude_args_names: Optional[Sequence[str]] = None,
         **options,
     ):
         """Execute the given user function with the provided arguments.
@@ -488,7 +488,7 @@ def exec(
         if not (isinstance(script_0, redis.commands.core.Script) and isinstance(script_1, redis.commands.core.Script)):
             raise RuntimeError("Can not eval redis lua script in asynchronous mode on a synchronous redis client")
         keys, hash_value, ext_args = self._before_get(
-            user_function, user_args, user_kwds, exclude_positional_args, exclude_keyword_args
+            user_function, user_args, user_kwds, exclude_args_indices, exclude_args_names
         )
         cached_return_value = self.get(script_0, keys, hash_value, self.ttl, options, ext_args)
         if cached_return_value is not None:
@@ -505,8 +505,8 @@ async def aexec(
         user_kwds: Mapping[str, Any],
         serialize_func: Optional[SerializerT] = None,
         deserialize_func: Optional[DeserializerT] = None,
-        exclude_positional_args: Optional[Sequence[int]] = None,
-        exclude_keyword_args: Optional[Sequence[str]] = None,
+        exclude_args_indices: Optional[Sequence[int]] = None,
+        exclude_args_names: Optional[Sequence[str]] = None,
         **options,
     ):
         """Asynchronous version of :meth:`.exec`"""
@@ -517,7 +517,7 @@ async def aexec(
         ):
             raise RuntimeError("Can not eval redis lua script in synchronous mode on an asynchronous redis client")
         keys, hash_value, ext_args = self._before_get(
-            user_function, user_args, user_kwds, exclude_positional_args, exclude_keyword_args
+            user_function, user_args, user_kwds, exclude_args_indices, exclude_args_names
         )
         cached = await self.aget(script_0, keys, hash_value, self.ttl, options, ext_args)
         if cached is not None:
@@ -532,8 +532,8 @@ def decorate(
         user_function: Optional[CallableTV] = None,
         /,
         serializer: Optional[SerializerSetterValueT] = None,
-        exclude_positional_args: Optional[Sequence[int]] = None,
-        exclude_keyword_args: Optional[Sequence[str]] = None,
+        exclude_args_indices: Optional[Sequence[int]] = None,
+        exclude_args_names: Optional[Sequence[str]] = None,
         **options,
     ) -> CallableTV:
         """Decorate the given function with caching.
@@ -549,11 +549,11 @@ def decorate(
 
                 If assigned, it overwrite the :attr:`serializer` property of the cache instance on the decorated function.
 
-            exclude_positional_args: A list of positional argument indices to exclude from cache key generation.
+            exclude_args_indices: A list of positional argument indices to exclude from cache key generation.
 
                 These arguments will be filtered out before cache operations.
 
-            exclude_keyword_args: A list of keyword argument names to exclude from cache key generation.
+            exclude_args_names: A list of keyword argument names to exclude from cache key generation.
 
                 These parameters will be filtered out before cache operations.
 
@@ -625,8 +625,8 @@ def wrapper(*user_args, **user_kwargs):
                     user_kwargs,
                     serialize_func,
                     deserialize_func,
-                    exclude_positional_args,
-                    exclude_keyword_args,
+                    exclude_args_indices,
+                    exclude_args_names,
                     **options,
                 )
 
@@ -638,8 +638,8 @@ async def awrapper(*user_args, **user_kwargs):
                     user_kwargs,
                     serialize_func,
                     deserialize_func,
-                    exclude_positional_args,
-                    exclude_keyword_args,
+                    exclude_args_indices,
+                    exclude_args_names,
                     **options,
                 )