limits 4.7__tar.gz → 4.7.2__tar.gz

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

@@ -3,6 +3,22 @@
 Changelog
 =========
 
+v4.7.2
+------
+Release Date: 2025-04-09
+
+* Documentation
+
+  * Improve presentation of benchmark docs
+
+v4.7.1
+------
+Release Date: 2025-04-08
+
+* Testing
+
+  * Fix incorrect benchmark for async test method
+
 v4.7
 ----
 Release Date: 2025-04-08
@@ -854,6 +870,8 @@ Release Date: 2015-01-08
 
 
 
+
+
 
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 4.7
+Version: 4.7.2
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee

limits-4.7.2/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 → limits-4.7.2}/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 → limits-4.7.2}/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 → limits-4.7.2}/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-4.7.2/doc/source/ext/_templates/git_info.js

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

{limits-4.7 → limits-4.7.2}/doc/source/ext/bench_chart.py

@@ -13,11 +13,13 @@ if TYPE_CHECKING:
 
 here = os.path.dirname(os.path.abspath(__file__))
 
+
 def check_bool(value):
     if value.lower() in ["true", "false"]:
         return value.lower() == "true"
     return value
 
+
 def query(argument):
     if not argument.strip():
         return {}
@@ -27,8 +29,9 @@ def query(argument):
         queries[key] = check_bool(value)
     return queries
 
+
 def filters(argument):
-    filters: dict[str, list|bool] = {}
+    filters: dict[str, list | bool] = {}
     for filter in argument.strip().split(","):
         if ":" in filter:
             source, value = filter.split(":")
@@ -37,9 +40,11 @@ def filters(argument):
             filters[filter] = True
     return filters
 
+
 def sortBy(argument):
     return [k.strip() for k in argument.split(",")] if argument else []
 
+
 class BenchmarkDetails(SphinxDirective):
     required_arguments = 0
     final_argument_whitespace = False
@@ -47,6 +52,7 @@ class BenchmarkDetails(SphinxDirective):
         "source": str,
     }
     has_content = False
+
     def run(self):
         source = self.options.get("source", "benchmark-summary")
         html = f"""
@@ -58,6 +64,7 @@ class BenchmarkDetails(SphinxDirective):
 
         return [nodes.raw("", html, format="html")]
 
+
 class BenchmarkChart(SphinxDirective):
     required_arguments = 0
     final_argument_whitespace = False
@@ -68,6 +75,7 @@ class BenchmarkChart(SphinxDirective):
         "sort": sortBy,
     }
     has_content = False
+
     def run(self):
         source = self.options.get("source", "benchmark-summary")
         filters = self.options.get("filters", ["group"])
@@ -86,6 +94,7 @@ class BenchmarkChart(SphinxDirective):
 
         return [nodes.raw("", html, format="html")]
 
+
 def render_js_template(app) -> None:
     context = {
         "branch": app.config.benchmark_git_context.get("branch", ""),
@@ -103,19 +112,22 @@ def render_js_template(app) -> None:
         f.write(rendered_js)
     app.add_js_file("js/git_info.js")
 
+
 def setup(app: Sphinx):
     app.add_directive("benchmark-chart", BenchmarkChart)
     app.add_directive("benchmark-details", BenchmarkDetails)
     app.add_config_value("benchmark_git_context", default={}, rebuild="env")
+
     def add_assets(app, env) -> None:
         static_path = os.path.join(here, "_static")
         if static_path not in app.config.html_static_path:
             app.config.html_static_path.append(static_path)
-        app.add_js_file("js/benchmark-chart.js")
+        app.add_js_file("js/benchmark-chart.js", type="module")
         app.add_js_file("js/benchmark-details.js", type="module")
-        app.add_js_file("js/benchmark-loader.js")
+        app.add_js_file("js/benchmark-loader.js", type="module")
         app.add_js_file("https://cdn.plot.ly/plotly-3.0.1.min.js")
         app.add_css_file("benchmark-chart.css")
+
     app.config.templates_path += [os.path.join(here, "_templates")]
     app.connect("env-updated", add_assets)
     app.connect("builder-inited", render_js_template)
@@ -124,5 +136,4 @@ def setup(app: Sphinx):
         "version": "0.1",
         "parallel_read_safe": True,
         "parallel_write_safe": True,
-
     }

{limits-4.7 → limits-4.7.2}/doc/source/performance.rst

@@ -207,7 +207,7 @@ Sliding Window
        :query: async=false,group=get-window-stats,strategy=sliding-window
        :sort: storage_type,limit
 
-.. tab:: Get Window (Async)
+.. tab:: Get Window Stats (Async)
 
     .. benchmark-chart::
        :source: benchmark-summary

{limits-4.7 → limits-4.7.2}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-08T13:37:22-0700",
+ "date": "2025-04-09T14:27:52-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "c20794b223ba2e7984ecf12c4395c092aadcad88",
- "version": "4.7"
+ "full-revisionid": "451bd270b52aff6324de3ed6576a8fc87fbdaf9a",
+ "version": "4.7.2"
 }
 '''  # END VERSION_JSON
 

{limits-4.7 → limits-4.7.2}/limits.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 4.7
+Version: 4.7.2
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee

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

@@ -1,10 +0,0 @@
-.benchmark-chart {
-    width: 100%;
-}
-.benchmark-details{
-    .benchmark-details-section {
-       thead > tr {
-           color: var(--color-purple);
-       }
-    }
-}

limits-4.7/doc/source/ext/_templates/git_info.js

@@ -1,2 +0,0 @@
-window.GITBRANCH = "{{branch}}";
-window.GITSHA = "{{sha}}";