Support redis-py 5 and 6

Author: abrookins

.github/workflows/test.yml

@@ -78,7 +78,7 @@ jobs:
           make test-all
 
   test:
-    name: Python ${{ matrix.python-version }} - ${{ matrix.connection }} [redis ${{ matrix.redis-version }}]
+    name: Python ${{ matrix.python-version }} - ${{ matrix.connection }} - redis-py ${{ matrix.redis-py-version }} [redis ${{ matrix.redis-version }}]
     runs-on: ubuntu-latest
     needs: service-tests
     env:
@@ -89,6 +89,7 @@ jobs:
         # 3.11 tests are run in the service-tests job
         python-version: ["3.9", "3.10", 3.12, 3.13] 
         connection: ["hiredis", "plain"]
+        redis-py-version: ["5.x", "6.x"]
         redis-version: ["6.2.6-v9", "latest", "8.0-M03"]
 
     steps:
@@ -116,6 +117,14 @@ jobs:
         run: |
           poetry install --all-extras
 
+      - name: Install specific redis-py version
+        run: |
+          if [[ "${{ matrix.redis-py-version }}" == "5.x" ]]; then
+            poetry add "redis>=5.0.0,<6.0.0"
+          else
+            poetry add "redis>=6.0.0,<7.0.0"
+          fi
+
       - name: Install hiredis if needed
         if: matrix.connection == 'hiredis'
         run: |
@@ -135,7 +144,7 @@ jobs:
           credentials_json: ${{ secrets.GOOGLE_CREDENTIALS }}
 
       - name: Run tests
-        if: matrix.connection == 'plain' && matrix.redis-version == 'latest'
+        if: matrix.connection == 'plain' && matrix.redis-py-version == '6.x' && matrix.redis-version == 'latest'
         env:
           HF_HOME: ${{ github.workspace }}/hf_cache
           GCP_LOCATION: ${{ secrets.GCP_LOCATION }}
@@ -144,12 +153,12 @@ jobs:
           make test
 
       - name: Run tests (alternate)
-        if: matrix.connection != 'plain' || matrix.redis-version != 'latest'
+        if: matrix.connection != 'plain' || matrix.redis-py-version != '6.x' || matrix.redis-version != 'latest'
         run: |
           make test
 
       - name: Run notebooks
-        if: matrix.connection == 'plain' && matrix.redis-version == 'latest'
+        if: matrix.connection == 'plain' && matrix.redis-py-version == '6.x' && matrix.redis-version == 'latest'
         env:
           HF_HOME: ${{ github.workspace }}/hf_cache
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

pyproject.toml

@@ -26,7 +26,7 @@ numpy = [
   { version = ">=1.26.0,<3", python = ">=3.12" },
 ]
 pyyaml = ">=5.4,<7.0"
-redis = "^6.0"
+redis = ">=5.0,<7.0"
 pydantic = "^2"
 tenacity = ">=8.2.2"
 ml-dtypes = ">=0.4.0,<1.0.0"

redisvl/index/index.py

@@ -45,7 +45,14 @@
 
 from redis.client import NEVER_DECODE
 from redis.commands.helpers import get_protocol_version  # type: ignore
-from redis.commands.search.index_definition import IndexDefinition
+
+# Redis 5.x compatibility (6 fixed the import path)
+try:
+    from redis.commands.search.index_definition import (  # type: ignore[import-untyped]
+        IndexDefinition,
+    )
+except ModuleNotFoundError:
+    from redis.commands.search.indexDefinition import IndexDefinition
 
 # Need Result outside TYPE_CHECKING for cast
 from redis.commands.search.result import Result

redisvl/index/storage.py

@@ -17,7 +17,14 @@
 # Add imports for Pipeline types
 from redis.asyncio.client import Pipeline as AsyncPipeline
 from redis.asyncio.cluster import ClusterPipeline as AsyncClusterPipeline
-from redis.commands.search.index_definition import IndexType
+
+# Redis 5.x compatibility (6 fixed the import path)
+try:
+    from redis.commands.search.index_definition import (  # type: ignore[import-untyped]
+        IndexType,
+    )
+except ModuleNotFoundError:
+    from redis.commands.search.indexDefinition import IndexType
 
 from redisvl.exceptions import SchemaValidationError
 from redisvl.redis.utils import convert_bytes

redisvl/redis/utils.py

@@ -21,8 +21,15 @@
     TEMPORARY,
 )
 from redis.commands.search.field import Field
-from redis.commands.search.index_definition import IndexDefinition
-from redis.commands.search.profile_information import ProfileInformation
+
+# Redis 5.x compatibility (6 fixed the import path)
+try:
+    from redis.commands.search.index_definition import (  # type: ignore[import-untyped]
+        IndexDefinition,
+    )
+except ModuleNotFoundError:
+    from redis.commands.search.indexDefinition import IndexDefinition
+
 from redis.commands.search.query import Query
 from redis.commands.search.result import Result
 
@@ -255,11 +262,12 @@ async def async_cluster_create_index(
     return await default_node.execute_command(*args)
 
 
+# TODO: The return type is incorrect because 5.x doesn't have "ProfileInformation"
 def cluster_search(
     client: Search,
     query: Union[str, Query],
     query_params: Optional[Dict[str, Union[str, int, float, bytes]]] = None,
-) -> Union[Result, Pipeline, ProfileInformation]:
+) -> Union[Result, Pipeline, Any]:  # type: ignore[type-arg]
     args, query = client._mk_query_args(query, query_params=query_params)
     st = time.monotonic()
 
@@ -278,11 +286,12 @@ def cluster_search(
     )
 
 
+# TODO: The return type is incorrect because 5.x doesn't have "ProfileInformation"
 async def async_cluster_search(
     client: AsyncSearch,
     query: Union[str, Query],
     query_params: Optional[Dict[str, Union[str, int, float, bytes]]] = None,
-) -> Union[Result, Pipeline, ProfileInformation]:
+) -> Union[Result, Pipeline, Any]:  # type: ignore[type-arg]
     args, query = client._mk_query_args(query, query_params=query_params)
     st = time.monotonic()