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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-codspeed
-Version: 4.3.0
+Version: 4.4.0
 Summary: Pytest plugin to create CodSpeed benchmarks
 Author-email: Arthur Pastel <arthur@codspeed.io>
 License: The MIT License (MIT)

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

@@ -77,7 +77,7 @@ version = { attr = "pytest_codspeed.__version__" }
 
 
 [tool.bumpver]
-current_version = "4.3.0"
+current_version = "4.4.0"
 version_pattern = "MAJOR.MINOR.PATCH[-TAG[NUM]]"
 commit_message = "Release v{new_version} 🚀"
 tag_message = "Release v{new_version} 🚀"

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

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

{pytest_codspeed-4.3.0 → pytest_codspeed-4.4.0}/src/pytest_codspeed/instruments/analysis.py

@@ -33,6 +33,7 @@ class AnalysisInstrument(Instrument):
         try:
             self.instrument_hooks = InstrumentHooks()
             self.instrument_hooks.set_integration("pytest-codspeed", __semver_version__)
+            self.instrument_hooks.collect_and_write_python_environment()
         except RuntimeError as e:
             if os.environ.get("CODSPEED_ENV") is not None:
                 raise Exception(

pytest_codspeed-4.4.0/src/pytest_codspeed/instruments/hooks/__init__.py

@@ -0,0 +1,197 @@
+from __future__ import annotations
+
+import os
+import platform
+import shlex
+import sys
+import sysconfig
+import warnings
+from typing import TYPE_CHECKING
+
+from pytest_codspeed.utils import SUPPORTS_PERF_TRAMPOLINE
+
+if TYPE_CHECKING:
+    from cffi import FFI
+
+    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."""
+
+    lib: LibType
+    ffi: FFI
+    instance: InstrumentHooksPointer
+
+    def __init__(self) -> None:
+        if os.environ.get("CODSPEED_ENV") is None:
+            raise RuntimeError(
+                "Can't run benchmarks outside of CodSpeed environment."
+                "Please set the CODSPEED_ENV environment variable."
+            )
+
+        try:
+            from .dist_instrument_hooks import ffi, lib  # type: ignore
+        except ImportError as e:
+            raise RuntimeError(f"Failed to load instrument hooks library: {e}") from e
+        self.lib = lib
+        self.ffi = ffi
+
+        self.instance = self.lib.instrument_hooks_init()
+        if self.instance == 0:
+            raise RuntimeError("Failed to initialize CodSpeed instrumentation library.")
+
+        if SUPPORTS_PERF_TRAMPOLINE and not sys.is_stack_trampoline_active():
+            sys.activate_stack_trampoline("perf")  # type: ignore
+
+    def __del__(self):
+        if hasattr(self, "lib") and hasattr(self, "instance"):
+            self.lib.instrument_hooks_deinit(self.instance)
+
+    def start_benchmark(self) -> None:
+        """Start a new benchmark measurement."""
+        ret = self.lib.instrument_hooks_start_benchmark(self.instance)
+        if ret != 0:
+            warnings.warn("Failed to start benchmark measurement", RuntimeWarning)
+
+    def stop_benchmark(self) -> None:
+        """Stop the current benchmark measurement."""
+        ret = self.lib.instrument_hooks_stop_benchmark(self.instance)
+        if ret != 0:
+            warnings.warn("Failed to stop benchmark measurement", RuntimeWarning)
+
+    def set_executed_benchmark(self, uri: str, pid: int | None = None) -> None:
+        """Set the executed benchmark URI and process ID.
+
+        Args:
+            uri: The benchmark URI string identifier
+            pid: Optional process ID (defaults to current process)
+        """
+        if pid is None:
+            pid = os.getpid()
+
+        ret = self.lib.instrument_hooks_set_executed_benchmark(
+            self.instance, pid, uri.encode("ascii")
+        )
+        if ret != 0:
+            warnings.warn("Failed to set executed benchmark", RuntimeWarning)
+
+    def set_integration(self, name: str, version: str) -> None:
+        """Set the integration name and version."""
+        ret = self.lib.instrument_hooks_set_integration(
+            self.instance, name.encode("ascii"), version.encode("ascii")
+        )
+        if ret != 0:
+            warnings.warn("Failed to set integration name and version", RuntimeWarning)
+
+    def is_instrumented(self) -> bool:
+        """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)
+
+    def set_environment(self, section_name: str, key: str, value: str) -> None:
+        """Register a key-value pair under a named section for environment collection.
+
+        Args:
+            section_name: The section name (e.g. "Python")
+            key: The key (e.g. "version")
+            value: The value (e.g. "3.13.12")
+        """
+        ret = self.lib.instrument_hooks_set_environment(
+            self.instance,
+            section_name.encode("utf-8"),
+            key.encode("utf-8"),
+            value.encode("utf-8"),
+        )
+        if ret != 0:
+            warnings.warn("Failed to set environment data", RuntimeWarning)
+
+    def set_environment_list(
+        self, section_name: str, key: str, values: list[str]
+    ) -> None:
+        """Register a list of values under a named section for environment collection.
+
+        Args:
+            section_name: The section name (e.g. "python")
+            key: The key (e.g. "build_args")
+            values: The list of string values
+        """
+        encoded = [self.ffi.new("char[]", v.encode("utf-8")) for v in values]
+        c_values = self.ffi.new("char*[]", encoded)
+        ret = self.lib.instrument_hooks_set_environment_list(
+            self.instance,
+            section_name.encode("utf-8"),
+            key.encode("utf-8"),
+            c_values,
+            len(encoded),
+        )
+        if ret != 0:
+            warnings.warn("Failed to set environment list data", RuntimeWarning)
+
+    def write_environment(self, pid: int | None = None) -> None:
+        """Flush all registered environment sections to disk.
+
+        Writes to $CODSPEED_PROFILE_FOLDER/environment-<pid>.json.
+
+        Args:
+            pid: Optional process ID (defaults to current process)
+        """
+        if pid is None:
+            pid = os.getpid()
+        ret = self.lib.instrument_hooks_write_environment(self.instance, pid)
+        if ret != 0:
+            warnings.warn("Failed to write environment data", RuntimeWarning)
+
+    def collect_and_write_python_environment(self) -> None:
+        """Collect Python toolchain information and write it to disk."""
+        section = "python"
+        set_env = self.set_environment
+
+        # Core identity
+        set_env(section, "version", sys.version.strip())
+        set_env(section, "implementation", sys.implementation.name.strip())
+        set_env(section, "compiler", platform.python_compiler().strip())
+
+        config_vars = sysconfig.get_config_vars()
+
+        # Build arguments as a list
+        config_args = config_vars.get("CONFIG_ARGS", "")
+        if config_args:
+            build_args = [arg.strip() for arg in shlex.split(config_args)]
+            self.set_environment_list(section, "build_args", build_args)
+
+        # Performance-relevant build configuration as "KEY=value" list
+        _SYSCONFIG_KEYS = (
+            "abiflags",
+            "PY_ENABLE_SHARED",
+            "Py_GIL_DISABLED",
+            "Py_DEBUG",
+            "WITH_PYMALLOC",
+            "WITH_MIMALLOC",
+            "WITH_FREELISTS",
+            "HAVE_COMPUTED_GOTOS",
+            "Py_STATS",
+            "Py_TRACE_REFS",
+            "WITH_VALGRIND",
+            "WITH_DTRACE",
+        )
+        config_items = []
+        for key in _SYSCONFIG_KEYS:
+            value = config_vars.get(key)
+            if value is not None:
+                config_items.append(f"{key}={str(value).strip()}")
+        config_items.append(f"perf_trampoline={SUPPORTS_PERF_TRAMPOLINE}")
+        self.set_environment_list(section, "config", config_items)
+
+        self.write_environment()

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

@@ -36,6 +36,15 @@ void callgrind_start_instrumentation();
 void callgrind_stop_instrumentation();
 
 void instrument_hooks_set_feature(uint64_t feature, bool enabled);
+
+uint8_t instrument_hooks_set_environment(InstrumentHooks *, const char *section_name,
+                                         const char *key, const char *value);
+uint8_t instrument_hooks_set_environment_list(InstrumentHooks *,
+                                              const char *section_name,
+                                              const char *key,
+                                              const char *const *values,
+                                              uint32_t count);
+uint8_t instrument_hooks_write_environment(InstrumentHooks *, uint32_t pid);
 """)
 
 ffibuilder.set_source(
@@ -47,6 +56,8 @@ ffibuilder.set_source(
         "src/pytest_codspeed/instruments/hooks/instrument-hooks/dist/core.c",
     ],
     include_dirs=[str(includes_dir)],
+    # IMPORTANT: Keep in sync with instrument-hooks/ci.yml (COMMON_CFLAGS)
+    extra_compile_args=["-Wno-format-security"],
 )
 
 if __name__ == "__main__":

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

@@ -1,3 +1,5 @@
+from cffi import FFI
+
 InstrumentHooksPointer = object
 
 class lib:
@@ -31,5 +33,21 @@ class lib:
     def callgrind_stop_instrumentation() -> int: ...
     @staticmethod
     def instrument_hooks_set_feature(feature: int, enabled: bool) -> None: ...
+    @staticmethod
+    def instrument_hooks_set_environment(
+        hooks: InstrumentHooksPointer, section_name: bytes, key: bytes, value: bytes
+    ) -> int: ...
+    @staticmethod
+    def instrument_hooks_set_environment_list(
+        hooks: InstrumentHooksPointer,
+        section_name: bytes,
+        key: bytes,
+        values: FFI.CData,
+        count: int,
+    ) -> int: ...
+    @staticmethod
+    def instrument_hooks_write_environment(
+        hooks: InstrumentHooksPointer, pid: int
+    ) -> int: ...
 
 LibType = type[lib]