Merge branch 'master' into add-cluster-scripting

Author: dvora-h

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,7 @@ _Please make sure to review and check all of these items:_
 - [ ] Is the new or changed code fully tested?
 - [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
 - [ ] Is there an example added to the examples folder (if applicable)?
+- [ ] Is the changes added to CHANGES file?
 
 _NOTE: these things are not required to open a PR and can be done
 afterwards / while the PR is open._

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,68 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/integration.yaml

@@ -8,9 +8,11 @@ on:
       - '**/*.md'
     branches:
       - master
+      - '[0-9].[0-9]'
   pull_request:
     branches:
       - master
+      - '[0-9].[0-9]'
 
 jobs:
 
@@ -34,7 +36,7 @@ jobs:
      strategy:
        max-parallel: 15
        matrix:
-         python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
+         python-version: ['3.6','3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
          test-type: ['standalone', 'cluster']
          connection-type: ['hiredis', 'plain']
      env:
@@ -48,6 +50,7 @@ jobs:
            python-version: ${{ matrix.python-version }}
        - name: run tests
          run: |
+           pip install -U setuptools wheel
            pip install -r dev_requirements.txt
            tox -e ${{matrix.test-type}}-${{matrix.connection-type}}
        - name: Upload codecov coverage
@@ -77,7 +80,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
+        python-version: ['3.7', '3.8', '3.9', '3.10', 'pypy-3.7']
     steps:
       - uses: actions/checkout@v2
       - name: install python ${{ matrix.python-version }}

.github/workflows/update-changes.yaml

@@ -14,7 +14,7 @@ vagrant/.vagrant
 env
 venv
 coverage.xml
-.venv
+.venv*
 *.xml
 .coverage*
 docker/stunnel/keys

.gitignore

@@ -0,0 +1,24 @@
+[mypy]
+#, docs/examples, tests
+files = redis
+check_untyped_defs = True
+follow_imports_for_stubs asyncio.= True
+#disallow_any_decorated = True
+disallow_subclassing_any = True
+#disallow_untyped_calls = True
+disallow_untyped_decorators = True
+#disallow_untyped_defs = True
+implicit_reexport = False
+no_implicit_optional = True
+show_error_codes = True
+strict_equality = True
+warn_incomplete_stub = True
+warn_redundant_casts = True
+warn_unreachable = True
+warn_unused_ignores = True
+disallow_any_unimported = True
+#warn_return_any = True
+
+[mypy-redis.asyncio.lock]
+# TODO: Remove once locks has been rewritten
+ignore_errors = True

.mypy.ini

@@ -1,3 +1,4 @@
+	* Create codeql-analysis.yml (#1988). Thanks @chayim
 * 4.1.3 (Feb 8, 2022)
   * Fix flushdb and flushall (#1926)
   * Add redis5 and redis4 dockers (#1871)

CHANGES

@@ -112,12 +112,12 @@ You can see the logging output of a containers like this:
 `$ docker logs -f <service>`
 
 The command make test runs all tests in all tested Python
-environments. To run the tests in a single environment, like Python 3.6,
+environments. To run the tests in a single environment, like Python 3.9,
 use a command like this:
 
-`$ docker-compose run test tox -e py36 -- --redis-url=redis://master:6379/9`
+`$ docker-compose run test tox -e py39 -- --redis-url=redis://master:6379/9`
 
-Here, the flag `-e py36` runs tests against the Python 3.6 tox
+Here, the flag `-e py39` runs tests against the Python 3.9 tox
 environment. And note from the example that whenever you run tests like
 this, instead of using make test, you need to pass
 `-- --redis-url=redis://master:6379/9`. This points the tests at the

CONTRIBUTING.md

@@ -13,6 +13,11 @@ The Python interface to the Redis key-value store.
 
 ---------------------------------------------
 
+## Python Notice
+
+redis-py 4.2.x will be the last generation of redis-py to support python 3.6 as it has been [End of Life'd](https://www.python.org/dev/peps/pep-0494/#schedule-last-security-only-release).  Async support was introduced in redis-py 4.2.x thanks to [aioredis](https://github.com/aio-libs/aioredis-py), which necessitates this change. We will continue to maintain 3.6 support as long as possible - but the plan is for redis-py version 5+ to offically remove 3.6.
+
+---------------------------
 
 ## Installation
 
@@ -51,7 +56,7 @@ contributing](https://github.com/redis/redis-py/blob/master/CONTRIBUTING.md).
 
 ## Getting Started
 
-redis-py supports Python 3.6+.
+redis-py supports Python 3.7+.
 
 ``` pycon
 >>> import redis
@@ -1206,7 +1211,7 @@ Please note:
 - The pipeline gets its 'read_from_replicas' value from the cluster's parameter.
 Thus, if read from replications is enabled in the cluster instance, the pipeline
 will also direct read commands to replicas.
-- The 'transcation' option is NOT supported in cluster-mode. In non-cluster mode,
+- The 'transaction' option is NOT supported in cluster-mode. In non-cluster mode,
 the 'transaction' option is available when executing pipelines. This wraps the
 pipeline commands with MULTI/EXEC commands, and effectively turns the pipeline
 commands into a single transaction block. This means that all commands are

README.md

@@ -2,12 +2,15 @@ black==21.11b1
 flake8==4.0.1
 flynt~=0.69.0
 isort==5.10.1
+mock==4.0.3
 pytest==6.2.5
 pytest-timeout==2.0.1
+pytest-asyncio>=0.16.0
 tox==3.24.4
 tox-docker==3.1.0
 invoke==1.6.0
 pytest-cov>=3.0.0
 vulture>=2.3.0
 ujson>=4.2.0
 wheel>=0.30.0
+uvloop

dev_requirements.txt

@@ -42,4 +42,14 @@ Connection Pools
 .. autoclass:: redis.connection.ConnectionPool
     :members:
 
-More connection examples can be found `here <examples/connection_examples.html>`_.
+More connection examples can be found `here <examples/connection_examples.html>`_.
+
+Async Client
+************
+
+This client is used for communicating with Redis, asynchronously.
+
+.. autoclass:: redis.asyncio.connection.Connection
+    :members:
+
+More connection examples can be found `here <examples/asyncio_examples.html>`_

docs/connections.rst

@@ -7,5 +7,6 @@ Examples
 
    examples/connection_examples
    examples/ssl_connection_examples
+   examples/asyncio_examples
    examples/search_json_examples
    examples/set_and_get_examples