limits 5.0.0rc2__tar.gz → 5.1.0__tar.gz

{limits-5.0.0rc2 → limits-5.1.0}/HISTORY.rst

@@ -3,35 +3,34 @@
 Changelog
 =========
 
-v5.0.0rc2
----------
-Release Date: 2025-04-15
-
-* Compatibility
-
-  * Add back emcache as a non default implementation for memcached + asyncio
-  * Remove support for memcached < 1.5
-
-* Documentation
+v5.1.0
+------
+Release Date: 2025-04-23
 
-  * Improve presentation of benchmark documentation
+* Features
 
+  * Expose ``key_prefix`` constructor argument for all redis storage
+    implementations to simplify customizing the prefix used for all
+    keys created in redis.
 
-v5.0.0rc1
----------
-Release Date: 2025-04-09
+v5.0.0
+------
+Release Date: 2025-04-15
 
 * Backward incompatible changes
 
   * Dropped support for Fixed Window with Elastic Expiry strategy
   * Dropped support for etcd
-  * Replaced async support for memached from :pypi:`emcache` to :pypi`:memcachio`
+  * Changed the default implementation for async+memached from :pypi:`emcache`
+    to :pypi`:memcachio`
 
 * Performance
 
-  * Improved performance of in-memory moving window ``test`` and ``get_window_stats`` operations.
-  * Improved performance of redis moving window ``test`` and ``get_window_stats`` operations.
+  * Improved performance of redis moving window ``test`` and ``get_window_stats`` operations
+    especially when dealing with large rate limits.
   * Improved performance of mongodb moving window ``test`` and ``get_window_stats`` operations.
+  * Improved performance of in-memory moving window ``test`` and ``get_window_stats`` operations.
+  * Reduced load on event loop when expiring limits with async in-memory implementations
 
 v4.7.3
 ------
@@ -835,3 +834,5 @@ Release Date: 2015-01-08
 
 * Initial import of common rate limiting code from `Flask-Limiter <https://github.com/alisaifee/flask-limiter>`_
 
+
+

{limits-5.0.0rc2 → limits-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 5.0.0rc2
+Version: 5.1.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 License-File: LICENSE.txt
 Requires-Dist: deprecated>=1.2
-Requires-Dist: packaging<25,>=21
+Requires-Dist: packaging<26,>=21
 Requires-Dist: typing_extensions
 Provides-Extra: redis
 Requires-Dist: redis!=4.5.2,!=4.5.3,<6.0.0,>3; extra == "redis"

{limits-5.0.0rc2 → limits-5.1.0}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-15T12:47:18-0700",
+ "date": "2025-04-23T10:35:38-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "ca0e9ca30c696af1102471218171c07ce8ee7644",
- "version": "5.0.0rc2"
+ "full-revisionid": "2b76ea0a8aa2a37b2069ab5990e9ae180de6491f",
+ "version": "5.1.0"
 }
 '''  # END VERSION_JSON
 

{limits-5.0.0rc2 → limits-5.1.0}/limits/aio/storage/redis/__init__.py

@@ -51,6 +51,8 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         "valkey": Version("6.0"),
     }
     MODE: Literal["BASIC", "CLUSTER", "SENTINEL"] = "BASIC"
+    PREFIX = "LIMITS"
+
     bridge: RedisBridge
     storage_exceptions: tuple[Exception, ...]
     target_server: Literal["redis", "valkey"]
@@ -60,6 +62,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = PREFIX,
         **options: float | str | bool,
     ) -> None:
         """
@@ -86,6 +89,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
          - ``redispy``: :class:`redis.asyncio.client.Redis`
          - ``valkey``: :class:`valkey.asyncio.client.Valkey`
 
+        :param key_prefix: the prefix for each key created in redis
         :param options: all remaining keyword arguments are passed
          directly to the constructor of :class:`coredis.Redis` or :class:`redis.asyncio.client.Redis`
         :raise ConfigurationError: when the redis library is not available
@@ -97,12 +101,18 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         super().__init__(uri, wrap_exceptions=wrap_exceptions)
         self.options = options
         if self.target_server == "valkey" or implementation == "valkey":
-            self.bridge = ValkeyBridge(uri, self.dependencies["valkey"].module)
+            self.bridge = ValkeyBridge(
+                uri, self.dependencies["valkey"].module, key_prefix
+            )
         else:
             if implementation == "redispy":
-                self.bridge = RedispyBridge(uri, self.dependencies["redis"].module)
+                self.bridge = RedispyBridge(
+                    uri, self.dependencies["redis"].module, key_prefix
+                )
             else:
-                self.bridge = CoredisBridge(uri, self.dependencies["coredis"].module)
+                self.bridge = CoredisBridge(
+                    uri, self.dependencies["coredis"].module, key_prefix
+                )
         self.configure_bridge()
         self.bridge.register_scripts()
 
@@ -226,7 +236,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
     async def reset(self) -> int | None:
         """
         This function calls a Lua Script to delete keys prefixed with
-        ``self.PREFIX`` in blocks of 5000.
+        :paramref:`RedisStorage.key_prefix` in blocks of 5000.
 
         .. warning:: This operation was designed to be fast, but was not tested
            on a large production based system. Be careful with its usage as it
@@ -268,6 +278,7 @@ class RedisClusterStorage(RedisStorage):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = RedisStorage.PREFIX,
         **options: float | str | bool,
     ) -> None:
         """
@@ -283,6 +294,7 @@ class RedisClusterStorage(RedisStorage):
          - ``coredis``: :class:`coredis.RedisCluster`
          - ``redispy``: :class:`redis.asyncio.cluster.RedisCluster`
          - ``valkey``: :class:`valkey.asyncio.cluster.ValkeyCluster`
+        :param key_prefix: the prefix for each key created in redis
         :param options: all remaining keyword arguments are passed
          directly to the constructor of :class:`coredis.RedisCluster` or
          :class:`redis.asyncio.RedisCluster`
@@ -293,6 +305,7 @@ class RedisClusterStorage(RedisStorage):
             uri,
             wrap_exceptions=wrap_exceptions,
             implementation=implementation,
+            key_prefix=key_prefix,
             **options,
         )
 
@@ -303,8 +316,8 @@ class RedisClusterStorage(RedisStorage):
         """
         Redis Clusters are sharded and deleting across shards
         can't be done atomically. Because of this, this reset loops over all
-        keys that are prefixed with ``self.PREFIX`` and calls delete on them,
-        one at a time.
+        keys that are prefixed with :paramref:`RedisClusterStorage.key_prefix`
+        and calls delete on them one at a time.
 
         .. warning:: This operation was not tested with extremely large data sets.
            On a large production based system, care should be taken with its
@@ -354,6 +367,7 @@ class RedisSentinelStorage(RedisStorage):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = RedisStorage.PREFIX,
         service_name: str | None = None,
         use_replicas: bool = True,
         sentinel_kwargs: dict[str, float | str | bool] | None = None,
@@ -372,6 +386,7 @@ class RedisSentinelStorage(RedisStorage):
          - ``coredis``: :class:`coredis.sentinel.Sentinel`
          - ``redispy``: :class:`redis.asyncio.sentinel.Sentinel`
          - ``valkey``: :class:`valkey.asyncio.sentinel.Sentinel`
+        :param key_prefix: the prefix for each key created in redis
         :param service_name: sentinel service name (if not provided in `uri`)
         :param use_replicas: Whether to use replicas for read only operations
         :param sentinel_kwargs: optional arguments to pass as
@@ -391,6 +406,7 @@ class RedisSentinelStorage(RedisStorage):
             uri,
             wrap_exceptions=wrap_exceptions,
             implementation=implementation,
+            key_prefix=key_prefix,
             **options,
         )
 

{limits-5.0.0rc2 → limits-5.1.0}/limits/aio/storage/redis/bridge.py

@@ -8,7 +8,6 @@ from limits.util import get_package_data
 
 
 class RedisBridge(ABC):
-    PREFIX = "LIMITS"
     RES_DIR = "resources/redis/lua_scripts"
 
     SCRIPT_MOVING_WINDOW = get_package_data(f"{RES_DIR}/moving_window.lua")
@@ -26,18 +25,20 @@ class RedisBridge(ABC):
         self,
         uri: str,
         dependency: ModuleType,
+        key_prefix: str,
     ) -> None:
         self.uri = uri
         self.parsed_uri = urllib.parse.urlparse(self.uri)
         self.dependency = dependency
         self.parsed_auth = {}
+        self.key_prefix = key_prefix
         if self.parsed_uri.username:
             self.parsed_auth["username"] = self.parsed_uri.username
         if self.parsed_uri.password:
             self.parsed_auth["password"] = self.parsed_uri.password
 
     def prefixed_key(self, key: str) -> str:
-        return f"{self.PREFIX}:{key}"
+        return f"{self.key_prefix}:{key}"
 
     @abstractmethod
     def register_scripts(self) -> None: ...

{limits-5.0.0rc2 → limits-5.1.0}/limits/storage/redis.py

@@ -68,6 +68,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         self,
         uri: str,
         connection_pool: redis.connection.ConnectionPool | None = None,
+        key_prefix: str = PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -82,6 +83,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
          :pypi:`valkey`.
         :param connection_pool: if provided, the redis client is initialized with
          the connection pool and any other params passed as :paramref:`options`
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -89,6 +91,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         :raise ConfigurationError: when the :pypi:`redis` library is not available
         """
         super().__init__(uri, wrap_exceptions=wrap_exceptions, **options)
+        self.key_prefix = key_prefix
         self.target_server = "valkey" if uri.startswith("valkey") else "redis"
         self.dependency = self.dependencies[self.target_server].module
 
@@ -165,7 +168,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         return f"{self._current_window_key(key)}/-1"
 
     def prefixed_key(self, key: str) -> str:
-        return f"{self.PREFIX}:{key}"
+        return f"{self.key_prefix}:{key}"
 
     def get_moving_window(self, key: str, limit: int, expiry: int) -> tuple[float, int]:
         """
@@ -295,7 +298,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
     def reset(self) -> int | None:
         """
         This function calls a Lua Script to delete keys prefixed with
-        ``self.PREFIX`` in blocks of 5000.
+        :paramref:`RedisStorage.key_prefix` in blocks of 5000.
 
         .. warning::
            This operation was designed to be fast, but was not tested

{limits-5.0.0rc2 → limits-5.1.0}/limits/storage/redis_cluster.py

@@ -56,6 +56,7 @@ class RedisClusterStorage(RedisStorage):
     def __init__(
         self,
         uri: str,
+        key_prefix: str = RedisStorage.PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -65,6 +66,7 @@ class RedisClusterStorage(RedisStorage):
 
          If the uri scheme is ``valkey+cluster`` the implementation used will be from
          :pypi:`valkey`.
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -86,6 +88,7 @@ class RedisClusterStorage(RedisStorage):
             host, port = loc.split(":")
             cluster_hosts.append((host, int(port)))
 
+        self.key_prefix = key_prefix
         self.storage = None
         self.target_server = "valkey" if uri.startswith("valkey") else "redis"
         merged_options = {**self.DEFAULT_OPTIONS, **parsed_auth, **options}
@@ -108,8 +111,8 @@ class RedisClusterStorage(RedisStorage):
         """
         Redis Clusters are sharded and deleting across shards
         can't be done atomically. Because of this, this reset loops over all
-        keys that are prefixed with ``self.PREFIX`` and calls delete on them,
-        one at a time.
+        keys that are prefixed with :paramref:`RedisClusterStorage.prefix` and
+        calls delete on them one at a time.
 
         .. warning::
          This operation was not tested with extremely large data sets.

{limits-5.0.0rc2 → limits-5.1.0}/limits/storage/redis_sentinel.py

@@ -45,6 +45,7 @@ class RedisSentinelStorage(RedisStorage):
         service_name: str | None = None,
         use_replicas: bool = True,
         sentinel_kwargs: dict[str, float | str | bool] | None = None,
+        key_prefix: str = RedisStorage.PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -59,6 +60,7 @@ class RedisSentinelStorage(RedisStorage):
         :param use_replicas: Whether to use replicas for read only operations
         :param sentinel_kwargs: kwargs to pass as
          :attr:`sentinel_kwargs` to :class:`redis.sentinel.Sentinel`
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -87,6 +89,7 @@ class RedisSentinelStorage(RedisStorage):
         for loc in parsed.netloc[sep:].split(","):
             host, port = loc.split(":")
             sentinel_configuration.append((host, int(port)))
+        self.key_prefix = key_prefix
         self.service_name = (
             parsed.path.replace("/", "") if parsed.path else service_name
         )

{limits-5.0.0rc2 → limits-5.1.0}/limits.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 5.0.0rc2
+Version: 5.1.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 License-File: LICENSE.txt
 Requires-Dist: deprecated>=1.2
-Requires-Dist: packaging<25,>=21
+Requires-Dist: packaging<26,>=21
 Requires-Dist: typing_extensions
 Provides-Extra: redis
 Requires-Dist: redis!=4.5.2,!=4.5.3,<6.0.0,>3; extra == "redis"

{limits-5.0.0rc2 → limits-5.1.0}/limits.egg-info/requires.txt

@@ -1,5 +1,5 @@
 deprecated>=1.2
-packaging<25,>=21
+packaging<26,>=21
 typing_extensions
 
 [all]

{limits-5.0.0rc2 → limits-5.1.0}/requirements/main.txt

@@ -1,3 +1,3 @@
 deprecated>=1.2
-packaging>=21,<25
+packaging>=21,<26
 typing_extensions