redis 5.3.0b5__tar.gz → 6.0.0b2__tar.gz

redis-6.0.0b2/.gitignore

@@ -0,0 +1,28 @@
+*.pyc
+redis.egg-info
+build/
+dist/
+dump.rdb
+_build
+vagrant/.vagrant
+.python-version
+.cache
+.eggs
+.idea
+.coverage
+env
+venv
+coverage.xml
+.venv*
+*.xml
+.coverage*
+prof
+profile_output*
+docker/stunnel/keys
+/dockers/*/node-*/*
+/dockers/*/tls/*
+/dockers/standalone/
+/dockers/cluster/
+/dockers/replica/
+/dockers/sentinel/
+/dockers/redis-stack/

{redis-5.3.0b5/redis.egg-info → redis-6.0.0b2}/PKG-INFO

@@ -1,17 +1,16 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: redis
-Version: 5.3.0b5
+Version: 6.0.0b2
 Summary: Python client for Redis database and key-value store
-Home-page: https://github.com/redis/redis-py
-Author: Redis Inc.
-Author-email: oss@redis.com
-License: MIT
-Project-URL: Documentation, https://redis.readthedocs.io/en/latest/
 Project-URL: Changes, https://github.com/redis/redis-py/releases
 Project-URL: Code, https://github.com/redis/redis-py
+Project-URL: Documentation, https://redis.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/redis/redis-py
 Project-URL: Issue tracker, https://github.com/redis/redis-py/issues
-Keywords: Redis,key-value store,database
-Platform: UNKNOWN
+Author-email: "Redis Inc." <oss@redis.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Redis,database,key-value-store
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -25,13 +24,20 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
-Description-Content-Type: text/markdown
+Requires-Dist: async-timeout>=4.0.3; python_full_version < '3.11.3'
 Provides-Extra: hiredis
+Requires-Dist: hiredis>=3.0.0; extra == 'hiredis'
+Provides-Extra: jwt
+Requires-Dist: pyjwt~=2.9.0; extra == 'jwt'
 Provides-Extra: ocsp
-License-File: LICENSE
+Requires-Dist: cryptography>=36.0.1; extra == 'ocsp'
+Requires-Dist: pyopenssl>=20.0.1; extra == 'ocsp'
+Requires-Dist: requests>=2.31.0; extra == 'ocsp'
+Description-Content-Type: text/markdown
 
 # redis-py
 
@@ -48,13 +54,13 @@ The Python interface to the Redis key-value store.
 
 ---------------------------------------------
 
-**Note: ** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
+**Note:** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
 
 ---------------------------------------------
 
 ## How do I Redis?
 
-[Learn for free at Redis University](https://redis.io/university/)
+[Learn for free at Redis University](https://redis.io/learn/university)
 
 [Try the Redis Cloud](https://redis.io/try-free/)
 
@@ -89,7 +95,7 @@ Looking for a high-level library to handle object mapping? See [redis-om-python]
 
 ## Supported Redis Versions
 
-The most recent version of this library supports redis version [5.0](https://github.com/redis/redis/blob/5.0/00-RELEASENOTES), [6.0](https://github.com/redis/redis/blob/6.0/00-RELEASENOTES), [6.2](https://github.com/redis/redis/blob/6.2/00-RELEASENOTES), [7.0](https://github.com/redis/redis/blob/7.0/00-RELEASENOTES), [7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES) and [7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES).
+The most recent version of this library supports redis version [7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES), [7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES) and [8.0](https://github.com/redis/redis/blob/8.0/00-RELEASENOTES).
 
 The table below highlights version compatibility of the most-recent library versions and redis versions.
 
@@ -97,7 +103,8 @@ The table below highlights version compatibility of the most-recent library vers
 |-----------------|-------------------|
 | 3.5.3 | <= 6.2 Family of releases |
 | >= 4.5.0 | Version 5.0 to 7.0 |
-| >= 5.0.0 | Version 5.0 to current |
+| >= 5.0.0 | Version 5.0 to 7.4 |
+| >= 6.0.0 | Version 7.2 to current |
 
 
 ## Usage
@@ -187,8 +194,42 @@ The following example shows how to utilize [Redis Pub/Sub](https://redis.io/docs
 {'pattern': None, 'type': 'subscribe', 'channel': b'my-second-channel', 'data': 1}
 ```
 
+### Redis’ search and query capabilities default dialect
+
+Release 6.0.0 introduces a client-side default dialect for Redis’ search and query capabilities.  
+By default, the client now overrides the server-side dialect with version 2, automatically appending *DIALECT 2* to commands like *FT.AGGREGATE* and *FT.SEARCH*.  
 
---------------------------
+**Important**: Be aware that the query dialect may impact the results returned. If needed, you can revert to a different dialect version by configuring the client accordingly.
+
+``` python
+>>> from redis.commands.search.field import TextField
+>>> from redis.commands.search.query import Query
+>>> from redis.commands.search.index_definition import IndexDefinition
+>>> import redis
+
+>>> r = redis.Redis(host='localhost', port=6379, db=0)
+>>> r.ft().create_index(
+>>>     (TextField("name"), TextField("lastname")),
+>>>     definition=IndexDefinition(prefix=["test:"]),
+>>> )
+
+>>> r.hset("test:1", "name", "James")
+>>> r.hset("test:1", "lastname", "Brown")
+
+>>> # Query with default DIALECT 2
+>>> query = "@name: James Brown"
+>>> q = Query(query)
+>>> res = r.ft().search(q)
+
+>>> # Query with explicit DIALECT 1
+>>> query = "@name: James Brown"
+>>> q = Query(query).dialect(1)
+>>> res = r.ft().search(q)
+```
+
+You can find further details in the [query dialect documentation](https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/).
+
+---------------------------------------------
 
 ### Author
 
@@ -205,4 +246,3 @@ Special thanks to:
 -   Paul Hubbard for initial packaging support.
 
 [![Redis](./docs/_static/logo-redis.svg)](https://redis.io)
-

{redis-5.3.0b5 → redis-6.0.0b2}/README.md

@@ -13,13 +13,13 @@ The Python interface to the Redis key-value store.
 
 ---------------------------------------------
 
-**Note: ** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
+**Note:** redis-py 5.0 will be the last version of redis-py to support Python 3.7, as it has reached [end of life](https://devguide.python.org/versions/). redis-py 5.1 will support Python 3.8+.
 
 ---------------------------------------------
 
 ## How do I Redis?
 
-[Learn for free at Redis University](https://redis.io/university/)
+[Learn for free at Redis University](https://redis.io/learn/university)
 
 [Try the Redis Cloud](https://redis.io/try-free/)
 
@@ -54,7 +54,7 @@ Looking for a high-level library to handle object mapping? See [redis-om-python]
 
 ## Supported Redis Versions
 
-The most recent version of this library supports redis version [5.0](https://github.com/redis/redis/blob/5.0/00-RELEASENOTES), [6.0](https://github.com/redis/redis/blob/6.0/00-RELEASENOTES), [6.2](https://github.com/redis/redis/blob/6.2/00-RELEASENOTES), [7.0](https://github.com/redis/redis/blob/7.0/00-RELEASENOTES), [7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES) and [7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES).
+The most recent version of this library supports redis version [7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES), [7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES) and [8.0](https://github.com/redis/redis/blob/8.0/00-RELEASENOTES).
 
 The table below highlights version compatibility of the most-recent library versions and redis versions.
 
@@ -62,7 +62,8 @@ The table below highlights version compatibility of the most-recent library vers
 |-----------------|-------------------|
 | 3.5.3 | <= 6.2 Family of releases |
 | >= 4.5.0 | Version 5.0 to 7.0 |
-| >= 5.0.0 | Version 5.0 to current |
+| >= 5.0.0 | Version 5.0 to 7.4 |
+| >= 6.0.0 | Version 7.2 to current |
 
 
 ## Usage
@@ -152,8 +153,42 @@ The following example shows how to utilize [Redis Pub/Sub](https://redis.io/docs
 {'pattern': None, 'type': 'subscribe', 'channel': b'my-second-channel', 'data': 1}
 ```
 
+### Redis’ search and query capabilities default dialect
 
---------------------------
+Release 6.0.0 introduces a client-side default dialect for Redis’ search and query capabilities.  
+By default, the client now overrides the server-side dialect with version 2, automatically appending *DIALECT 2* to commands like *FT.AGGREGATE* and *FT.SEARCH*.  
+
+**Important**: Be aware that the query dialect may impact the results returned. If needed, you can revert to a different dialect version by configuring the client accordingly.
+
+``` python
+>>> from redis.commands.search.field import TextField
+>>> from redis.commands.search.query import Query
+>>> from redis.commands.search.index_definition import IndexDefinition
+>>> import redis
+
+>>> r = redis.Redis(host='localhost', port=6379, db=0)
+>>> r.ft().create_index(
+>>>     (TextField("name"), TextField("lastname")),
+>>>     definition=IndexDefinition(prefix=["test:"]),
+>>> )
+
+>>> r.hset("test:1", "name", "James")
+>>> r.hset("test:1", "lastname", "Brown")
+
+>>> # Query with default DIALECT 2
+>>> query = "@name: James Brown"
+>>> q = Query(query)
+>>> res = r.ft().search(q)
+
+>>> # Query with explicit DIALECT 1
+>>> query = "@name: James Brown"
+>>> q = Query(query).dialect(1)
+>>> res = r.ft().search(q)
+```
+
+You can find further details in the [query dialect documentation](https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/).
+
+---------------------------------------------
 
 ### Author
 

redis-6.0.0b2/dev_requirements.txt

@@ -0,0 +1,16 @@
+build
+click==8.0.4
+invoke==2.2.0
+mock
+packaging>=20.4
+pytest
+pytest-asyncio>=0.23.0
+pytest-cov
+pytest-profiling==1.8.1
+pytest-timeout
+ruff==0.9.6
+ujson>=4.2.0
+uvloop
+vulture>=2.3.0
+numpy>=1.24.0
+redis-entraid==0.4.0b2

redis-6.0.0b2/pyproject.toml

@@ -0,0 +1,124 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "redis"
+dynamic = ["version"]
+description = "Python client for Redis database and key-value store"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [{ name = "Redis Inc.", email = "oss@redis.com" }]
+keywords = ["Redis", "database", "key-value-store"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = ['async-timeout>=4.0.3; python_full_version<"3.11.3"']
+
+[project.optional-dependencies]
+hiredis = [
+    "hiredis>=3.0.0",
+]
+ocsp = [
+    "cryptography>=36.0.1",
+    "pyopenssl>=20.0.1",
+    "requests>=2.31.0",
+]
+jwt = [
+    "PyJWT~=2.9.0",
+]
+
+[project.urls]
+Changes = "https://github.com/redis/redis-py/releases"
+Code = "https://github.com/redis/redis-py"
+Documentation = "https://redis.readthedocs.io/en/latest/"
+Homepage = "https://github.com/redis/redis-py"
+"Issue tracker" = "https://github.com/redis/redis-py/issues"
+
+[tool.hatch.version]
+path = "redis/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = ["/redis", "/tests", "dev_requirements.txt"]
+
+[tool.hatch.build.targets.wheel]
+include = ["/redis"]
+
+[tool.pytest.ini_options]
+addopts = "-s"
+markers = [
+    "redismod: run only the redis module tests",
+    "pipeline: pipeline tests",
+    "onlycluster: marks tests to be run only with cluster mode redis",
+    "onlynoncluster: marks tests to be run only with standalone redis",
+    "ssl: marker for only the ssl tests",
+    "asyncio: marker for async tests",
+    "replica: replica tests",
+    "experimental: run only experimental tests",
+    "cp_integration: credential provider integration tests",
+]
+asyncio_default_fixture_loop_scope = "function"
+asyncio_mode = "auto"
+timeout = 30
+filterwarnings = [
+    "always",
+    # Ignore a coverage warning when COVERAGE_CORE=sysmon for Pythons < 3.12.
+    "ignore:sys.monitoring isn't available:coverage.exceptions.CoverageWarning",
+]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 88
+exclude = [
+    "*.egg-info",
+    "*.pyc",
+    ".git",
+    ".venv*",
+    "build",
+    "dist",
+    "docker",
+    "docs/*",
+    "doctests/*",
+    "tasks.py",
+    "venv*",
+    "whitelist.py",
+]
+
+[tool.ruff.lint]
+ignore = [
+    "E501", # line too long (taken care of with ruff format)
+    "E741", # ambiguous variable name
+    "N818", # Errors should have Error suffix
+]
+
+select = ["E", "F", "FLY", "I", "N", "W"]
+
+[tool.ruff.lint.per-file-ignores]
+"redis/commands/bf/*" = [
+    # the `bf` module uses star imports, so this is required there.
+    "F405", # name may be undefined, or defined from star imports
+]
+"redis/commands/{bf,timeseries,json,search}/*" = ["N"]
+"tests/*" = [
+    "I",    # TODO: could be enabled, plenty of changes
+    "N801", # class name should use CapWords convention
+    "N803", # argument name should be lowercase
+    "N802", # function name should be lowercase
+    "N806", # variable name should be lowercase
+]

{redis-5.3.0b5 → redis-6.0.0b2}/redis/__init__.py

@@ -1,5 +1,3 @@
-from importlib import metadata
-
 from redis import asyncio  # noqa
 from redis.backoff import default_backoff
 from redis.client import Redis, StrictRedis
@@ -44,16 +42,9 @@ def int_or_str(value):
         return value
 
 
-try:
-    __version__ = metadata.version("redis")
-except metadata.PackageNotFoundError:
-    __version__ = "99.99.99"
-
+__version__ = "6.0.0b2"
+VERSION = tuple(map(int_or_str, __version__.split(".")))
 
-try:
-    VERSION = tuple(map(int_or_str, __version__.split(".")))
-except AttributeError:
-    VERSION = tuple([99, 99, 99])
 
 __all__ = [
     "AuthenticationError",

{redis-5.3.0b5 → redis-6.0.0b2}/redis/_parsers/base.py

@@ -9,26 +9,32 @@ else:
     from async_timeout import timeout as async_timeout
 
 from ..exceptions import (
+    AskError,
     AuthenticationError,
     AuthenticationWrongNumberOfArgsError,
     BusyLoadingError,
+    ClusterCrossSlotError,
+    ClusterDownError,
     ConnectionError,
     ExecAbortError,
+    MasterDownError,
     ModuleError,
+    MovedError,
     NoPermissionError,
     NoScriptError,
     OutOfMemoryError,
     ReadOnlyError,
     RedisError,
     ResponseError,
+    TryAgainError,
 )
 from ..typing import EncodableT
 from .encoders import Encoder
 from .socket import SERVER_CLOSED_CONNECTION_ERROR, SocketBuffer
 
-MODULE_LOAD_ERROR = "Error loading the extension. " "Please check the server logs."
+MODULE_LOAD_ERROR = "Error loading the extension. Please check the server logs."
 NO_SUCH_MODULE_ERROR = "Error unloading module: no such module with that name"
-MODULE_UNLOAD_NOT_POSSIBLE_ERROR = "Error unloading module: operation not " "possible."
+MODULE_UNLOAD_NOT_POSSIBLE_ERROR = "Error unloading module: operation not possible."
 MODULE_EXPORTS_DATA_TYPES_ERROR = (
     "Error unloading module: the module "
     "exports one or more module-side data "
@@ -72,6 +78,12 @@ class BaseParser(ABC):
         "READONLY": ReadOnlyError,
         "NOAUTH": AuthenticationError,
         "NOPERM": NoPermissionError,
+        "ASK": AskError,
+        "TRYAGAIN": TryAgainError,
+        "MOVED": MovedError,
+        "CLUSTERDOWN": ClusterDownError,
+        "CROSSSLOT": ClusterCrossSlotError,
+        "MASTERDOWN": MasterDownError,
     }
 
     @classmethod

{redis-5.3.0b5 → redis-6.0.0b2}/redis/asyncio/client.py

@@ -2,7 +2,6 @@ import asyncio
 import copy
 import inspect
 import re
-import ssl
 import warnings
 from typing import (
     TYPE_CHECKING,
@@ -72,13 +71,21 @@ from redis.exceptions import (
 from redis.typing import ChannelT, EncodableT, KeyT
 from redis.utils import (
     HIREDIS_AVAILABLE,
+    SSL_AVAILABLE,
     _set_info_logger,
     deprecated_function,
     get_lib_version,
     safe_str,
     str_if_bytes,
+    truncate_text,
 )
 
+if TYPE_CHECKING and SSL_AVAILABLE:
+    from ssl import TLSVersion, VerifyMode
+else:
+    TLSVersion = None
+    VerifyMode = None
+
 PubSubHandler = Callable[[Dict[str, str]], Awaitable[None]]
 _KeyT = TypeVar("_KeyT", bound=KeyT)
 _ArgT = TypeVar("_ArgT", KeyT, EncodableT)
@@ -222,11 +229,11 @@ class Redis(
         ssl: bool = False,
         ssl_keyfile: Optional[str] = None,
         ssl_certfile: Optional[str] = None,
-        ssl_cert_reqs: str = "required",
+        ssl_cert_reqs: Union[str, VerifyMode] = "required",
         ssl_ca_certs: Optional[str] = None,
         ssl_ca_data: Optional[str] = None,
         ssl_check_hostname: bool = False,
-        ssl_min_version: Optional[ssl.TLSVersion] = None,
+        ssl_min_version: Optional[TLSVersion] = None,
         ssl_ciphers: Optional[str] = None,
         max_connections: Optional[int] = None,
         single_connection_client: bool = False,
@@ -375,7 +382,7 @@ class Redis(
         if self.single_connection_client:
             async with self._single_conn_lock:
                 if self.connection is None:
-                    self.connection = await self.connection_pool.get_connection("_")
+                    self.connection = await self.connection_pool.get_connection()
 
             self._event_dispatcher.dispatch(
                 AfterSingleConnectionInstantiationEvent(
@@ -478,6 +485,7 @@ class Redis(
         blocking_timeout: Optional[float] = None,
         lock_class: Optional[Type[Lock]] = None,
         thread_local: bool = True,
+        raise_on_release_error: bool = True,
     ) -> Lock:
         """
         Return a new Lock object using key ``name`` that mimics
@@ -524,6 +532,11 @@ class Redis(
                      thread-1 would see the token value as "xyz" and would be
                      able to successfully release the thread-2's lock.
 
+        ``raise_on_release_error`` indicates whether to raise an exception when
+        the lock is no longer owned when exiting the context manager. By default,
+        this is True, meaning an exception will be raised. If False, the warning
+        will be logged and the exception will be suppressed.
+
         In some use cases it's necessary to disable thread local storage. For
         example, if you have code where one thread acquires a lock and passes
         that lock instance to a worker thread to release later. If thread
@@ -541,6 +554,7 @@ class Redis(
             blocking=blocking,
             blocking_timeout=blocking_timeout,
             thread_local=thread_local,
+            raise_on_release_error=raise_on_release_error,
         )
 
     def pubsub(self, **kwargs) -> "PubSub":
@@ -638,7 +652,7 @@ class Redis(
         await self.initialize()
         pool = self.connection_pool
         command_name = args[0]
-        conn = self.connection or await pool.get_connection(command_name, **options)
+        conn = self.connection or await pool.get_connection()
 
         if self.single_connection_client:
             await self._single_conn_lock.acquire()
@@ -712,7 +726,7 @@ class Monitor:
 
     async def connect(self):
         if self.connection is None:
-            self.connection = await self.connection_pool.get_connection("MONITOR")
+            self.connection = await self.connection_pool.get_connection()
 
     async def __aenter__(self):
         await self.connect()
@@ -900,9 +914,7 @@ class PubSub:
         Ensure that the PubSub is connected
         """
         if self.connection is None:
-            self.connection = await self.connection_pool.get_connection(
-                "pubsub", self.shard_hint
-            )
+            self.connection = await self.connection_pool.get_connection()
             # register a callback that re-subscribes to any channels we
             # were listening to when we were disconnected
             self.connection.register_connect_callback(self.on_connect)
@@ -1370,9 +1382,7 @@ class Pipeline(Redis):  # lgtm [py/init-calls-subclass]
         conn = self.connection
         # if this is the first call, we need a connection
         if not conn:
-            conn = await self.connection_pool.get_connection(
-                command_name, self.shard_hint
-            )
+            conn = await self.connection_pool.get_connection()
             self.connection = conn
 
         return await conn.retry.call_with_retry(
@@ -1505,7 +1515,10 @@ class Pipeline(Redis):  # lgtm [py/init-calls-subclass]
         self, exception: Exception, number: int, command: Iterable[object]
     ) -> None:
         cmd = " ".join(map(safe_str, command))
-        msg = f"Command # {number} ({cmd}) of pipeline caused error: {exception.args}"
+        msg = (
+            f"Command # {number} ({truncate_text(cmd)}) "
+            "of pipeline caused error: {exception.args}"
+        )
         exception.args = (msg,) + exception.args[1:]
 
     async def parse_response(
@@ -1568,7 +1581,7 @@ class Pipeline(Redis):  # lgtm [py/init-calls-subclass]
 
         conn = self.connection
         if not conn:
-            conn = await self.connection_pool.get_connection("MULTI", self.shard_hint)
+            conn = await self.connection_pool.get_connection()
             # assign to self.connection so reset() releases the connection
             # back to the pool after we're done
             self.connection = conn