limits 4.7.2__tar.gz → 5.0.0__tar.gz

{limits-4.7.2 → limits-5.0.0}/HISTORY.rst

@@ -3,6 +3,37 @@
 Changelog
 =========
 
+v5.0.0
+------
+Release Date: 2025-04-15
+
+* Backward incompatible changes
+
+  * Dropped support for Fixed Window with Elastic Expiry strategy
+  * Dropped support for etcd
+  * Changed the default implementation for async+memached from :pypi:`emcache`
+    to :pypi`:memcachio`
+
+* Performance
+
+  * 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
+------
+Release Date: 2025-04-12
+
+* Documentation
+
+  * Expand benchmark results to included preseeded limits
+
+* Bug Fix
+
+  * Handle clearing missing key with memcache + async
+
 v4.7.2
 ------
 Release Date: 2025-04-09
@@ -794,84 +825,3 @@ Release Date: 2015-01-08
 * Initial import of common rate limiting code from `Flask-Limiter <https://github.com/alisaifee/flask-limiter>`_
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

{limits-4.7.2 → limits-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 4.7.2
+Version: 5.0.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee
@@ -32,19 +32,14 @@ Provides-Extra: memcached
 Requires-Dist: pymemcache<5.0.0,>3; extra == "memcached"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<5,>4.1; extra == "mongodb"
-Provides-Extra: etcd
-Requires-Dist: etcd3; extra == "etcd"
 Provides-Extra: valkey
 Requires-Dist: valkey>=6; extra == "valkey"
 Provides-Extra: async-redis
 Requires-Dist: coredis<5,>=3.4.0; extra == "async-redis"
 Provides-Extra: async-memcached
-Requires-Dist: emcache>=0.6.1; python_version < "3.11" and extra == "async-memcached"
-Requires-Dist: emcache>=1; (python_version >= "3.11" and python_version < "3.13.0") and extra == "async-memcached"
+Requires-Dist: memcachio>=0.3; extra == "async-memcached"
 Provides-Extra: async-mongodb
 Requires-Dist: motor<4,>=3; extra == "async-mongodb"
-Provides-Extra: async-etcd
-Requires-Dist: aetcd; extra == "async-etcd"
 Provides-Extra: async-valkey
 Requires-Dist: valkey>=6; extra == "async-valkey"
 Provides-Extra: all
@@ -52,13 +47,10 @@ Requires-Dist: redis!=4.5.2,!=4.5.3,<6.0.0,>3; extra == "all"
 Requires-Dist: redis!=4.5.2,!=4.5.3,>=4.2.0; extra == "all"
 Requires-Dist: pymemcache<5.0.0,>3; extra == "all"
 Requires-Dist: pymongo<5,>4.1; extra == "all"
-Requires-Dist: etcd3; extra == "all"
 Requires-Dist: valkey>=6; extra == "all"
 Requires-Dist: coredis<5,>=3.4.0; extra == "all"
-Requires-Dist: emcache>=0.6.1; python_version < "3.11" and extra == "all"
-Requires-Dist: emcache>=1; (python_version >= "3.11" and python_version < "3.13.0") and extra == "all"
+Requires-Dist: memcachio>=0.3; extra == "all"
 Requires-Dist: motor<4,>=3; extra == "all"
-Requires-Dist: aetcd; extra == "all"
 Requires-Dist: valkey>=6; extra == "all"
 Dynamic: author
 Dynamic: author-email
@@ -86,13 +78,14 @@ Dynamic: summary
 .. |docs| image:: https://readthedocs.org/projects/limits/badge/?version=latest
    :target: https://limits.readthedocs.org
 
+######
 limits
-------
+######
 |docs| |ci| |codecov| |pypi| |pypi-versions| |license|
 
 
 **limits** is a python library for rate limiting via multiple strategies
-with commonly used storage backends (Redis, Memcached, MongoDB & Etcd).
+with commonly used storage backends (Redis, Memcached & MongoDB).
 
 The library provides identical APIs for use in sync and
 `async <https://limits.readthedocs.io/en/stable/async.html>`_ codebases.
@@ -188,13 +181,13 @@ Scenario 2:
 - ``weighted_count = floor(8 + (4 * 0.33)) = floor(8 + 1.32) = 9``.
 - Since the weighted count is below the limit, the request is allowed.
 
+
 Storage backends
 ================
 
 - `Redis <https://limits.readthedocs.io/en/latest/storage.html#redis-storage>`_
 - `Memcached <https://limits.readthedocs.io/en/latest/storage.html#memcached-storage>`_
 - `MongoDB <https://limits.readthedocs.io/en/latest/storage.html#mongodb-storage>`_
-- `Etcd <https://limits.readthedocs.io/en/latest/storage.html#etcd-storage>`_
 - `In-Memory <https://limits.readthedocs.io/en/latest/storage.html#in-memory-storage>`_
 
 Dive right in
@@ -281,5 +274,6 @@ Links
 =====
 
 * `Documentation <http://limits.readthedocs.org/en/latest>`_
+* `Benchmarks <http://limits.readthedocs.org/en/latest/performance.html>`_
 * `Changelog <http://limits.readthedocs.org/en/stable/changelog.html>`_
 

{limits-4.7.2 → limits-5.0.0}/README.rst

@@ -11,13 +11,14 @@
 .. |docs| image:: https://readthedocs.org/projects/limits/badge/?version=latest
    :target: https://limits.readthedocs.org
 
+######
 limits
-------
+######
 |docs| |ci| |codecov| |pypi| |pypi-versions| |license|
 
 
 **limits** is a python library for rate limiting via multiple strategies
-with commonly used storage backends (Redis, Memcached, MongoDB & Etcd).
+with commonly used storage backends (Redis, Memcached & MongoDB).
 
 The library provides identical APIs for use in sync and
 `async <https://limits.readthedocs.io/en/stable/async.html>`_ codebases.
@@ -113,13 +114,13 @@ Scenario 2:
 - ``weighted_count = floor(8 + (4 * 0.33)) = floor(8 + 1.32) = 9``.
 - Since the weighted count is below the limit, the request is allowed.
 
+
 Storage backends
 ================
 
 - `Redis <https://limits.readthedocs.io/en/latest/storage.html#redis-storage>`_
 - `Memcached <https://limits.readthedocs.io/en/latest/storage.html#memcached-storage>`_
 - `MongoDB <https://limits.readthedocs.io/en/latest/storage.html#mongodb-storage>`_
-- `Etcd <https://limits.readthedocs.io/en/latest/storage.html#etcd-storage>`_
 - `In-Memory <https://limits.readthedocs.io/en/latest/storage.html#in-memory-storage>`_
 
 Dive right in
@@ -206,5 +207,6 @@ Links
 =====
 
 * `Documentation <http://limits.readthedocs.org/en/latest>`_
+* `Benchmarks <http://limits.readthedocs.org/en/latest/performance.html>`_
 * `Changelog <http://limits.readthedocs.org/en/stable/changelog.html>`_
 

{limits-4.7.2 → limits-5.0.0}/doc/source/_static/custom.css

@@ -1,7 +1,7 @@
 .badges {
   display: flex;
   padding: 5px;
-  flex-direction: rootow;
+  flex-direction: row;
   justify-content: center;
 }
 .header-badge {

{limits-4.7.2 → limits-5.0.0}/doc/source/api.rst

@@ -28,7 +28,6 @@ a single parameter: a subclass of :class:`~limits.storage.Storage`.
 Provided by :mod:`limits.strategies`
 
 .. autoclass:: FixedWindowRateLimiter
-.. autoclass:: FixedWindowElasticExpiryRateLimiter
 .. autoclass:: MovingWindowRateLimiter
 .. autoclass:: SlidingWindowCounterRateLimiter
 
@@ -47,7 +46,6 @@ expose async variants and expect a subclass of :class:`limits.aio.storage.Storag
 Provided by :mod:`limits.aio.strategies`
 
 .. autoclass:: FixedWindowRateLimiter
-.. autoclass:: FixedWindowElasticExpiryRateLimiter
 .. autoclass:: MovingWindowRateLimiter
 .. autoclass:: SlidingWindowCounterRateLimiter
 
@@ -101,11 +99,6 @@ MongoDB Storage
 
 .. autoclass:: MongoDBStorage
 
-Etcd Storage
-^^^^^^^^^^^^
-
-.. autoclass:: EtcdStorage
-
 
 Async Storage
 -------------
@@ -144,11 +137,6 @@ Async MongoDB Storage
 
 .. autoclass:: MongoDBStorage
 
-Async Etcd Storage
-^^^^^^^^^^^^^^^^^^
-
-.. autoclass:: EtcdStorage
-
 Abstract storage classes
 ------------------------
 

{limits-4.7.2 → limits-5.0.0}/doc/source/async.rst

@@ -2,10 +2,8 @@
 Async Support
 =============
 
-.. versionadded:: 2.1
-
-A new namespace ``limits.aio`` is available which mirrors the original
-``limits.storage`` and ``limits.strategies`` packages.
+The namespace ``limits.aio``  mirrors ``limits.storage`` and ``limits.strategies``
+with async variants.
 
 The following async storage backends are implemented:
 
@@ -14,9 +12,8 @@ The following async storage backends are implemented:
   or `redis-py <https://redis-py.readthedocs.io>`_. Refer to
   :paramref:`limits.aio.storage.RedisStorage.implementation` for
   details on selecting the dependency)
-- Memcached (via `emcache <https://emcache.readthedocs.org>`_)
+- Memcached (via `memcachio <https://memcachio.readthedocs.org>`_)
 - MongoDB (via `motor <https://motor.readthedocs.org>`_)
-- Etcd (via `aetcd <https://aetcd.readthedocs.org>`_)
 
 Quick start
 ===========

{limits-4.7.2 → limits-5.0.0}/doc/source/conf.py

@@ -1,17 +1,14 @@
 #
+from __future__ import annotations
 
 import os
 import sys
 from pathlib import Path
 
-from docutils import nodes
-from sphinx.application import Sphinx
-from sphinx.util.docutils import SphinxDirective
-
 sys.path.insert(0, os.path.abspath("../../"))
 sys.path.insert(0, os.path.abspath("./"))
 
-from theme_config import *
+from theme_config import *  # noqa
 
 import limits
 
@@ -19,27 +16,39 @@ project = "limits"
 description = "limits is a python library to perform rate limiting with commonly used storage backends"
 copyright = "2023, Ali-Akber Saifee"
 
+
 if ".post0.dev" in limits.__version__:
     version, ahead = limits.__version__.split(".post0.dev")
 else:
     version = limits.__version__
+    ahead = 0
 
 release = version
 
 
 if branch_from_env := os.environ.get("READTHEDOCS_VERSION", None):
+    branch_from_env = "master" if branch_from_env == "latest" else branch_from_env
     benchmark_git_context = {
         "branch": branch_from_env,
-        "sha": os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", "")
+        "sha": os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", ""),
     }
 else:
     import limits._version
+
     git_info = limits._version.git_pieces_from_vcs("", os.path.abspath("../../"), False)
     benchmark_git_context = {
         "branch": git_info.get("branch", ""),
-        "sha": git_info.get("long", None)
+        "sha": git_info.get("long", None),
     }
-
+benchmark_param_mapping = {
+    "percentage_full": {
+        "display": "Percentage Seeded",
+        "info": "Percentage of rate limit already filled before the benchmark is run",
+    },
+    "async": {"display": "Asyncio", "info": "Using asyncio storage implementation"},
+    "storage_type": {"display": "Storage", "info": "Storage Backend"},
+    "strategy": {"display": "Strategy", "info": "Rate Limiting Strategy"},
+}
 html_static_path = ["_static"]
 
 html_css_files = [
@@ -48,18 +57,19 @@ html_css_files = [
 ]
 
 html_title = f"{project} <small><b style='color: var(--color-brand-primary)'>{{{release}}}</b></small>"
+
 try:
     ahead = int(ahead)
     if ahead > 0:
-        html_theme_options[
+        html_theme_options[  # noqa
             "announcement"
         ] = f"""
         This is a development version. The documentation for the latest version: <b>{release}</b> can be found <a href="/en/stable">here</a>
         """
         html_title = f"{project} <small><b style='color: var(--color-brand-primary)'>{{dev}}</b></small>"
-except:
+except ValueError:
     pass
-sys.path.append(str(Path('ext').resolve()))
+sys.path.append(str(Path("ext").resolve()))
 
 extensions = [
     "sphinx.ext.autodoc",
@@ -73,6 +83,7 @@ extensions = [
     "sphinxext.opengraph",
     "sphinxcontrib.programoutput",
     "sphinx_copybutton",
+    "sphinx_design",
     "sphinx_inline_tabs",
     "sphinx_paramlinks",
     "bench_chart",
@@ -93,18 +104,16 @@ autosectionlabel_prefix_document = True
 
 extlinks = {"pypi": ("https://pypi.org/project/%s", "%s")}
 
-copybutton_exclude = '.gp, .go'
+copybutton_exclude = ".gp, .go"
 
 intersphinx_mapping = {
     "python": ("http://docs.python.org/", None),
     "coredis": ("https://coredis.readthedocs.io/en/latest/", None),
-    "emcache": ("https://emcache.readthedocs.io/en/latest/", None),
+    "memcachio": ("https://memcachio.readthedocs.io/en/latest/", None),
     "motor": ("https://motor.readthedocs.io/en/stable/", None),
     "redis-py-cluster": ("https://redis-py-cluster.readthedocs.io/en/latest/", None),
     "redis-py": ("https://redis-py.readthedocs.io/en/latest/", None),
     "pymemcache": ("https://pymemcache.readthedocs.io/en/latest/", None),
     "pymongo": ("https://pymongo.readthedocs.io/en/stable/", None),
-    "python-etcd3": ("https://python-etcd3.readthedocs.io/en/latest/", None),
-    "aetcd": ("https://aetcd.readthedocs.io/en/latest/", None),
     "valkey-py": ("https://valkey-py.readthedocs.io/en/latest/", None),
 }

limits-5.0.0/doc/source/ext/_static/benchmark-chart.css

@@ -0,0 +1,94 @@
+.benchmark-chart {
+  width: 100%;
+}
+.benchmark-details {
+  .benchmark-details-section {
+    thead > tr {
+      color: var(--color-purple);
+    }
+  }
+}
+.benchmark-chart-error,
+.benchmark-details-error {
+  color: var(--color-red);
+  font-size: smaller;
+  padding: 2em;
+  text-align: center;
+  height: 5em;
+}
+.benchmark-chart-loading {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  font-size: 1.2rem;
+  font-weight: bold;
+  color: var(--color-purple);
+  letter-spacing: 1px;
+  height: 200px;
+  animation: benchmark-chart-loading-animation;
+  animation-iteration-count: 10;
+  animation-duration: 2s;
+}
+
+@keyframes benchmark-chart-loading-animation {
+  0% {
+    opacity: 0;
+  }
+  25% {
+    opacity: 0.25;
+  }
+  50% {
+    opacity: 0.5;
+  }
+  90% {
+    opacity: 0.9;
+  }
+  100% {
+    opacity: 1;
+  }
+}
+.benchmark-filters {
+  padding-top: 1em;
+  padding-bottom: 1em;
+  display: flex;
+  justify-content: flex-end;
+}
+.benchmark-filter-dropdowns {
+  display: flex;
+  align-items: flex-end;
+  justify-content: flex-end;
+  margin-top: 2em;
+  flex-direction: row;
+  @media only screen and (max-width: 800px) {
+    flex-basis: min-content;
+  }
+  @media only screen and (max-width: 400px) {
+    flex-basis: max-content;
+    flex-direction: column;
+  }
+}
+
+.compare-dropdown {
+  display: flex;
+  justify-content: flex-end;
+}
+
+.benchmark-filter {
+  display: flex;
+  flex-direction: row;
+  gap: 0.25em;
+  padding: 0.25em;
+}
+
+.benchmark-filter label,
+.compare-filter label {
+  font-size: small;
+  font-weight: bold;
+}
+
+.benchmark-filter select,
+.compare-filter select {
+  font-size: small;
+  border: 1px solid;
+  border-radius: 0.4em;
+}