Merge branch 'master' into patch-1

Author: willfrey

.github/workflows/integration.yaml

@@ -24,7 +24,9 @@ permissions:
   contents: read  #  to fetch code (actions/checkout)
 
 env:
-  REDIS_STACK_IMAGE: redis/redis-stack-server:7.4.0-rc1
+  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+  REDIS_IMAGE: redis:7.4-rc2
+  REDIS_STACK_IMAGE: redis/redis-stack-server:7.4.0-rc2
 
 jobs:
   dependency-audit:
@@ -115,7 +117,9 @@ jobs:
         python-version: ['3.8', '3.11']
         test-type: ['standalone', 'cluster']
         connection-type: ['hiredis', 'plain']
-        protocol: ['3']
+        exclude:
+          - test-type: 'cluster'
+            connection-type: 'hiredis'
     env:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: RESP3 [${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}]
@@ -134,9 +138,33 @@ jobs:
             pip install hiredis
           fi
           invoke devenv
-          sleep 5 # time to settle
-          invoke ${{matrix.test-type}}-tests
-          invoke ${{matrix.test-type}}-tests --uvloop
+          sleep 10 # time to settle
+          invoke ${{matrix.test-type}}-tests --protocol=3
+          invoke ${{matrix.test-type}}-tests --uvloop --protocol=3
+
+      - uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}-resp3
+          path: '${{matrix.test-type}}*results.xml'
+
+      - name: Upload codecov coverage
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: false
+
+      - name: View Test Results
+        uses: dorny/test-reporter@v1
+        if: success() || failure()
+        continue-on-error: true
+        with:
+          name: Test Results ${{matrix.python-version}} ${{matrix.test-type}}-${{matrix.connection-type}}-resp3
+          path: '*.xml'
+          reporter: java-junit
+          list-suites: all
+          list-tests: all
+          max-annotations: 10
+          fail-on-error: 'false'
 
   build_and_test_package:
     name: Validate building and installing the package

.github/workflows/spellcheck.yml

@@ -8,7 +8,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Check Spelling
-        uses: rojopolis/spellcheck-github-actions@0.36.0
+        uses: rojopolis/spellcheck-github-actions@0.38.0
         with:
           config_path: .github/spellcheck-settings.yml
           task_name: Markdown

.github/workflows/stale-issues.yml

@@ -12,7 +12,7 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/stale@v3
+    - uses: actions/stale@v9
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'This issue is marked stale. It will be closed in 30 days if it is not updated.'

CHANGES

@@ -1,4 +1,5 @@
     * Mark `redis.asyncio` as public in the top-level __init__.py
+    * Move doctests (doc code examples) to main branch
     * Update `ResponseT` type hint
     * Allow to control the minimum SSL version
     * Add an optional lock_name attribute to LockError.

dev_requirements.txt

@@ -1,18 +1,18 @@
-click==8.0.4
 black==24.3.0
 cachetools
-flake8==5.0.4
+click==8.0.4
 flake8-isort==6.0.0
+flake8==5.0.4
 flynt~=0.69.0
+invoke==1.7.3
 mock==4.0.3
 packaging>=20.4
-pytest==7.2.0
-pytest-timeout==2.1.0
-pytest-asyncio>=0.20.2
-invoke==1.7.3
-pytest-cov>=4.0.0
-vulture>=2.3.0
+pytest
+pytest-asyncio
+pytest-cov
+pytest-timeout
 ujson>=4.2.0
-wheel>=0.30.0
 urllib3<2
 uvloop
+vulture>=2.3.0
+wheel>=0.30.0

docker-compose.yml

@@ -7,7 +7,7 @@ services:
   redis:
     image: ${REDIS_IMAGE:-redis:latest}
     container_name: redis-standalone
-    command: redis-server --enable-debug-command yes
+    command: redis-server --enable-debug-command yes --protected-mode no
     ports:
       - 6379:6379
     profiles:
@@ -21,7 +21,7 @@ services:
     container_name: redis-replica
     depends_on:
       - redis
-    command: redis-server --replicaof redis 6379
+    command: redis-server --replicaof redis 6379 --protected-mode no
     ports:
       - 6380:6379
     profiles:
@@ -67,7 +67,7 @@ services:
     container_name: redis-sentinel
     depends_on:
       - redis
-    entrypoint: "/usr/local/bin/redis-sentinel /redis.conf --port 26379"
+    entrypoint: "redis-sentinel /redis.conf --port 26379"
     ports:
       - 26379:26379
     volumes:
@@ -81,7 +81,7 @@ services:
     container_name: redis-sentinel2
     depends_on:
       - redis
-    entrypoint: "/usr/local/bin/redis-sentinel /redis.conf --port 26380"
+    entrypoint: "redis-sentinel /redis.conf --port 26380"
     ports:
       - 26380:26380
     volumes:
@@ -95,7 +95,7 @@ services:
     container_name: redis-sentinel3
     depends_on:
       - redis
-    entrypoint: "/usr/local/bin/redis-sentinel /redis.conf --port 26381"
+    entrypoint: "redis-sentinel /redis.conf --port 26381"
     ports:
       - 26381:26381
     volumes:
@@ -114,3 +114,12 @@ services:
     profiles:
       - standalone
       - all
+
+  redis-stack-graph:
+    image: redis/redis-stack-server:6.2.6-v15
+    container_name: redis-stack-graph
+    ports:
+      - 6480:6379
+    profiles:
+      - standalone
+      - all

dockers/create_cluster.sh

@@ -31,7 +31,7 @@ dir /nodes/$PORT
 EOF
 
   set -x
-  /usr/local/bin/redis-server /nodes/$PORT/redis.conf
+  redis-server /nodes/$PORT/redis.conf
   sleep 1
   if [ $? -ne 0 ]; then
     echo "Redis failed to start, exiting."
@@ -40,8 +40,8 @@ EOF
   echo 127.0.0.1:$PORT >> /nodes/nodemap
 done
 if [ -z "${REDIS_PASSWORD}" ]; then
-    echo yes | /usr/local/bin/redis-cli --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
+    echo yes | redis-cli --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
 else
-    echo yes | /usr/local/bin/redis-cli -a ${REDIS_PASSWORD} --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
+    echo yes | redis-cli -a ${REDIS_PASSWORD} --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
 fi
 tail -f /redis.log

doctests/README.md

@@ -0,0 +1,32 @@
+# Command examples for redis.io
+
+## How to add an example
+
+Create regular python file in the current folder with meaningful name. It makes sense prefix example files with
+command category (e.g. string, set, list, hash, etc) to make navigation in the folder easier. Files ending in *.py*
+are automatically run by the test suite.
+
+### Special markup
+
+See https://github.com/redis-stack/redis-stack-website#readme for more details.
+
+## How to test examples
+
+Examples are standalone python scripts, committed to the *doctests* directory. These scripts assume that the
+```requirements.txt``` and ```dev_requirements.txt``` from this repository have been installed, as per below.
+
+```bash
+pip install -r requirements.txt
+pip install -r dev_requirements.txt
+pip install -r doctests/requirements.txt
+```
+
+Note - the CI process, runs the basic ```black``` and ```isort``` linters against the examples. Assuming
+the requirements above have been installed you can run ```black yourfile.py``` and ```isort yourfile.py```
+locally to validate the linting, prior to CI.
+
+Just include necessary assertions in the example file and run
+```bash
+sh doctests/run_examples.sh
+```
+to test all examples in the current folder.

doctests/dt_bitfield.py

@@ -0,0 +1,34 @@
+# EXAMPLE: bitfield_tutorial
+# HIDE_START
+"""
+Code samples for Bitfield doc pages:
+    https://redis.io/docs/latest/develop/data-types/bitfields/
+"""
+import redis
+
+r = redis.Redis(decode_responses=True)
+# HIDE_END
+
+# REMOVE_START
+r.delete("bike:1:stats")
+# REMOVE_END
+
+# STEP_START bf
+bf = r.bitfield("bike:1:stats")
+res1 = bf.set("u32", "#0", 1000).execute()
+print(res1)  # >>> [0]
+
+res2 = bf.incrby("u32", "#0", -50).incrby("u32", "#1", 1).execute()
+print(res2)  # >>> [950, 1]
+
+res3 = bf.incrby("u32", "#0", 500).incrby("u32", "#1", 1).execute()
+print(res3)  # >>> [1450, 2]
+
+res4 = bf.get("u32", "#0").get("u32", "#1").execute()
+print(res4)  # >>> [1450, 2]
+# STEP_END
+
+# REMOVE_START
+assert res1 == [0]
+assert res4 == [1450, 2]
+# REMOVE_END

doctests/dt_bitmap.py

@@ -0,0 +1,40 @@
+# EXAMPLE: bitmap_tutorial
+# HIDE_START
+"""
+Code samples for Bitmap doc pages:
+    https://redis.io/docs/latest/develop/data-types/bitmaps/
+"""
+import redis
+
+r = redis.Redis(decode_responses=True)
+# HIDE_END
+
+# REMOVE_START
+r.delete("pings:2024-01-01-00:00")
+# REMOVE_END
+
+# STEP_START ping
+res1 = r.setbit("pings:2024-01-01-00:00", 123, 1)
+print(res1)  # >>> 0
+
+res2 = r.getbit("pings:2024-01-01-00:00", 123)
+print(res2)  # >>> 1
+
+res3 = r.getbit("pings:2024-01-01-00:00", 456)
+print(res3)  # >>> 0
+# STEP_END
+
+# REMOVE_START
+assert res1 == 0
+# REMOVE_END
+
+# STEP_START bitcount
+# HIDE_START
+r.setbit("pings:2024-01-01-00:00", 123, 1)
+# HIDE_END
+res4 = r.bitcount("pings:2024-01-01-00:00")
+print(res4)  # >>> 1
+# STEP_END
+# REMOVE_START
+assert res4 == 1
+# REMOVE_END