pytest-codspeed 4.2.0__tar.gz → 4.3.0__tar.gz

{pytest_codspeed-4.2.0/src/pytest_codspeed.egg-info → pytest_codspeed-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codspeed
-Version: 4.2.0
+Version: 4.3.0
 Summary: Pytest plugin to create CodSpeed benchmarks
 Author-email: Arthur Pastel <arthur@codspeed.io>
 License: The MIT License (MIT)
@@ -60,7 +60,7 @@ Requires-Dist: pytest-xdist~=3.6.1; extra == "compat"
 
 [![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.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-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)
 
@@ -118,10 +118,10 @@ If you want to run the benchmarks tests locally, you can use the `--codspeed` py
 ```sh
 $ pytest tests/ --codspeed
 ============================= test session starts ====================
-platform darwin -- Python 3.13.0, pytest-7.4.4, pluggy-1.5.0
-codspeed: 3.0.0 (enabled, mode: walltime, timer_resolution: 41.7ns)
+platform darwin -- Python 3.14.0, pytest-7.4.4, pluggy-1.5.0
+codspeed: 4.2.0 (enabled, mode: walltime, timer_resolution: 41.7ns)
 rootdir: /home/user/codspeed-test, configfile: pytest.ini
-plugins: codspeed-3.0.0
+plugins: codspeed-4.2.0
 collected 1 items
 
 tests/test_sum_squares.py .                                    [ 100%]
@@ -159,10 +159,10 @@ jobs:
     name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
         with:
-          python-version: "3.13"
+          python-version: "3.14"
 
       - name: Install dependencies
         run: pip install -r requirements.txt
@@ -170,7 +170,7 @@ jobs:
       - name: Run benchmarks
         uses: CodSpeedHQ/action@v4
         with:
-          mode: instrumentation   # or `walltime`
+          mode: simulation # or `walltime`
           token: ${{ secrets.CODSPEED_TOKEN }}
           run: pytest tests/ --codspeed
 ```

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.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.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%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-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)
 
@@ -61,10 +61,10 @@ If you want to run the benchmarks tests locally, you can use the `--codspeed` py
 ```sh
 $ pytest tests/ --codspeed
 ============================= test session starts ====================
-platform darwin -- Python 3.13.0, pytest-7.4.4, pluggy-1.5.0
-codspeed: 3.0.0 (enabled, mode: walltime, timer_resolution: 41.7ns)
+platform darwin -- Python 3.14.0, pytest-7.4.4, pluggy-1.5.0
+codspeed: 4.2.0 (enabled, mode: walltime, timer_resolution: 41.7ns)
 rootdir: /home/user/codspeed-test, configfile: pytest.ini
-plugins: codspeed-3.0.0
+plugins: codspeed-4.2.0
 collected 1 items
 
 tests/test_sum_squares.py .                                    [ 100%]
@@ -102,10 +102,10 @@ jobs:
     name: Run benchmarks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
         with:
-          python-version: "3.13"
+          python-version: "3.14"
 
       - name: Install dependencies
         run: pip install -r requirements.txt
@@ -113,7 +113,7 @@ jobs:
       - name: Run benchmarks
         uses: CodSpeedHQ/action@v4
         with:
-          mode: instrumentation   # or `walltime`
+          mode: simulation # or `walltime`
           token: ${{ secrets.CODSPEED_TOKEN }}
           run: pytest tests/ --codspeed
 ```

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/pyproject.toml

@@ -44,6 +44,11 @@ compat = [
     # "pytest-speed>=0.3.5",
 ]
 
+[tool.uv]
+# Python builds change with uv versions, and we are quite susceptible to that.
+# We pin uv to to make sure reproducibility is maintained for any contributor.
+required-version = "0.9.5"
+
 [tool.uv.sources]
 pytest-codspeed = { workspace = true }
 
@@ -72,7 +77,7 @@ version = { attr = "pytest_codspeed.__version__" }
 
 
 [tool.bumpver]
-current_version = "4.2.0"
+current_version = "4.3.0"
 version_pattern = "MAJOR.MINOR.PATCH[-TAG[NUM]]"
 commit_message = "Release v{new_version} 🚀"
 tag_message = "Release v{new_version} 🚀"

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/src/pytest_codspeed/__init__.py

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

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/src/pytest_codspeed/instruments/__init__.py

@@ -21,7 +21,7 @@ class Instrument(metaclass=ABCMeta):
     instrument: ClassVar[str]
 
     @abstractmethod
-    def __init__(self, config: CodSpeedConfig): ...
+    def __init__(self, config: CodSpeedConfig, mode: MeasurementMode): ...
 
     @abstractmethod
     def get_instrument_config_str_and_warns(self) -> tuple[str, list[str]]: ...
@@ -56,17 +56,25 @@ class Instrument(metaclass=ABCMeta):
 
 
 class MeasurementMode(str, Enum):
-    Instrumentation = "instrumentation"
+    Simulation = "simulation"
+    Memory = "memory"
     WallTime = "walltime"
 
+    @classmethod
+    def _missing_(cls, value: object):
+        # Accept "instrumentation" as deprecated alias for "simulation"
+        if value == "instrumentation":
+            return cls.Simulation
+        return None
+
 
 def get_instrument_from_mode(mode: MeasurementMode) -> type[Instrument]:
-    from pytest_codspeed.instruments.valgrind import (
-        ValgrindInstrument,
+    from pytest_codspeed.instruments.analysis import (
+        AnalysisInstrument,
     )
     from pytest_codspeed.instruments.walltime import WallTimeInstrument
 
-    if mode == MeasurementMode.Instrumentation:
-        return ValgrindInstrument
+    if mode in (MeasurementMode.Simulation, MeasurementMode.Memory):
+        return AnalysisInstrument
     else:
         return WallTimeInstrument

pytest_codspeed-4.2.0/src/pytest_codspeed/instruments/valgrind.py → pytest_codspeed-4.3.0/src/pytest_codspeed/instruments/analysis.py

@@ -6,7 +6,10 @@ from typing import TYPE_CHECKING
 
 from pytest_codspeed import __semver_version__
 from pytest_codspeed.instruments import Instrument
-from pytest_codspeed.instruments.hooks import InstrumentHooks
+from pytest_codspeed.instruments.hooks import (
+    FEATURE_DISABLE_CALLGRIND_MARKERS,
+    InstrumentHooks,
+)
 from pytest_codspeed.utils import SUPPORTS_PERF_TRAMPOLINE
 
 if TYPE_CHECKING:
@@ -15,15 +18,17 @@ if TYPE_CHECKING:
     from pytest import Session
 
     from pytest_codspeed.config import PedanticOptions
-    from pytest_codspeed.instruments import P, T
+    from pytest_codspeed.instruments import MeasurementMode, P, T
     from pytest_codspeed.plugin import BenchmarkMarkerOptions, CodSpeedConfig
 
 
-class ValgrindInstrument(Instrument):
-    instrument = "valgrind"
+class AnalysisInstrument(Instrument):
+    instrument = "analysis"
     instrument_hooks: InstrumentHooks | None
+    mode: MeasurementMode
 
-    def __init__(self, config: CodSpeedConfig) -> None:
+    def __init__(self, config: CodSpeedConfig, mode: MeasurementMode) -> None:
+        self.mode = mode
         self.benchmark_count = 0
         try:
             self.instrument_hooks = InstrumentHooks()
@@ -31,7 +36,7 @@ class ValgrindInstrument(Instrument):
         except RuntimeError as e:
             if os.environ.get("CODSPEED_ENV") is not None:
                 raise Exception(
-                    "Failed to initialize CPU simulation instrument hooks"
+                    f"Failed to initialize {self.mode.value} instrument hooks"
                 ) from e
             self.instrument_hooks = None
 
@@ -39,7 +44,7 @@ class ValgrindInstrument(Instrument):
 
     def get_instrument_config_str_and_warns(self) -> tuple[str, list[str]]:
         config = (
-            f"mode: instrumentation, "
+            f"mode: {self.mode.value}, "
             f"callgraph: {'enabled' if SUPPORTS_PERF_TRAMPOLINE else 'not supported'}"
         )
         warnings = []
@@ -73,6 +78,9 @@ class ValgrindInstrument(Instrument):
             # Warmup CPython performance map cache
             __codspeed_root_frame__()
 
+        self.instrument_hooks.set_feature(FEATURE_DISABLE_CALLGRIND_MARKERS, True)
+        self.instrument_hooks.start_benchmark()
+
         # Manually call the library function to avoid an extra stack frame. Also
         # call the callgrind markers directly to avoid extra overhead.
         self.instrument_hooks.lib.callgrind_start_instrumentation()
@@ -81,6 +89,7 @@ class ValgrindInstrument(Instrument):
         finally:
             # Ensure instrumentation is stopped even if the test failed
             self.instrument_hooks.lib.callgrind_stop_instrumentation()
+            self.instrument_hooks.stop_benchmark()
             self.instrument_hooks.set_executed_benchmark(uri)
 
     def measure_pedantic(
@@ -92,8 +101,8 @@ class ValgrindInstrument(Instrument):
     ) -> T:
         if pedantic_options.rounds != 1 or pedantic_options.iterations != 1:
             warnings.warn(
-                "Valgrind instrument ignores rounds and iterations settings "
-                "in pedantic mode"
+                f"{self.mode.value.capitalize()} instrument ignores rounds and "
+                "iterations settings in pedantic mode"
             )
         if not self.instrument_hooks:
             args, kwargs = pedantic_options.setup_and_get_args_kwargs()
@@ -117,11 +126,18 @@ class ValgrindInstrument(Instrument):
 
         # Compute the actual result of the function
         args, kwargs = pedantic_options.setup_and_get_args_kwargs()
+
+        self.instrument_hooks.set_feature(FEATURE_DISABLE_CALLGRIND_MARKERS, True)
+        self.instrument_hooks.start_benchmark()
+
+        # Manually call the library function to avoid an extra stack frame. Also
+        # call the callgrind markers directly to avoid extra overhead.
         self.instrument_hooks.lib.callgrind_start_instrumentation()
         try:
             out = __codspeed_root_frame__(*args, **kwargs)
         finally:
             self.instrument_hooks.lib.callgrind_stop_instrumentation()
+            self.instrument_hooks.stop_benchmark()
             self.instrument_hooks.set_executed_benchmark(uri)
             if pedantic_options.teardown is not None:
                 pedantic_options.teardown(*args, **kwargs)
@@ -140,5 +156,5 @@ class ValgrindInstrument(Instrument):
     def get_result_dict(self) -> dict[str, Any]:
         return {
             "instrument": {"type": self.instrument},
-            # bench results will be dumped by valgrind
+            # bench results will be dumped by the runner
         }

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/src/pytest_codspeed/instruments/hooks/__init__.py

@@ -10,6 +10,9 @@ from pytest_codspeed.utils import SUPPORTS_PERF_TRAMPOLINE
 if TYPE_CHECKING:
     from .dist_instrument_hooks import InstrumentHooksPointer, LibType
 
+# Feature flags for instrument hooks
+FEATURE_DISABLE_CALLGRIND_MARKERS = 0
+
 
 class InstrumentHooks:
     """Zig library wrapper class providing benchmark measurement functionality."""
@@ -78,5 +81,14 @@ class InstrumentHooks:
             warnings.warn("Failed to set integration name and version", RuntimeWarning)
 
     def is_instrumented(self) -> bool:
-        """Check if instrumentation is active."""
+        """Check if simulation is active."""
         return self.lib.instrument_hooks_is_instrumented(self.instance)
+
+    def set_feature(self, feature: int, enabled: bool) -> None:
+        """Set a feature flag in the instrument hooks library.
+
+        Args:
+            feature: The feature flag to set
+            enabled: Whether to enable or disable the feature
+        """
+        self.lib.instrument_hooks_set_feature(feature, enabled)

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/src/pytest_codspeed/instruments/hooks/build.py

@@ -34,6 +34,8 @@ uint64_t instrument_hooks_current_timestamp(void);
 
 void callgrind_start_instrumentation();
 void callgrind_stop_instrumentation();
+
+void instrument_hooks_set_feature(uint64_t feature, bool enabled);
 """)
 
 ffibuilder.set_source(

{pytest_codspeed-4.2.0 → pytest_codspeed-4.3.0}/src/pytest_codspeed/instruments/hooks/dist_instrument_hooks.pyi

@@ -29,5 +29,7 @@ class lib:
     def callgrind_start_instrumentation() -> int: ...
     @staticmethod
     def callgrind_stop_instrumentation() -> int: ...
+    @staticmethod
+    def instrument_hooks_set_feature(feature: int, enabled: bool) -> None: ...
 
 LibType = type[lib]