pytest-codspeed 3.0.0b4__tar.gz → 3.1.0__tar.gz

{pytest_codspeed-3.0.0b4 → pytest_codspeed-3.1.0}/PKG-INFO

@@ -1,10 +1,7 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.1
 Name: pytest-codspeed
-Version: 3.0.0b4
+Version: 3.1.0
 Summary: Pytest plugin to create CodSpeed benchmarks
-Project-URL: Homepage, https://codspeed.io/
-Project-URL: Documentation, https://docs.codspeed.io/
-Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
 Author-email: Arthur Pastel <arthur@codspeed.io>
 License: The MIT License (MIT)
         
@@ -27,15 +24,17 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
-License-File: LICENSE
-Keywords: benchmark,codspeed,performance,pytest
+        
+Project-URL: Homepage, https://codspeed.io/
+Project-URL: Documentation, https://docs.codspeed.io/
+Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
+Keywords: codspeed,benchmark,performance,pytest
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
 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
@@ -45,32 +44,28 @@ Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: System :: Benchmark
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
 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~=4.0.0; extra == 'compat'
-Requires-Dist: pytest-xdist~=3.6.1; extra == 'compat'
+Requires-Dist: importlib-metadata>=8.5.0; python_version < "3.10"
 Provides-Extra: lint
-Requires-Dist: mypy~=1.11.2; extra == 'lint'
-Requires-Dist: ruff~=0.6.5; extra == 'lint'
+Requires-Dist: mypy~=1.11.2; extra == "lint"
+Requires-Dist: ruff~=0.6.5; extra == "lint"
+Provides-Extra: compat
+Requires-Dist: pytest-benchmark~=5.0.0; extra == "compat"
+Requires-Dist: pytest-xdist~=3.6.1; extra == "compat"
 Provides-Extra: test
-Requires-Dist: pytest-cov~=4.0.0; extra == 'test'
-Requires-Dist: pytest~=7.0; extra == 'test'
-Description-Content-Type: text/markdown
+Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest-cov~=4.0.0; extra == "test"
 
 <div align="center">
 <h1>pytest-codspeed</h1>
 
 [![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.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.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)
 
@@ -80,7 +75,7 @@ Pytest plugin to create CodSpeed benchmarks
 
 ## Requirements
 
-**Python**: 3.8 and later
+**Python**: 3.9 and later
 
 **pytest**: any recent version
 
@@ -155,7 +150,7 @@ You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run
 Example workflow:
 
 ```yaml
-name: benchmarks
+name: CodSpeed
 
 on:
   push:
@@ -165,6 +160,7 @@ on:
 
 jobs:
   benchmarks:
+    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0b4 → pytest_codspeed-3.1.0}/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.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-informational.svg)
+![Python Version](https://img.shields.io/badge/python-3.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.8 and later
+**Python**: 3.9 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: benchmarks
+name: CodSpeed
 
 on:
   push:
@@ -98,6 +98,7 @@ on:
 
 jobs:
   benchmarks:
+    name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

{pytest_codspeed-3.0.0b4 → pytest_codspeed-3.1.0}/pyproject.toml

@@ -1,7 +1,3 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [project.urls]
 Homepage = "https://codspeed.io/"
 Documentation = "https://docs.codspeed.io/"
@@ -13,7 +9,7 @@ dynamic = ["version"]
 description = "Pytest plugin to create CodSpeed benchmarks"
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 authors = [{ name = "Arthur Pastel", email = "arthur@codspeed.io" }]
 keywords = ["codspeed", "benchmark", "performance", "pytest"]
 classifiers = [
@@ -23,7 +19,6 @@ 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",
@@ -36,43 +31,65 @@ classifiers = [
 ]
 dependencies = [
     "cffi >= 1.17.1",
-    # cffi doesn't automatically install setuptools with python 3.12+
-    # cf https://github.com/python-cffi/cffi/releases/tag/v1.16.0
-    "setuptools; python_full_version >= '3.12.0'",
     "pytest>=3.8",
-    "filelock >= 3.12.2",
     "rich>=13.8.1",
     "importlib-metadata>=8.5.0; python_version < '3.10'",
 ]
 
 [project.optional-dependencies]
-build = ["semver>=3.0.2"]
 lint = ["mypy ~= 1.11.2", "ruff ~= 0.6.5"]
 compat = [
-    "pytest-benchmark ~= 4.0.0",
+    "pytest-benchmark ~= 5.0.0",
     "pytest-xdist ~= 3.6.1",
     # "pytest-speed>=0.3.5",
 ]
 test = ["pytest ~= 7.0", "pytest-cov ~= 4.0.0"]
+
 [project.entry-points]
 pytest11 = { codspeed = "pytest_codspeed.plugin" }
 
-[tool.hatch.envs.default]
-python = "3.11"
-features = ["lint", "test", "compat"]
+[build-system]
+requires = ["setuptools >= 61", "cffi >= 1.17.1"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+license-files = [] # Workaround of https://github.com/astral-sh/uv/issues/9513
 
-[tool.hatch.envs.test]
-features = ["test"]
+[tool.setuptools.dynamic]
+version = { attr = "pytest_codspeed.__version__" }
 
-[[tool.hatch.envs.test.matrix]]
-python = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
-features = ["compat", "test"]
 
-[tool.hatch.version]
-path = "src/pytest_codspeed/__init__.py"
+[tool.bumpver]
+current_version = "3.1.0"
+version_pattern = "MAJOR.MINOR.PATCH[-TAG]"
+commit_message = "Release v{new_version} 🚀"
+tag_message = "Release v{new_version} 🚀"
+tag_scope = "default"
+allow_dirty = false
+pre_commit_hook = "./scripts/pre-release.sh"
+post_commit_hook = "./scripts/post-release.sh"
+commit = true
+tag = false
+push = false
+
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"']
+"src/pytest_codspeed/__init__.py" = [
+    '__version__ = "{pep440_version}"',
+    '__semver_version__ = "{version}"',
+]
+
+[tool.cibuildwheel]
+build = "cp*manylinux*"
+test-extras = ["build", "test", "compat"]
+test-command = "pytest -v --ignore={project}/tests/benchmarks {project}/tests"
 
-[tool.hatch.build.targets.sdist]
-include = ["/src"]
+[tool.cibuildwheel.linux]
+environment = { PYTEST_CODSPEED_FORCE_EXTENSION_BUILD = "1", PYTEST_CODSPEED_FORCE_VALGRIND_TESTS = "1" }
+manylinux-x86_64-image = "manylinux_2_28"
+manylinux-aarch64-image = "manylinux_2_28"
+before-all = "yum -y install valgrind-devel"
 
 [tool.mypy]
 python_version = "3.12"

pytest_codspeed-3.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pytest_codspeed-3.1.0/setup.py

@@ -0,0 +1,53 @@
+import importlib.util
+import os
+import platform
+from pathlib import Path
+
+from setuptools import setup
+
+build_path = (
+    Path(__file__).parent / "src/pytest_codspeed/instruments/valgrind/_wrapper/build.py"
+)
+
+spec = importlib.util.spec_from_file_location("build", build_path)
+assert spec is not None, "The spec should be initialized"
+build = importlib.util.module_from_spec(spec)
+assert spec.loader is not None, "The loader should be initialized"
+spec.loader.exec_module(build)
+
+system = platform.system()
+current_arch = platform.machine()
+
+print(f"System: {system} ({current_arch})")
+
+IS_EXTENSION_BUILDABLE = system == "Linux" and current_arch in [
+    "x86_64",
+    "aarch64",
+]
+
+IS_EXTENSION_REQUIRED = (
+    os.environ.get("PYTEST_CODSPEED_FORCE_EXTENSION_BUILD") is not None
+)
+if IS_EXTENSION_REQUIRED and not IS_EXTENSION_BUILDABLE:
+    raise ValueError(
+        "The extension is required but the current platform is not supported"
+    )
+
+
+ffi_extension = build.ffibuilder.distutils_extension()
+ffi_extension.optional = not IS_EXTENSION_REQUIRED
+
+print(
+    "CodSpeed native extension is "
+    + ("required" if IS_EXTENSION_REQUIRED else "optional")
+)
+
+setup(
+    package_data={
+        "pytest_codspeed": [
+            "instruments/valgrind/_wrapper/*.h",
+            "instruments/valgrind/_wrapper/*.c",
+        ]
+    },
+    ext_modules=[ffi_extension] if IS_EXTENSION_BUILDABLE else [],
+)

{pytest_codspeed-3.0.0b4 → pytest_codspeed-3.1.0}/src/pytest_codspeed/__init__.py

@@ -1,6 +1,6 @@
-__version__ = "3.0.0b4"
+__version__ = "3.1.0"
 # We also have the semver version since __version__ is not semver compliant
-__semver_version__ = "3.0.0-b4"
+__semver_version__ = "3.1.0"
 
 from .plugin import BenchmarkFixture
 

pytest_codspeed-3.1.0/src/pytest_codspeed/instruments/valgrind/_wrapper/__init__.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .wrapper import lib as LibType
+
+
+def get_lib() -> LibType:
+    try:
+        from .dist_callgrind_wrapper import lib  # type: ignore
+
+        return lib
+    except Exception as e:
+        raise Exception("Failed to get a compiled wrapper") from e

pytest_codspeed-3.1.0/src/pytest_codspeed/instruments/valgrind/_wrapper/build.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+from cffi import FFI  # type: ignore
+
+wrapper_dir = Path(__file__).parent
+
+ffibuilder = FFI()
+
+ffibuilder.cdef((wrapper_dir / "wrapper.h").read_text())
+
+ffibuilder.set_source(
+    "pytest_codspeed.instruments.valgrind._wrapper.dist_callgrind_wrapper",
+    '#include "wrapper.h"',
+    sources=["src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.c"],
+    include_dirs=[str(wrapper_dir)],
+)
+
+if __name__ == "__main__":
+    ffibuilder.compile(verbose=True)

{pytest_codspeed-3.0.0b4 → pytest_codspeed-3.1.0}/src/pytest_codspeed/plugin.py

@@ -320,6 +320,18 @@ 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.1.0/src/pytest_codspeed.egg-info/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.1
+Name: pytest-codspeed
+Version: 3.1.0
+Summary: Pytest plugin to create CodSpeed benchmarks
+Author-email: Arthur Pastel <arthur@codspeed.io>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2022 CodSpeed and contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+        
+Project-URL: Homepage, https://codspeed.io/
+Project-URL: Documentation, https://docs.codspeed.io/
+Project-URL: Source, https://github.com/CodSpeedHQ/pytest-codspeed
+Keywords: codspeed,benchmark,performance,pytest
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: cffi>=1.17.1
+Requires-Dist: pytest>=3.8
+Requires-Dist: rich>=13.8.1
+Requires-Dist: importlib-metadata>=8.5.0; python_version < "3.10"
+Provides-Extra: lint
+Requires-Dist: mypy~=1.11.2; extra == "lint"
+Requires-Dist: ruff~=0.6.5; extra == "lint"
+Provides-Extra: compat
+Requires-Dist: pytest-benchmark~=5.0.0; extra == "compat"
+Requires-Dist: pytest-xdist~=3.6.1; extra == "compat"
+Provides-Extra: test
+Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest-cov~=4.0.0; extra == "test"
+
+<div align="center">
+<h1>pytest-codspeed</h1>
+
+[![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)
+[![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)
+
+Pytest plugin to create CodSpeed benchmarks
+
+</div>
+
+## Requirements
+
+**Python**: 3.9 and later
+
+**pytest**: any recent version
+
+## Installation
+
+```shell
+pip install pytest-codspeed
+```
+
+## Usage
+
+### Creating benchmarks
+
+Creating benchmarks with `pytest-codspeed` is compatible with the standard `pytest-benchmark` API. So if you already have benchmarks written with it, you can start using `pytest-codspeed` right away.
+
+#### Marking a whole test function as a benchmark with `pytest.mark.benchmark`
+
+```python
+import pytest
+from statistics import median
+
+@pytest.mark.benchmark
+def test_median_performance():
+    return median([1, 2, 3, 4, 5])
+```
+
+#### Benchmarking selected lines of a test function with the `benchmark` fixture
+
+```python
+import pytest
+from statistics import mean
+
+def test_mean_performance(benchmark):
+    # Precompute some data useful for the benchmark but that should not be
+    # included in the benchmark time
+    data = [1, 2, 3, 4, 5]
+
+    # Benchmark the execution of the function
+    benchmark(lambda: mean(data))
+
+
+def test_mean_and_median_performance(benchmark):
+    # Precompute some data useful for the benchmark but that should not be
+    # included in the benchmark time
+    data = [1, 2, 3, 4, 5]
+
+    # Benchmark the execution of the function:
+    # The `@benchmark` decorator will automatically call the function and
+    # measure its execution
+    @benchmark
+    def bench():
+        mean(data)
+        median(data)
+```
+
+### Running benchmarks
+
+#### Testing the benchmarks locally
+
+If you want to run only the benchmarks tests locally, you can use the `--codspeed` pytest flag:
+
+```shell
+pytest tests/ --codspeed
+```
+
+> **Note:** Running `pytest-codspeed` locally will not produce any performance reporting. It's only useful for making sure that your benchmarks are working as expected. If you want to get performance reporting, you should run the benchmarks in your CI.
+
+#### In your CI
+
+You can use the [CodSpeedHQ/action](https://github.com/CodSpeedHQ/action) to run the benchmarks in Github Actions and upload the results to CodSpeed.
+
+Example workflow:
+
+```yaml
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - "main" # or "master"
+  pull_request:
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: pytest tests/ --codspeed
+```

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/SOURCES.txt

@@ -0,0 +1,26 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+src/pytest_codspeed/__init__.py
+src/pytest_codspeed/plugin.py
+src/pytest_codspeed/py.typed
+src/pytest_codspeed/utils.py
+src/pytest_codspeed.egg-info/PKG-INFO
+src/pytest_codspeed.egg-info/SOURCES.txt
+src/pytest_codspeed.egg-info/dependency_links.txt
+src/pytest_codspeed.egg-info/entry_points.txt
+src/pytest_codspeed.egg-info/requires.txt
+src/pytest_codspeed.egg-info/top_level.txt
+src/pytest_codspeed/instruments/__init__.py
+src/pytest_codspeed/instruments/walltime.py
+src/pytest_codspeed/instruments/valgrind/__init__.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/__init__.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/build.py
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.c
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.h
+src/pytest_codspeed/instruments/valgrind/_wrapper/wrapper.pyi
+tests/test_pytest_plugin.py
+tests/test_pytest_plugin_cpu_instrumentation.py
+tests/test_pytest_plugin_walltime.py
+tests/test_utils.py

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+codspeed = pytest_codspeed.plugin

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/requires.txt

@@ -0,0 +1,18 @@
+cffi>=1.17.1
+pytest>=3.8
+rich>=13.8.1
+
+[:python_version < "3.10"]
+importlib-metadata>=8.5.0
+
+[compat]
+pytest-benchmark~=5.0.0
+pytest-xdist~=3.6.1
+
+[lint]
+mypy~=1.11.2
+ruff~=0.6.5
+
+[test]
+pytest~=7.0
+pytest-cov~=4.0.0

pytest_codspeed-3.1.0/src/pytest_codspeed.egg-info/top_level.txt

@@ -0,0 +1 @@
+pytest_codspeed

pytest_codspeed-3.1.0/tests/test_pytest_plugin.py

@@ -0,0 +1,300 @@
+import pytest
+from conftest import (
+    IS_PERF_TRAMPOLINE_SUPPORTED,
+    MeasurementMode,
+    run_pytest_codspeed_with_mode,
+    skip_with_perf_trampoline,
+    skip_without_pytest_benchmark,
+    skip_without_valgrind,
+)
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_plugin_enabled_with_kwargs(
+    pytester: pytest.Pytester, mode: MeasurementMode
+) -> None:
+    pytester.makepyfile(
+        """
+        def test_arg_kwarg_addition(benchmark):
+            def fn(arg, kwarg=None):
+                assert arg + kwarg == 40
+            benchmark(fn, 25, kwarg=15)
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, mode)
+    result.assert_outcomes(passed=1)
+
+
+@skip_without_valgrind
+@skip_with_perf_trampoline
+def test_bench_enabled_header_without_perf(
+    pytester: pytest.Pytester, codspeed_env
+) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    with codspeed_env():
+        result = pytester.runpytest()
+    result.stdout.fnmatch_lines(
+        ["codspeed: * (enabled, mode: instrumentation, callgraph: not supported)"]
+    )
+
+
+@skip_without_valgrind
+def test_plugin_enabled_by_env(pytester: pytest.Pytester, codspeed_env) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    with codspeed_env():
+        result = pytester.runpytest()
+    result.stdout.fnmatch_lines(["*1 benchmarked*", "*1 passed*"])
+
+
+@skip_without_valgrind
+def test_plugin_enabled_and_env(pytester: pytest.Pytester, codspeed_env) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    with codspeed_env():
+        result = pytester.runpytest("--codspeed")
+    result.stdout.fnmatch_lines(["*1 benchmarked*", "*1 passed*"])
+
+
+@skip_without_valgrind
+def test_plugin_enabled_and_env_bench_run_once(
+    pytester: pytest.Pytester, codspeed_env
+) -> None:
+    pytester.makepyfile(
+        """
+        import pytest
+
+        @pytest.mark.benchmark
+        def test_noisy_bench_marked():
+            print() # make sure noise is on its own line
+            print("I'm noisy marked!!!")
+            print()
+
+        def test_noisy_bench_fxt(benchmark):
+            @benchmark
+            def _():
+                print() # make sure noise is on its own line
+                print("I'm noisy fixtured!!!")
+                print()
+        """
+    )
+    EXPECTED_OUTPUT_COUNT = 2 if IS_PERF_TRAMPOLINE_SUPPORTED else 1
+    with codspeed_env():
+        run_result = pytester.runpytest("--codspeed", "-s")
+        print(run_result.stdout.str())
+        assert run_result.outlines.count("I'm noisy marked!!!") == EXPECTED_OUTPUT_COUNT
+        assert (
+            run_result.outlines.count("I'm noisy fixtured!!!") == EXPECTED_OUTPUT_COUNT
+        )
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_plugin_enabled_and_env_bench_hierachy_called(
+    pytester: pytest.Pytester, mode: MeasurementMode
+) -> None:
+    pytester.makepyfile(
+        """
+        import pytest
+        import time
+
+        class TestGroup:
+            def setup_method(self):
+                print(); print("Setup called")
+
+            def teardown_method(self):
+                print(); print("Teardown called")
+
+            @pytest.mark.benchmark
+            def test_child(self):
+                time.sleep(0.1) # Avoids the test being too fast
+                print(); print("Test called")
+
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, mode, "-s")
+    result.stdout.fnmatch_lines(
+        [
+            "Setup called",
+            "Test called",
+            "Teardown called",
+        ]
+    )
+
+
+def test_plugin_disabled(pytester: pytest.Pytester) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    result = pytester.runpytest()
+    result.stdout.fnmatch_lines(["*1 passed*"])
+
+
+@skip_without_valgrind
+def test_plugin_enabled_nothing_to_benchmark(
+    pytester: pytest.Pytester, codspeed_env
+) -> None:
+    pytester.makepyfile(
+        """
+        def test_some_addition_performance():
+            return 1 + 1
+        """
+    )
+    with codspeed_env():
+        result = pytester.runpytest("--codspeed")
+    result.stdout.fnmatch_lines(["*0 benchmarked*", "*1 deselected*"])
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_plugin_only_benchmark_collection(
+    pytester: pytest.Pytester, mode: MeasurementMode
+) -> None:
+    pytester.makepyfile(
+        """
+        import pytest
+
+        @pytest.mark.codspeed_benchmark
+        def test_some_addition_performance():
+            return 1 + 1
+
+        @pytest.mark.benchmark
+        def test_some_addition_performance_shorthand():
+            return 1 + 1
+
+        def test_some_wrapped_benchmark(benchmark):
+            @benchmark
+            def _():
+                hello = "hello"
+
+        def test_another_useless_thing():
+            assert True
+        """
+    )
+    collection_result = run_pytest_codspeed_with_mode(pytester, mode, "--collect-only")
+
+    collection_result.stdout.fnmatch_lines_random(
+        [
+            "*<Function test_some_addition_performance>*",
+            "*<Function test_some_addition_performance_shorthand>*",
+            "*<Function test_some_wrapped_benchmark>*",
+        ],
+    )
+    collection_result.assert_outcomes(
+        deselected=1,
+    )
+
+    collection_result = run_pytest_codspeed_with_mode(
+        pytester, mode, "--collect-only", "-k", "test_some_wrapped_benchmark"
+    )
+    collection_result.stdout.fnmatch_lines_random(
+        [
+            "*<Function test_some_wrapped_benchmark>*",
+        ],
+    )
+    collection_result.assert_outcomes(
+        deselected=3,
+    )
+
+
+@skip_without_pytest_benchmark
+def test_pytest_benchmark_compatibility(pytester: pytest.Pytester) -> None:
+    pytester.makepyfile(
+        """
+        def test_some_wrapped_benchmark(benchmark):
+            @benchmark
+            def _():
+                hello = "hello"
+        """
+    )
+    result = pytester.runpytest(
+        "--benchmark-only",
+        "--benchmark-max-time=0",
+        "--benchmark-warmup-iterations=1",
+    )
+    result.stdout.fnmatch_lines_random(
+        [
+            "*benchmark: 1 tests*",
+            "*Name*",
+            "*test_some_wrapped_benchmark*",
+            "*Legend:*",
+            "*Outliers:*",
+            "*OPS: Operations Per Second*",
+            "*Outliers:*",
+            "*1 passed*",
+        ]
+    )
+
+
+def test_pytest_benchmark_extra_info(pytester: pytest.Pytester) -> None:
+    """https://pytest-benchmark.readthedocs.io/en/latest/usage.html#extra-info"""
+    pytester.makepyfile(
+        """
+        import time
+
+        def test_my_stuff(benchmark):
+            benchmark.extra_info['foo'] = 'bar'
+            benchmark(time.sleep, 0.02)
+        """
+    )
+    result = pytester.runpytest("--codspeed")
+    assert result.ret == 0, "the run should have succeeded"
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_pytest_benchmark_return_value(
+    pytester: pytest.Pytester, mode: MeasurementMode
+) -> None:
+    pytester.makepyfile(
+        """
+        def calculate_something():
+            return 1 + 1
+
+        def test_my_stuff(benchmark):
+            value = benchmark(calculate_something)
+            assert value == 2
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, mode)
+    assert result.ret == 0, "the run should have succeeded"
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_print(pytester: pytest.Pytester, mode: MeasurementMode) -> None:
+    """Test print statements are captured by pytest (i.e., not printed to terminal in
+    the middle of the progress bar) and only displayed after test run (on failures)."""
+    pytester.makepyfile(
+        """
+        import pytest, sys
+
+        @pytest.mark.benchmark
+        def test_print():
+            print("print to stdout")
+            print("print to stderr", file=sys.stderr)
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, mode)
+    assert result.ret == 0, "the run should have succeeded"
+    result.assert_outcomes(passed=1)
+    result.stdout.no_fnmatch_line("*print to stdout*")
+    result.stderr.no_fnmatch_line("*print to stderr*")
+
+
+@pytest.mark.parametrize("mode", [*MeasurementMode])
+def test_capsys(pytester: pytest.Pytester, mode: MeasurementMode):
+    """Test print statements are captured by capsys (i.e., not printed to terminal in
+    the middle of the progress bar) and can be inspected within test."""
+    pytester.makepyfile(
+        """
+        import pytest, sys
+
+        @pytest.mark.benchmark
+        def test_capsys(capsys):
+            print("print to stdout")
+            print("print to stderr", file=sys.stderr)
+
+            stdout, stderr = capsys.readouterr()
+
+            assert stdout == "print to stdout\\n"
+            assert stderr == "print to stderr\\n"
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, mode)
+    assert result.ret == 0, "the run should have succeeded"
+    result.assert_outcomes(passed=1)
+    result.stdout.no_fnmatch_line("*print to stdout*")
+    result.stderr.no_fnmatch_line("*print to stderr*")

pytest_codspeed-3.1.0/tests/test_pytest_plugin_cpu_instrumentation.py

@@ -0,0 +1,118 @@
+import os
+
+import pytest
+from conftest import (
+    run_pytest_codspeed_with_mode,
+    skip_with_pytest_benchmark,
+    skip_without_perf_trampoline,
+    skip_without_pytest_xdist,
+    skip_without_valgrind,
+)
+
+from pytest_codspeed.instruments import MeasurementMode
+
+
+@skip_without_valgrind
+@skip_without_perf_trampoline
+def test_bench_enabled_header_with_perf(
+    pytester: pytest.Pytester, codspeed_env
+) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    with codspeed_env():
+        result = pytester.runpytest()
+    result.stdout.fnmatch_lines(
+        ["codspeed: * (enabled, mode: instrumentation, callgraph: enabled)"]
+    )
+
+
+def test_plugin_enabled_cpu_instrumentation_without_env(
+    pytester: pytest.Pytester,
+) -> None:
+    pytester.makepyfile(
+        """
+        def test_some_addition_performance(benchmark):
+            @benchmark
+            def _():
+                return 1 + 1
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, MeasurementMode.Instrumentation)
+    result.stdout.fnmatch_lines(
+        [
+            (
+                "*NOTICE: codspeed is enabled, but no "
+                "performance measurement will be made*"
+            ),
+            "*1 benchmark tested*",
+            "*1 passed*",
+        ]
+    )
+
+
+@skip_without_valgrind
+@skip_without_perf_trampoline
+def test_perf_maps_generation(pytester: pytest.Pytester, codspeed_env) -> None:
+    pytester.makepyfile(
+        """
+        import pytest
+
+        @pytest.mark.benchmark
+        def test_some_addition_marked():
+            assert 1 + 1
+
+        def test_some_addition_fixtured(benchmark):
+            @benchmark
+            def fixtured_child():
+                assert 1 + 1
+        """
+    )
+    with codspeed_env():
+        result = pytester.runpytest("--codspeed")
+    result.stdout.fnmatch_lines(["*2 benchmarked*", "*2 passed*"])
+    current_pid = os.getpid()
+    perf_filepath = f"/tmp/perf-{current_pid}.map"
+    print(perf_filepath)
+
+    with open(perf_filepath) as perf_file:
+        lines = perf_file.readlines()
+        assert any(
+            "py::ValgrindInstrument.measure.<locals>.__codspeed_root_frame__" in line
+            for line in lines
+        ), "No root frame found in perf map"
+        assert any(
+            "py::test_some_addition_marked" in line for line in lines
+        ), "No marked test frame found in perf map"
+        assert any(
+            "py::test_some_addition_fixtured" in line for line in lines
+        ), "No fixtured test frame found in perf map"
+        assert any(
+            "py::test_some_addition_fixtured.<locals>.fixtured_child" in line
+            for line in lines
+        ), "No fixtured child test frame found in perf map"
+
+
+@skip_without_valgrind
+@skip_with_pytest_benchmark
+@skip_without_pytest_xdist
+def test_pytest_xdist_concurrency_compatibility(
+    pytester: pytest.Pytester, codspeed_env
+) -> None:
+    pytester.makepyfile(
+        """
+        import time, pytest
+
+        def do_something():
+            time.sleep(1)
+
+        @pytest.mark.parametrize("i", range(256))
+        def test_my_stuff(benchmark, i):
+            benchmark(do_something)
+        """
+    )
+    # Run the test multiple times to reduce the chance of a false positive
+    ITERATIONS = 5
+    for i in range(ITERATIONS):
+        with codspeed_env():
+            result = pytester.runpytest("--codspeed", "-n", "128")
+        assert result.ret == 0, "the run should have succeeded"
+        result.stdout.fnmatch_lines(["*256 passed*"])

pytest_codspeed-3.1.0/tests/test_pytest_plugin_walltime.py

@@ -0,0 +1,37 @@
+import pytest
+from conftest import run_pytest_codspeed_with_mode
+
+from pytest_codspeed.instruments import MeasurementMode
+
+
+def test_bench_enabled_header_with_perf(
+    pytester: pytest.Pytester,
+) -> None:
+    pytester.copy_example("tests/examples/test_addition_fixture.py")
+    result = run_pytest_codspeed_with_mode(pytester, MeasurementMode.WallTime)
+    result.stdout.fnmatch_lines(["*test_some_addition_performance*", "*1 benchmarked*"])
+
+
+def test_parametrization_naming(
+    pytester: pytest.Pytester,
+) -> None:
+    pytester.makepyfile(
+        """
+        import time, pytest
+
+        @pytest.mark.parametrize("inp", ["toto", 12, 58.3])
+        def test_my_stuff(benchmark, inp):
+            benchmark(lambda: time.sleep(0.01))
+        """
+    )
+    result = run_pytest_codspeed_with_mode(pytester, MeasurementMode.WallTime)
+    # Make sure the parametrization is not broken
+    print(result.outlines)
+    result.stdout.fnmatch_lines_random(
+        [
+            "*test_my_stuff[[]toto[]]*",
+            "*test_my_stuff[[]12[]]*",
+            "*test_my_stuff[[]58.3[]]*",
+            "*3 benchmarked*",
+        ]
+    )

pytest_codspeed-3.1.0/tests/test_utils.py

@@ -0,0 +1,34 @@
+import tempfile
+from contextlib import contextmanager
+from pathlib import Path
+
+from pytest_codspeed.utils import get_git_relative_path, get_git_relative_uri_and_name
+
+
+@contextmanager
+def TemporaryGitRepo():
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        (Path(tmpdirname) / ".git").mkdir(parents=True)
+        yield tmpdirname
+
+
+def test_get_git_relative_path_found():
+    with TemporaryGitRepo() as tmp_repo:
+        path = Path(tmp_repo) / "folder/nested_folder"
+        assert get_git_relative_path(path) == Path("folder/nested_folder")
+
+
+def test_get_git_relative_path_not_found():
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        path = Path(tmp_dir) / "folder"
+        assert get_git_relative_path(path) == path
+
+
+def test_get_git_relative_uri():
+    with TemporaryGitRepo() as tmp_repo:
+        pytest_rootdir = Path(tmp_repo) / "pytest_root"
+        uri = "testing/test_excinfo.py::TestFormattedExcinfo::test_fn"
+        assert get_git_relative_uri_and_name(uri, pytest_rootdir) == (
+            "pytest_root/testing/test_excinfo.py::TestFormattedExcinfo::test_fn",
+            "TestFormattedExcinfo::test_fn",
+        )

pytest_codspeed-3.0.0b4/.gitignore

@@ -1,166 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-.venvubuntu
-.python-version
-*.o
-
-.codspeed

pytest_codspeed-3.0.0b4/src/pytest_codspeed/instruments/valgrind/_wrapper/.gitignore

@@ -1,2 +0,0 @@
-dist_callgrind_wrapper.*
-build.lock

pytest_codspeed-3.0.0b4/src/pytest_codspeed/instruments/valgrind/_wrapper/__init__.py

@@ -1,40 +0,0 @@
-from __future__ import annotations
-
-import os
-from typing import TYPE_CHECKING
-
-from cffi import FFI  # type: ignore
-from filelock import FileLock
-
-if TYPE_CHECKING:
-    from .wrapper import lib as LibType
-
-_wrapper_dir = os.path.dirname(os.path.abspath(__file__))
-
-
-def _get_ffi():
-    ffi = FFI()
-    with open(f"{_wrapper_dir}/wrapper.h") as f:
-        ffi.cdef(f.read())
-    ffi.set_source(
-        "dist_callgrind_wrapper",
-        '#include "wrapper.h"',
-        sources=["wrapper.c"],
-    )
-    return ffi
-
-
-def get_lib() -> LibType:
-    try:
-        ffi = _get_ffi()
-        build_lock = FileLock(f"{_wrapper_dir}/build.lock")
-        with build_lock:
-            ffi.compile(
-                target="dist_callgrind_wrapper.*",
-                tmpdir=_wrapper_dir,
-            )
-        from .dist_callgrind_wrapper import lib  # type: ignore
-
-        return lib
-    except Exception as e:
-        raise Exception("Failed to compile the wrapper") from e