Merge branch 'master' into add-return-type-annotations

Author: petyaslavova

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,7 @@
+### Description of change
+
+_Please provide a description of the change here._
+
 ### Pull Request check-list
 
 _Please make sure to review and check all of these items:_
@@ -10,7 +14,3 @@ _Please make sure to review and check all of these items:_
 
 _NOTE: these things are not required to open a PR and can be done
 afterwards / while the PR is open._
-
-### Description of change
-
-_Please provide a description of the change here._

.github/workflows/codeql-analysis.yml

@@ -36,7 +36,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/docs.yaml

@@ -25,7 +25,7 @@ jobs:
      name: Build docs
      runs-on: ubuntu-latest
      steps:
-       - uses: actions/checkout@v5
+       - uses: actions/checkout@v6
        - uses: actions/setup-python@v6
          with:
            python-version: "3.10"

.github/workflows/hiredis-py-integration.yaml

@@ -23,8 +23,8 @@ env:
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
   # this speeds up coverage with Python 3.12: https://github.com/nedbat/coveragepy/issues/1665
   COVERAGE_CORE: sysmon
-  CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG: '8.0.2'
-  CURRENT_REDIS_VERSION: '8.0.2'
+  CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG: '8.4.0'
+  CURRENT_REDIS_VERSION: '8.4.0'
 
 jobs:
   redis_version:
@@ -53,7 +53,7 @@ jobs:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: Redis ${{ matrix.redis-version }}; Python ${{ matrix.python-version }}; RESP Parser:${{matrix.parser-backend}} (${{ matrix.hiredis-version }}); EL:${{matrix.event-loop}}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           ref: ${{ inputs.redis-py-branch }}
       - name: Run tests

.github/workflows/integration.yaml

@@ -29,15 +29,15 @@ env:
   COVERAGE_CORE: sysmon
   # patch releases get included in the base version image when they are published
   # for example after 8.2.1 is published, 8.2 image contains 8.2.1 content
-  CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG: '8.2'
-  CURRENT_REDIS_VERSION: '8.2'
+  CURRENT_CLIENT_LIBS_TEST_STACK_IMAGE_TAG: '8.4.0'
+  CURRENT_REDIS_VERSION: '8.4.0'
 
 jobs:
   dependency-audit:
     name: Dependency audit
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: pypa/gh-action-pip-audit@v1.0.8
         with:
           inputs: dev_requirements.txt
@@ -48,7 +48,7 @@ jobs:
     name: Code linters
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
@@ -76,15 +76,15 @@ jobs:
       max-parallel: 15
       fail-fast: false
       matrix:
-        redis-version: ['8.4-GA-pre.2', '${{ needs.redis_version.outputs.CURRENT }}', '8.0.2' ,'7.4.4', '7.2.9']
+        redis-version: ['${{ needs.redis_version.outputs.CURRENT }}', '8.2', '8.0.2' ,'7.4.4', '7.2.9']
         python-version: ['3.10', '3.14']
         parser-backend: ['plain']
         event-loop: ['asyncio']
     env:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: Redis ${{ matrix.redis-version }}; Python ${{ matrix.python-version }}; RESP Parser:${{matrix.parser-backend}}; EL:${{matrix.event-loop}}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Run tests
         uses: ./.github/actions/run-tests
         with:
@@ -108,7 +108,7 @@ jobs:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: Redis ${{ matrix.redis-version }}; Python ${{ matrix.python-version }}; RESP Parser:${{matrix.parser-backend}}; EL:${{matrix.event-loop}}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Run tests
         uses: ./.github/actions/run-tests
         with:
@@ -133,7 +133,7 @@ jobs:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: Redis ${{ matrix.redis-version }}; Python ${{ matrix.python-version }}; RESP Parser:${{matrix.parser-backend}} (${{ matrix.hiredis-version }}); EL:${{matrix.event-loop}}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Run tests
         uses: ./.github/actions/run-tests
         with:
@@ -158,7 +158,7 @@ jobs:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     name: Redis ${{ matrix.redis-version }}; Python ${{ matrix.python-version }}; RESP Parser:${{matrix.parser-backend}}; EL:${{matrix.event-loop}}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Run tests
         uses: ./.github/actions/run-tests
         with:
@@ -176,7 +176,7 @@ jobs:
       matrix:
         extension: ['tar.gz', 'whl']
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
           python-version: "3.10"
@@ -195,7 +195,7 @@ jobs:
       matrix:
         python-version: ['3.10', '3.11', '3.12', '3.13', '3.14', 'pypy-3.10', 'pypy-3.11']
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}

.github/workflows/pypi-publish.yaml

@@ -13,7 +13,7 @@ jobs:
   build_and_package:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: install python
         uses: actions/setup-python@v6
         with:

.github/workflows/spellcheck.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Check Spelling
-        uses: rojopolis/spellcheck-github-actions@0.53.0
+        uses: rojopolis/spellcheck-github-actions@0.55.0
         with:
           config_path: .github/spellcheck-settings.yml
           task_name: Markdown

docker-compose.yml

@@ -1,10 +1,10 @@
 ---
 # image tag 8.0-RC2-pre is the one matching the 8.0 GA release
 x-client-libs-stack-image: &client-libs-stack-image
-  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_STACK_IMAGE_TAG:-8.4-RC1-pre.2}"
+  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_STACK_IMAGE_TAG:-8.4.0}"
 
 x-client-libs-image: &client-libs-image
-  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_IMAGE_TAG:-8.4-RC1-pre.2}"
+  image: "redislabs/client-libs-test:${CLIENT_LIBS_TEST_IMAGE_TAG:-8.4.0}"
 
 services:
 

docs/multi_database.rst

@@ -315,7 +315,7 @@ reverse proxy behind an actual REST API endpoint.
                 health_check_url="https://cluster.example.com",
             ),
         ],
-        # Add custom checks (in addition to default PingHealthCheck)
+        # Add custom health check to replace the default
         health_checks=[
             # Redis Enterprise REST-based lag-aware check
             LagAwareHealthCheck(
@@ -412,6 +412,51 @@ To enable periodic fallback to a higher-priority healthy database, set `auto_fal
     )
     client = MultiDBClient(cfg)
 
+
+Custom failover callbacks
+-------------------------
+
+You may want to activate custom actions when failover happens. For example, you may want to collect some metrics,
+logs or externally persist a connection state.
+
+You can register your own event listener for the `ActiveDatabaseChanged` event (which is emitted when a failover happens) using
+the `EventDispatcher`.
+
+.. code-block:: python
+
+    class LogFailoverEventListener(EventListenerInterface):
+        def __init__(self, logger: Logger):
+            self.logger = logger
+
+        def listen(self, event: ActiveDatabaseChanged):
+            self.logger.warning(
+                f"Failover happened. Active database switched from {event.old_database} to {event.new_database}"
+            )
+
+    event_dispatcher = EventDispatcher()
+    listener = LogFailoverEventListener(logging.getLogger(__name__))
+
+    # Register custom listener
+    event_dispatcher.register_listeners(
+        {
+            ActiveDatabaseChanged: [listener],
+        }
+    )
+
+    config = MultiDbConfig(
+        client_class=client_class,
+        databases_config=db_configs,
+        command_retry=command_retry,
+        min_num_failures=min_num_failures,
+        health_check_probes=3,
+        health_check_interval=health_check_interval,
+        event_dispatcher=event_dispatcher,
+        health_check_probes_delay=health_check_delay,
+    )
+
+    client = MultiDBClient(config)
+
+
 Managing databases at runtime
 -----------------------------
 

redis/asyncio/client.py

@@ -126,12 +126,12 @@ class Redis(
 
     @classmethod
     def from_url(
-        cls: type[_RedisT],
+        cls: Type["Redis"],
         url: str,
         single_connection_client: bool = False,
         auto_close_connection_pool: Optional[bool] = None,
         **kwargs,
-    ) -> _RedisT:
+    ) -> "Redis":
         """
         Return a Redis client object configured from the given URL