Merge branch 'master' into patch-1

Author: willfrey

.flake8

@@ -16,6 +16,7 @@ exclude =
 ignore =
     E126
     E203
+    E231
     E701
     E704
     F405

.github/wordlist.txt

@@ -141,3 +141,4 @@ unicode
 url
 virtualenv
 www
+yaml

.github/workflows/integration.yaml

@@ -25,8 +25,10 @@ permissions:
 
 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_STACK_IMAGE: redis/redis-stack-server:7.4.0-rc2
+  REDIS_STACK_IMAGE: redis/redis-stack-server:latest
 
 jobs:
   dependency-audit:
@@ -54,26 +56,28 @@ jobs:
           pip install -r dev_requirements.txt
           invoke linters
 
-  run-tests:
+  resp2-tests:
     runs-on: ubuntu-latest
     timeout-minutes: 60
     strategy:
       max-parallel: 15
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', 'pypy-3.8', 'pypy-3.9']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.8', 'pypy-3.9']
         test-type: ['standalone', 'cluster']
         connection-type: ['hiredis', 'plain']
     env:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-    name: Python ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}} tests
+    name: RESP2 ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
-      - name: run tests
+
+      - name: Run tests
         run: |
           pip install -U setuptools wheel
           pip install -r requirements.txt
@@ -84,52 +88,48 @@ jobs:
           invoke devenv
           sleep 10 # time to settle
           invoke ${{matrix.test-type}}-tests
+          ls -1
 
-      - uses: actions/upload-artifact@v4
-        if: success() || failure()
+      - name: Upload test results and profiling data
+        uses: actions/upload-artifact@v4
         with:
           name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}
-          path: '${{matrix.test-type}}*results.xml'
+          path: |
+            ${{matrix.test-type}}*-results.xml
+            prof/**
+            profile_output*
+          if-no-files-found: error
+          retention-days: 10
 
       - 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}}
-          path: '*.xml'
-          reporter: java-junit
-          list-suites: all
-          list-tests: all
-          max-annotations: 10
-          fail-on-error: 'false'
-
-  resp3_tests:
+  resp3-tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.11']
+        python-version: ['3.8', '3.12']
         test-type: ['standalone', 'cluster']
         connection-type: ['hiredis', 'plain']
+        event-loop: ['asyncio', 'uvloop']
         exclude:
           - test-type: 'cluster'
             connection-type: 'hiredis'
     env:
       ACTIONS_ALLOW_UNSECURE_COMMANDS: true
-    name: RESP3 [${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}]
+    name: RESP3 ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.event-loop}}
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
-      - name: run tests
+
+      - name: Run tests
         run: |
           pip install -U setuptools wheel
           pip install -r requirements.txt
@@ -139,37 +139,32 @@ jobs:
           fi
           invoke devenv
           sleep 10 # time to settle
-          invoke ${{matrix.test-type}}-tests --protocol=3
-          invoke ${{matrix.test-type}}-tests --uvloop --protocol=3
+          if [ "${{matrix.event-loop}}" == "uvloop" ]; then
+            invoke ${{matrix.test-type}}-tests --uvloop --protocol=3
+          else
+            invoke ${{matrix.test-type}}-tests --protocol=3
+          fi
 
-      - uses: actions/upload-artifact@v4
-        if: success() || failure()
+      - name: Upload test results and profiling data
+        uses: actions/upload-artifact@v4
         with:
-          name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}-resp3
-          path: '${{matrix.test-type}}*results.xml'
+          name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}-${{matrix.event-loop}}-resp3
+          path: |
+            ${{matrix.test-type}}*-results.xml
+            prof/**
+            profile_output*
+          if-no-files-found: error
+          retention-days: 10
 
       - 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:
+  build-and-test-package:
     name: Validate building and installing the package
     runs-on: ubuntu-latest
-    needs: [run-tests]
+    needs: [resp2-tests, resp3-tests]
     strategy:
       fail-fast: false
       matrix:
@@ -183,13 +178,13 @@ jobs:
         run: |
           bash .github/workflows/install_and_test.sh ${{ matrix.extension }}
 
-  install_package_from_commit:
+  install-package-from-commit:
     name: Install package from commit hash
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', 'pypy-3.8', 'pypy-3.9']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.8', 'pypy-3.9']
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.gitignore

@@ -16,4 +16,6 @@ coverage.xml
 .venv*
 *.xml
 .coverage*
+prof
+profile_output*
 docker/stunnel/keys

CHANGES

@@ -65,6 +65,8 @@
     * Make `ClusterCommandsProtocol` an actual Protocol
     * Add `sum` to DUPLICATE_POLICY documentation of `TS.CREATE`, `TS.ADD` and `TS.ALTER`
     * Prevent async ClusterPipeline instances from becoming "false-y" in case of empty command stack (#3061)
+    * Close Unix sockets if the connection attempt fails. This prevents `ResourceWarning`s. (#3314)
+    * Close SSL sockets if the connection attempt fails, or if validations fail. (#3317)
 
 * 4.1.3 (Feb 8, 2022)
   * Fix flushdb and flushall (#1926)

dev_requirements.txt

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

docs/conf.py

@@ -128,7 +128,6 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "display_version": True,
     "footer_icons": [
         {
             "name": "GitHub",

docs/connections.rst

@@ -55,7 +55,7 @@ ClusterNode
 Async Client
 ************
 
-See complete example: `here <examples/asyncio_examples.html>`_
+See complete example: `here <examples/asyncio_examples.html>`__
 
 This client is used for communicating with Redis, asynchronously.
 
@@ -88,7 +88,7 @@ ClusterPipeline (Async)
 Connection
 **********
 
-See complete example: `here <examples/connection_examples.html>`_
+See complete example: `here <examples/connection_examples.html>`__
 
 Connection
 ==========
@@ -104,7 +104,7 @@ Connection (Async)
 Connection Pools
 ****************
 
-See complete example: `here <examples/connection_examples.html>`_
+See complete example: `here <examples/connection_examples.html>`__
 
 ConnectionPool
 ==============

docs/examples/search_vector_similarity_examples.ipynb

@@ -4,7 +4,7 @@ Integrating OpenTelemetry
 What is OpenTelemetry?
 ----------------------
 
-`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for traces, metrics, and logs. It is a merger of OpenCensus and OpenTracing projects hosted by Cloud Native Computing Foundation.
+`OpenTelemetry <https://opentelemetry.io>`__ is an open-source observability framework for traces, metrics, and logs. It is a merger of OpenCensus and OpenTracing projects hosted by Cloud Native Computing Foundation.
 
 OpenTelemetry allows developers to collect and export telemetry data in a vendor agnostic way. With OpenTelemetry, you can instrument your application once and then add or change vendors without changing the instrumentation, for example, here is a list of `popular DataDog competitors <https://uptrace.dev/get/compare/datadog-competitors.html>`_ that support OpenTelemetry.
 
@@ -61,7 +61,7 @@ Once the code is patched, you can use redis-py as usually:
 OpenTelemetry API
 -----------------
 
-`OpenTelemetry <https://uptrace.dev/opentelemetry/>`_ API is a programming interface that you can use to instrument code and collect telemetry data such as traces, metrics, and logs.
+`OpenTelemetry API <https://uptrace.dev/opentelemetry/>`__ is a programming interface that you can use to instrument code and collect telemetry data such as traces, metrics, and logs.
 
 You can use OpenTelemetry API to measure important operations:
 
@@ -125,7 +125,7 @@ Alerting and notifications
 
 Uptrace also allows you to monitor `OpenTelemetry metrics <https://uptrace.dev/opentelemetry/metrics.html>`_ using alerting rules. For example, the following monitor uses the group by node expression to create an alert whenever an individual Redis shard is down:
 
-.. code-block:: python
+.. code-block:: yaml
 
    monitors:
      - name: Redis shard is down
@@ -142,7 +142,7 @@ Uptrace also allows you to monitor `OpenTelemetry metrics <https://uptrace.dev/o
 
 You can also create queries with more complex expressions. For example, the following rule creates an alert when the keyspace hit rate is lower than 75%:
 
-.. code-block:: python
+.. code-block:: yaml
 
    monitors:
      - name: Redis read hit rate < 75%