Client side caching refactoring

.github/wordlist.txt

@@ -1,6 +1,7 @@
 APM
 ARGV
 BFCommands
+CacheImpl
 CFCommands
 CMSCommands
 ClusterNode

.github/workflows/integration.yaml

@@ -27,7 +27,7 @@ env:
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
   # this speeds up coverage with Python 3.12: https://github.com/nedbat/coveragepy/issues/1665
   COVERAGE_CORE: sysmon
-  REDIS_IMAGE: redis:7.4-rc2
+  REDIS_IMAGE: redis:latest
   REDIS_STACK_IMAGE: redis/redis-stack-server:latest
 
 jobs:

dev_requirements.txt

@@ -1,5 +1,4 @@
 black==24.3.0
-cachetools
 click==8.0.4
 flake8-isort
 flake8

docs/examples/connection_examples.ipynb

@@ -69,9 +69,7 @@
   },
   {
    "cell_type": "markdown",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "### By default this library uses the RESP 2 protocol. To enable RESP3, set protocol=3."
    ]

docs/resp3_features.rst

@@ -67,3 +67,35 @@ This means that should you want to perform something, on a given push notificati
     >> p = r.pubsub(push_handler_func=our_func)
 
 In the example above, upon receipt of a push notification, rather than log the message, in the case where specific text occurs, an IOError is raised. This example, highlights how one could start implementing a customized message handler.
+
+Client-side caching
+-------------------
+
+Client-side caching is a technique used to create high performance services.
+It exploits the memory available on application servers, servers that are usually distinct computers compared to the database nodes, to store some subset of the database information directly in the application side.
+For more information please check `official Redis documentation <https://redis.io/docs/latest/develop/use/client-side-caching/>`_.
+Please notice that this feature only available with RESP3 protocol enabled in sync client only. Supported in standalone, Cluster and Sentinel clients.
+
+Basic usage:
+
+Enable caching with default configuration:
+
+.. code:: python
+
+    >>> import redis
+    >>> from redis.cache import CacheConfig
+    >>> r = redis.Redis(host='localhost', port=6379, protocol=3, cache_config=CacheConfig())
+
+The same interface applies to Redis Cluster and Sentinel.
+
+Enable caching with custom cache implementation:
+
+.. code:: python
+
+    >>> import redis
+    >>> from foo.bar import CacheImpl
+    >>> r = redis.Redis(host='localhost', port=6379, protocol=3, cache=CacheImpl())
+
+CacheImpl should implement a `CacheInterface` specified in `redis.cache` package.
+
+More robust documentation soon will be available at `official Redis documentation <https://redis.io/docs/latest/>`_.