limits 4.7.1__tar.gz → 5.0.0rc1__tar.gz

{limits-4.7.1 → limits-5.0.0rc1}/HISTORY.rst

@@ -3,6 +3,30 @@
 Changelog
 =========
 
+v5.0.0rc1
+---------
+Release Date: 2025-04-09
+
+* 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`
+
+* 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 mongodb moving window ``test`` and ``get_window_stats`` operations.
+
+v4.7.2
+------
+Release Date: 2025-04-09
+
+* Documentation
+
+  * Improve presentation of benchmark docs
+
 v4.7.1
 ------
 Release Date: 2025-04-08
@@ -785,84 +809,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.1 → limits-5.0.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 4.7.1
+Version: 5.0.0rc1
 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

{limits-4.7.1 → limits-5.0.0rc1}/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

{limits-4.7.1 → limits-5.0.0rc1}/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.1 → limits-5.0.0rc1}/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.1 → limits-5.0.0rc1}/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.1 → limits-5.0.0rc1}/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
 
@@ -28,16 +25,18 @@ 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),
     }
 
 html_static_path = ["_static"]
@@ -48,18 +47,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",
@@ -93,18 +93,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.0rc1/doc/source/ext/_static/benchmark-chart.css

@@ -0,0 +1,61 @@
+.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: 25%;
+  }
+  ,
+  50% {
+    opacity: 50%;
+  }
+  ,
+  90% {
+    opacity: 90%;
+  }
+  ,
+  100% {
+    opacity: 100%;
+  }
+}
+
+.plot-container {
+  filter: invert(100%);
+}
+
+body[data-theme="light"] .plot-container {
+  filter: invert(0);
+}

{limits-4.7.1 → limits-5.0.0rc1}/doc/source/ext/_static/js/benchmark-chart.js

@@ -1,3 +1,5 @@
+import { render, html } from "https://unpkg.com/uhtml@3.2.1?module";
+import { fetchBenchmarkData } from "./benchmark-loader.js";
 const KNOWN_PARAMS = ["storage_type", "limit", "strategy", "async"];
 
 function getBenchmarkData(result, query) {
@@ -44,7 +46,7 @@ function formatRateLimit(str) {
 
 function nameTransform(benchmark, stripParams, query) {
   let name = benchmark.name;
-  params = benchmark.params;
+  let params = benchmark.params;
   name = name
     .replace(/\[.*?\]/, "")
     .replace("_async", "")
@@ -97,21 +99,6 @@ function getColorForStorage(storageType) {
   return storageColorMap[storageType] || "#7f7f7f"; // gray
 }
 
-function sortBenchmarksByParams(benchmarks, sortKeys) {
-  return benchmarks.sort((a, b) => {
-    for (const key of sortKeys) {
-      let valA = (a.params?.[key] || "").toLowerCase();
-      let valB = (b.params?.[key] || "").toLowerCase();
-      if (key == "limit") {
-        valA = parseInt(valA.split(" ")[0]);
-        valB = parseInt(valB.split(" ")[0]);
-      }
-      return valA < valB ? -1 : valA > valB ? 1 : 0;
-    }
-
-    return a.name.localeCompare(b.name);
-  });
-}
 function sortBenchmarksByParams(benchmarks, sortKeys) {
   return benchmarks.sort(function (a, b) {
     for (const key of sortKeys) {
@@ -127,6 +114,7 @@ function sortBenchmarksByParams(benchmarks, sortKeys) {
     return a.name.localeCompare(b.name);
   });
 }
+
 let dispatched = new Set();
 
 document.addEventListener("DOMContentLoaded", function () {
@@ -138,15 +126,38 @@ document.addEventListener("DOMContentLoaded", function () {
     let sortBy = JSON.parse(
       chart.dataset.sortBy || '["storage_type", "limit"]',
     );
+    render(
+      chart,
+      html`
+        <div class="benchmark-chart-loading">
+          <span>Loading</span>
+        </div>
+      `,
+    );
     if (!dispatched.has(source)) {
-      fetchBenchmarkData(`${source}.json`).then((result) => {
-        window.Benchmarks[source] = result;
-        event = new Event(`${source}-loaded`);
-        window.dispatchEvent(event);
-      });
+      fetchBenchmarkData(`${source}.json`)
+        .then((result) => {
+          window.Benchmarks[source] = result;
+          let event = new Event(`${source}-loaded`);
+          window.dispatchEvent(event);
+        })
+        .catch((error) => {
+          let event = new Event(`${source}-failed`);
+          window.dispatchEvent(event);
+        });
     }
     dispatched.add(source);
+    window.addEventListener(`${chart.dataset.source}-failed`, function () {
+      chart.querySelector(".benchmark-chart-loading")?.remove();
+      render(
+        chart,
+        html`
+          <div class="benchmark-chart-error">Benchmark data not available.</div>
+        `,
+      );
+    });
     window.addEventListener(`${chart.dataset.source}-loaded`, function () {
+      chart.querySelector(".benchmark-chart-loading")?.remove();
       let results = Benchmarks[chart.dataset.source];
       let unsorted = getBenchmarkData(results, query);
       let data = sortBenchmarksByParams(
@@ -188,7 +199,21 @@ document.addEventListener("DOMContentLoaded", function () {
           return item;
         }),
         layout,
+        { responsive: true, displaylogo: false },
       );
+      let initial = true;
+      chart.on("plotly_afterplot", function () {
+        const { hash } = window.location;
+        if (hash && initial) {
+          initial = false;
+          const target = document.querySelector(hash);
+          if (target) {
+            setTimeout(function () {
+              target.scrollIntoView({ behavior: "instant" });
+            }, 10);
+          }
+        }
+      });
     });
   });
 });

{limits-4.7.1 → limits-5.0.0rc1}/doc/source/ext/_static/js/benchmark-details.js

@@ -1,21 +1,37 @@
 import { render, html } from "https://unpkg.com/uhtml@3.2.1?module";
+import { fetchBenchmarkData } from "./benchmark-loader.js";
 document.addEventListener("DOMContentLoaded", function () {
   const details = document.querySelectorAll(".benchmark-details");
+  let dispatched = new Set();
   details.forEach((detail) => {
     let source = detail.dataset.source;
     if (!dispatched.has(source)) {
-      fetchBenchmarkData(`${source}.json`).then((result) => {
-        window.Benchmarks[source] = result;
-        event = new Event(`${source}-loaded`);
-        window.dispatchEvent(event);
-      });
+      fetchBenchmarkData(`${source}.json`)
+        .then((result) => {
+          window.Benchmarks[source] = result;
+          let event = new Event(`${source}-loaded`);
+          window.dispatchEvent(event);
+        })
+        .catch((error) => {
+          let event = new Event(`${source}-failed`);
+          window.dispatchEvent(event);
+        });
     }
     dispatched.add(source);
+    window.addEventListener(`${detail.dataset.source}-failed`, function () {
+      render(
+        detail,
+        html`
+          <div class="benchmark-details-error">
+            Benchmark data not available.
+          </div>
+        `,
+      );
+    });
     window.addEventListener(`${detail.dataset.source}-loaded`, function () {
       const machine_info = window.Benchmarks[source].machine_info;
       const commit_info = window.Benchmarks[source].commit_info;
       const cpu = window.Benchmarks[source].machine_info.cpu;
-      console.log(machine_info);
       render(
         detail,
         html`

{limits-4.7.1 → limits-5.0.0rc1}/doc/source/ext/_static/js/benchmark-loader.js

@@ -7,16 +7,13 @@ window.Benchmarks = new Map();
 
 function fetchBenchmarkData(filename) {
   let attempts = 0;
-
   function tryFetch() {
     if (attempts >= BENCHMARK_PATHS.length) {
-      return Promise.reject("All fetch attempts failed.");
+      return Promise.reject(new Error("All fetch attempts failed."));
     }
-
     const base = BENCHMARK_PATHS[attempts++];
     const url = base + filename;
-
-    // First send a HEAD request to quietly check existence
+    console.log(`Testing ${url}`);
     return fetch(url, { method: "HEAD" })
       .then((headRes) => {
         if (!headRes.ok) throw new Error("HEAD check failed");
@@ -30,3 +27,5 @@ function fetchBenchmarkData(filename) {
 
   return tryFetch();
 }
+
+export { fetchBenchmarkData };

limits-5.0.0rc1/doc/source/ext/_templates/git_info.js

@@ -0,0 +1,2 @@
+window.GITBRANCH = "{{branch | replace('.', '-')}}";
+window.GITSHA = "{{sha}}";