Merge branch 'master' into fix-async-client-safety

Author: abrookins

.github/actions/run-tests/action.yml

@@ -31,14 +31,9 @@ runs:
     - name: Setup Test environment
       env:
         REDIS_VERSION: ${{ inputs.redis-version }}
-        REDIS_IMAGE: "redis:${{ inputs.redis-version }}"
-        CLIENT_LIBS_TEST_IMAGE: "redislabs/client-libs-test:${{ inputs.redis-version }}"
+        CLIENT_LIBS_TEST_IMAGE_TAG: ${{ inputs.redis-version }}
       run: |
         set -e
-        
-        if [ "${{inputs.redis-version}}" == "8.0-M04-pre" ]; then
-          export REDIS_IMAGE=redis:8.0-M03
-        fi
                 
         echo "::group::Installing dependencies"
         pip install -U setuptools wheel
@@ -60,13 +55,13 @@ runs:
         
           # Mapping of redis version to stack version  
           declare -A redis_stack_version_mapping=(
-            ["7.4.2"]="7.4.0-v2"
-            ["7.2.7"]="7.2.0-v14"
-            ["6.2.17"]="6.2.6-v18"
+            ["7.4.2"]="rs-7.4.0-v2"
+            ["7.2.7"]="rs-7.2.0-v14"
+            ["6.2.17"]="rs-6.2.6-v18"
           )
                   
           if [[ -v redis_stack_version_mapping[$REDIS_VERSION] ]]; then
-            export REDIS_STACK_IMAGE="redis/redis-stack-server:${redis_stack_version_mapping[$REDIS_VERSION]}"
+            export CLIENT_LIBS_TEST_STACK_IMAGE_TAG=${redis_stack_version_mapping[$REDIS_VERSION]}
             echo "REDIS_MOD_URL=redis://127.0.0.1:6479/0" >> $GITHUB_ENV
           else
             echo "Version not found in the mapping."

.github/workflows/integration.yaml

@@ -27,8 +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:latest
-  REDIS_STACK_IMAGE: redis/redis-stack-server:latest
+  CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG: 'rs-7.4.0-v2'
   CURRENT_REDIS_VERSION: '7.4.2'
 
 jobs:
@@ -75,7 +74,7 @@ jobs:
       fail-fast: false
       matrix:
         redis-version: ['8.0-M04-pre', '${{ needs.redis_version.outputs.CURRENT }}', '7.2.7', '6.2.17']
-        python-version: ['3.8', '3.12']
+        python-version: ['3.8', '3.13']
         parser-backend: ['plain']
         event-loop: ['asyncio']
     env:
@@ -99,7 +98,7 @@ jobs:
       fail-fast: false
       matrix:
         redis-version: [ '${{ needs.redis_version.outputs.CURRENT }}' ]
-        python-version: ['3.9', '3.10', '3.11', 'pypy-3.9', 'pypy-3.10']
+        python-version: ['3.9', '3.10', '3.11', '3.12', 'pypy-3.9', 'pypy-3.10']
         parser-backend: [ 'plain' ]
         event-loop: [ 'asyncio' ]
     env:
@@ -123,7 +122,7 @@ jobs:
       fail-fast: false
       matrix:
         redis-version: [ '${{ needs.redis_version.outputs.CURRENT }}' ]
-        python-version: [ '3.8', '3.12']
+        python-version: [ '3.8', '3.13']
         parser-backend: [ 'hiredis' ]
         hiredis-version: [ '>=3.0.0', '<3.0.0' ]
         event-loop: [ 'asyncio' ]
@@ -149,7 +148,7 @@ jobs:
       fail-fast: false
       matrix:
         redis-version: [ '${{ needs.redis_version.outputs.CURRENT }}' ]
-        python-version: [ '3.8', '3.12' ]
+        python-version: [ '3.8', '3.13' ]
         parser-backend: [ 'plain' ]
         event-loop: [ 'uvloop' ]
     env:
@@ -180,9 +179,8 @@ jobs:
           python-version: 3.9
       - name: Run installed unit tests
         env:
-          REDIS_VERSION: ${{ env.CURRENT_REDIS_VERSION }}
-          REDIS_IMAGE: "redis:${{ env.CURRENT_REDIS_VERSION }}"
-          CLIENT_LIBS_TEST_IMAGE: "redislabs/client-libs-test:${{ env.CURRENT_REDIS_VERSION }}"
+          CLIENT_LIBS_TEST_IMAGE_TAG: ${{ env.CURRENT_REDIS_VERSION }}
+          CLIENT_LIBS_TEST_STACK_IMAGE_TAG: ${{ env.CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG }}
         run: |
           bash .github/workflows/install_and_test.sh ${{ matrix.extension }}
 
@@ -192,7 +190,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.9', 'pypy-3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', 'pypy-3.9', 'pypy-3.10']
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.gitignore

@@ -23,3 +23,6 @@ docker/stunnel/keys
 /dockers/*/tls/*
 /dockers/standalone/
 /dockers/cluster/
+/dockers/replica/
+/dockers/sentinel/
+/dockers/redis-stack/

MANIFEST.in

@@ -1,6 +1,8 @@
 include INSTALL
 include LICENSE
 include README.md
+include dev_requirements.txt
+include pytest.ini
 exclude __pycache__
 recursive-include tests *
 recursive-exclude tests *.pyc

README.md

@@ -13,7 +13,7 @@ The Python interface to the Redis key-value store.
 
 ---------------------------------------------
 
-**Note: ** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
+**Note:** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
 
 ---------------------------------------------
 

dev_requirements.txt

@@ -9,11 +9,11 @@ packaging>=20.4
 pytest
 pytest-asyncio>=0.23.0,<0.24.0
 pytest-cov
-pytest-profiling==1.7.0
+pytest-profiling==1.8.1
 pytest-timeout
 ujson>=4.2.0
 uvloop
 vulture>=2.3.0
 wheel>=0.30.0
 numpy>=1.24.0
-redis-entraid==0.1.0b1
+redis-entraid==0.3.0b1

docker-compose.yml

@@ -1,9 +1,14 @@
 ---
+x-client-libs-stack-image: &client-libs-stack-image
+  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_STACK_IMAGE_TAG:-rs-7.4.0-v2}"
+
+x-client-libs-image: &client-libs-image
+  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_IMAGE_TAG:-7.4.2}"
 
 services:
 
   redis:
-    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    <<: *client-libs-image
     container_name: redis-standalone
     environment:
       - TLS_ENABLED=yes
@@ -24,20 +29,26 @@ services:
       - all
 
   replica:
-    image: ${REDIS_IMAGE:-redis:7.4.1}
+    <<: *client-libs-image
     container_name: redis-replica
     depends_on:
       - redis
-    command: redis-server --replicaof redis 6379 --protected-mode no --save ""
+    environment:
+      - TLS_ENABLED=no
+      - REDIS_CLUSTER=no
+      - PORT=6380
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --replicaof redis 6379 --protected-mode no --save ""}
     ports:
-      - 6380:6379
+      - 6380:6380
+    volumes:
+      - "./dockers/replica:/redis/work"
     profiles:
       - replica
       - all-stack
       - all
 
   cluster:
-    image: ${CLIENT_LIBS_TEST_IMAGE:-redislabs/client-libs-test:7.4.1}
+    <<: *client-libs-image
     container_name: redis-cluster
     environment:
       - REDIS_CLUSTER=yes
@@ -58,57 +69,38 @@ services:
       - all
 
   sentinel:
-    image: ${REDIS_IMAGE:-redis:7.4.1}
+    <<: *client-libs-image
     container_name: redis-sentinel
     depends_on:
       - redis
-    entrypoint: "redis-sentinel /redis.conf --port 26379"
+    environment:
+      - REDIS_CLUSTER=no
+      - NODES=3
+      - PORT=26379
+    command: ${REDIS_EXTRA_ARGS:---sentinel}
     ports:
       - 26379:26379
-    volumes:
-      - "./dockers/sentinel.conf:/redis.conf"
-    profiles:
-      - sentinel
-      - all-stack
-      - all
-
-  sentinel2:
-    image: ${REDIS_IMAGE:-redis:7.4.1}
-    container_name: redis-sentinel2
-    depends_on:
-      - redis
-    entrypoint: "redis-sentinel /redis.conf --port 26380"
-    ports:
       - 26380:26380
-    volumes:
-      - "./dockers/sentinel.conf:/redis.conf"
-    profiles:
-      - sentinel
-      - all-stack
-      - all
-
-  sentinel3:
-    image: ${REDIS_IMAGE:-redis:7.4.1}
-    container_name: redis-sentinel3
-    depends_on:
-      - redis
-    entrypoint: "redis-sentinel /redis.conf --port 26381"
-    ports:
       - 26381:26381
     volumes:
-      - "./dockers/sentinel.conf:/redis.conf"
+      - "./dockers/sentinel.conf:/redis/config-default/redis.conf"
+      - "./dockers/sentinel:/redis/work"
     profiles:
       - sentinel
       - all-stack
       - all
 
   redis-stack:
-    image: ${REDIS_STACK_IMAGE:-redis/redis-stack-server:latest}
+    <<: *client-libs-stack-image
     container_name: redis-stack
+    environment:
+      - REDIS_CLUSTER=no
+      - PORT=6379
+    command: ${REDIS_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --save ""}
     ports:
       - 6479:6379
-    environment:
-      - "REDIS_ARGS=${REDIS_STACK_EXTRA_ARGS:---enable-debug-command yes --enable-module-command yes --save ''}"
+    volumes:
+      - "./dockers/redis-stack:/redis/work"
     profiles:
       - standalone
       - all-stack

docs/examples/connection_examples.ipynb

@@ -75,13 +75,26 @@
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "code",
+   "execution_count": 4,
    "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+    },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "import redis\n",
     "\n",
     "r = redis.Redis(protocol=3)\n",
-    "rcon.ping()"
+    "r.ping()"
    ]
   },
   {
@@ -93,7 +106,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -102,7 +115,7 @@
        "True"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }

docs/opentelemetry.rst

@@ -46,7 +46,7 @@ You can then use it to instrument code like this:
 
    RedisInstrumentor().instrument()
 
-Once the code is patched, you can use redis-py as usually:
+Once the code is patched, you can use redis-py as usual:
 
 .. code-block:: python
 

setup.py

@@ -8,7 +8,7 @@
     long_description_content_type="text/markdown",
     keywords=["Redis", "key-value store", "database"],
     license="MIT",
-    version="5.1.1",
+    version="5.2.1",
     packages=find_packages(
         include=[
             "redis",
@@ -54,6 +54,7 @@
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "Programming Language :: Python :: Implementation :: CPython",
         "Programming Language :: Python :: Implementation :: PyPy",
     ],