pytest-codspeed 3.0.0__tar.gz → 3.0.0b0__tar.gz

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-codspeed
-Version: 3.0.0
+Version: 3.0.0b0
 Summary: Pytest plugin to create CodSpeed benchmarks
 Project-URL: Homepage, https://codspeed.io/
 Project-URL: Documentation, https://docs.codspeed.io/
@@ -35,6 +35,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -44,17 +45,15 @@ Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: System :: Benchmark
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.8
 Requires-Dist: cffi>=1.17.1
 Requires-Dist: filelock>=3.12.2
 Requires-Dist: importlib-metadata>=8.5.0; python_version < '3.10'
 Requires-Dist: pytest>=3.8
 Requires-Dist: rich>=13.8.1
 Requires-Dist: setuptools; python_full_version >= '3.12.0'
-Provides-Extra: build
-Requires-Dist: semver>=3.0.2; extra == 'build'
 Provides-Extra: compat
-Requires-Dist: pytest-benchmark~=5.0.0; extra == 'compat'
+Requires-Dist: pytest-benchmark~=4.0.0; extra == 'compat'
 Requires-Dist: pytest-xdist~=3.6.1; extra == 'compat'
 Provides-Extra: lint
 Requires-Dist: mypy~=1.11.2; extra == 'lint'
@@ -69,7 +68,7 @@ Description-Content-Type: text/markdown
 
 [![CI](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml)
 [![PyPi Version](https://img.shields.io/pypi/v/pytest-codspeed?color=%2334D058&label=pypi)](https://pypi.org/project/pytest-codspeed)
-![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
 [![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
 [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/pytest-codspeed)
 
@@ -79,7 +78,7 @@ Pytest plugin to create CodSpeed benchmarks
 
 ## Requirements
 
-**Python**: 3.9 and later
+**Python**: 3.8 and later
 
 **pytest**: any recent version
 
@@ -154,7 +153,7 @@ You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run
 Example workflow:
 
 ```yaml
-name: CodSpeed
+name: benchmarks
 
 on:
   push:
@@ -164,7 +163,6 @@ on:
 
 jobs:
   benchmarks:
-    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/README.md

@@ -3,7 +3,7 @@
 
 [![CI](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/pytest-codspeed/actions/workflows/ci.yml)
 [![PyPi Version](https://img.shields.io/pypi/v/pytest-codspeed?color=%2334D058&label=pypi)](https://pypi.org/project/pytest-codspeed)
-![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
 [![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
 [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/pytest-codspeed)
 
@@ -13,7 +13,7 @@ Pytest plugin to create CodSpeed benchmarks
 
 ## Requirements
 
-**Python**: 3.9 and later
+**Python**: 3.8 and later
 
 **pytest**: any recent version
 
@@ -88,7 +88,7 @@ You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run
 Example workflow:
 
 ```yaml
-name: CodSpeed
+name: benchmarks
 
 on:
   push:
@@ -98,7 +98,6 @@ on:
 
 jobs:
   benchmarks:
-    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/pyproject.toml

@@ -13,7 +13,7 @@ dynamic = ["version"]
 description = "Pytest plugin to create CodSpeed benchmarks"
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.9"
+requires-python = ">=3.8"
 authors = [{ name = "Arthur Pastel", email = "arthur@codspeed.io" }]
 keywords = ["codspeed", "benchmark", "performance", "pytest"]
 classifiers = [
@@ -23,6 +23,7 @@ classifiers = [
     "Intended Audience :: Information Technology",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -45,10 +46,9 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-build = ["semver>=3.0.2"]
 lint = ["mypy ~= 1.11.2", "ruff ~= 0.6.5"]
 compat = [
-    "pytest-benchmark ~= 5.0.0",
+    "pytest-benchmark ~= 4.0.0",
     "pytest-xdist ~= 3.6.1",
     # "pytest-speed>=0.3.5",
 ]
@@ -64,7 +64,7 @@ features = ["lint", "test", "compat"]
 features = ["test"]
 
 [[tool.hatch.envs.test.matrix]]
-python = ["3.9", "3.10", "3.11", "3.12", "3.13"]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 features = ["compat", "test"]
 
 [tool.hatch.version]
@@ -94,7 +94,7 @@ float_to_top = true
 [tool.pytest.ini_options]
 addopts = "--ignore=tests/benchmarks --ignore=tests/examples --ignore=tests/benchmarks/TheAlgorithms"
 filterwarnings = ["ignore::DeprecationWarning:pytest_benchmark.utils.*:"]
-pythonpath = ["tests/benchmarks/TheAlgorithms", "./scripts"]
+pythonpath = ["tests/benchmarks/TheAlgorithms"]
 
 [tool.coverage.run]
 branch = true

pytest_codspeed-3.0.0b0/src/pytest_codspeed/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "3.0.0b0"
+
+from .plugin import BenchmarkFixture
+
+__all__ = ["BenchmarkFixture", "__version__"]

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/src/pytest_codspeed/instruments/valgrind/__init__.py

@@ -4,7 +4,7 @@ import os
 import sys
 from typing import TYPE_CHECKING
 
-from pytest_codspeed import __semver_version__
+from pytest_codspeed import __version__
 from pytest_codspeed.instruments import Instrument
 from pytest_codspeed.instruments.valgrind._wrapper import get_lib
 
@@ -30,7 +30,7 @@ class ValgrindInstrument(Instrument):
         if self.should_measure:
             self.lib = get_lib()
             self.lib.dump_stats_at(
-                f"Metadata: pytest-codspeed {__semver_version__}".encode("ascii")
+                f"Metadata: pytest-codspeed {__version__}".encode("ascii")
             )
             if SUPPORTS_PERF_TRAMPOLINE:
                 sys.activate_stack_trampoline("perf")  # type: ignore

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/src/pytest_codspeed/instruments/walltime.py

@@ -2,12 +2,11 @@ from __future__ import annotations
 
 from dataclasses import asdict, dataclass
 from math import ceil
-from statistics import mean, quantiles, stdev
+from statistics import mean, median, stdev
 from time import get_clock_info, perf_counter_ns
 from typing import TYPE_CHECKING
 
 from rich.console import Console
-from rich.markup import escape
 from rich.table import Table
 from rich.text import Text
 
@@ -41,10 +40,8 @@ class BenchmarkConfig:
             if config.warmup_time_ns is not None
             else DEFAULT_WARMUP_TIME_NS,
             min_round_time_ns=DEFAULT_MIN_ROUND_TIME_NS,
-            max_time_ns=config.max_time_ns
-            if config.max_time_ns is not None
-            else DEFAULT_MAX_TIME_NS,
-            max_rounds=config.max_rounds,
+            max_time_ns=DEFAULT_MAX_TIME_NS,
+            max_rounds=config.max_rounds or None,
         )
 
 
@@ -52,17 +49,13 @@ class BenchmarkConfig:
 class BenchmarkStats:
     min_ns: float
     max_ns: float
-    mean_ns: float
     stdev_ns: float
-
-    q1_ns: float
+    mean_ns: float
     median_ns: float
-    q3_ns: float
 
     rounds: int
     total_time: float
-    iqr_outlier_rounds: int
-    stdev_outlier_rounds: int
+    outlier_rounds: int
     iter_per_round: int
     warmup_iters: int
 
@@ -78,36 +71,15 @@ class BenchmarkStats:
     ) -> BenchmarkStats:
         stdev_ns = stdev(times_ns) if len(times_ns) > 1 else 0
         mean_ns = mean(times_ns)
-        if len(times_ns) > 1:
-            q1_ns, median_ns, q3_ns = quantiles(times_ns, n=4)
-        else:
-            q1_ns, median_ns, q3_ns = (
-                mean_ns,
-                mean_ns,
-                mean_ns,
-            )
-        iqr_ns = q3_ns - q1_ns
-        iqr_outlier_rounds = sum(
-            1 for t in times_ns if t < q1_ns - 1.5 * iqr_ns or t > q3_ns + 1.5 * iqr_ns
-        )
-        stdev_outlier_rounds = sum(
-            1
-            for t in times_ns
-            if t < mean_ns - 3 * stdev_ns or t > mean_ns + 3 * stdev_ns
-        )
-
         return cls(
             min_ns=min(times_ns),
             max_ns=max(times_ns),
             stdev_ns=stdev_ns,
             mean_ns=mean_ns,
-            q1_ns=q1_ns,
-            median_ns=median_ns,
-            q3_ns=q3_ns,
+            median_ns=median(times_ns),
             rounds=rounds,
             total_time=total_time,
-            iqr_outlier_rounds=iqr_outlier_rounds,
-            stdev_outlier_rounds=stdev_outlier_rounds,
+            outlier_rounds=sum(1 for t in times_ns if abs(t - mean_ns) > stdev_ns),
             iter_per_round=iter_per_round,
             warmup_iters=warmup_iters,
         )
@@ -153,7 +125,6 @@ def run_benchmark(
         rounds = int(config.max_time_ns / round_time_ns)
     else:
         rounds = config.max_rounds
-    rounds = max(1, rounds)
 
     # Benchmark
     iter_range = range(iter_per_round)
@@ -244,7 +215,7 @@ class WallTimeInstrument(Instrument):
             if rsd > 0.1:
                 rsd_text.stylize("red bold")
             table.add_row(
-                escape(bench.name),
+                bench.name,
                 f"{bench.stats.min_ns/bench.stats.iter_per_round:,.0f}ns",
                 rsd_text,
                 f"{bench.stats.total_time:,.2f}s",

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/src/pytest_codspeed/plugin.py

@@ -61,15 +61,6 @@ def pytest_addoption(parser: pytest.Parser):
             "only for walltime mode"
         ),
     )
-    group.addoption(
-        "--codspeed-max-time",
-        action="store",
-        type=float,
-        help=(
-            "The maximum time to run a benchmark for (in seconds), "
-            "only for walltime mode"
-        ),
-    )
     group.addoption(
         "--codspeed-max-rounds",
         action="store",
@@ -84,7 +75,6 @@ def pytest_addoption(parser: pytest.Parser):
 @dataclass(frozen=True)
 class CodSpeedConfig:
     warmup_time_ns: int | None = None
-    max_time_ns: int | None = None
     max_rounds: int | None = None
 
     @classmethod
@@ -93,12 +83,9 @@ class CodSpeedConfig:
         warmup_time_ns = (
             int(warmup_time * 1_000_000_000) if warmup_time is not None else None
         )
-        max_time = config.getoption("--codspeed-max-time", None)
-        max_time_ns = int(max_time * 1_000_000_000) if max_time is not None else None
         return cls(
             warmup_time_ns=warmup_time_ns,
             max_rounds=config.getoption("--codspeed-max-rounds", None),
-            max_time_ns=max_time_ns,
         )
 
 
@@ -320,18 +307,6 @@ def pytest_sessionfinish(session: pytest.Session, exitstatus):
 class BenchmarkFixture:
     """The fixture that can be used to benchmark a function."""
 
-    @property  # type: ignore
-    def __class__(self):
-        # Bypass the pytest-benchmark fixture class check
-        # https://github.com/ionelmc/pytest-benchmark/commit/d6511e3474931feb4e862948128e0c389acfceec
-        if IS_PYTEST_BENCHMARK_INSTALLED:
-            from pytest_benchmark.fixture import (
-                BenchmarkFixture as PytestBenchmarkFixture,
-            )
-
-            return PytestBenchmarkFixture
-        return BenchmarkFixture
-
     def __init__(self, request: pytest.FixtureRequest):
         self.extra_info: dict = {}
 

{pytest_codspeed-3.0.0 → pytest_codspeed-3.0.0b0}/src/pytest_codspeed/utils.py

@@ -5,7 +5,7 @@ import sys
 import sysconfig
 from pathlib import Path
 
-from pytest_codspeed import __semver_version__
+from pytest_codspeed import __version__
 
 if sys.version_info < (3, 10):
     import importlib_metadata as importlib_metadata
@@ -51,7 +51,7 @@ def get_environment_metadata() -> dict[str, dict]:
     return {
         "creator": {
             "name": "pytest-codspeed",
-            "version": __semver_version__,
+            "version": __version__,
             "pid": os.getpid(),
         },
         "python": {

pytest_codspeed-3.0.0/src/pytest_codspeed/__init__.py

@@ -1,7 +0,0 @@
-__version__ = "3.0.0"
-# We also have the semver version since __version__ is not semver compliant
-__semver_version__ = "3.0.0"
-
-from .plugin import BenchmarkFixture
-
-__all__ = ["BenchmarkFixture", "__version__", "__semver_version__"]