Fix stdout/stderr redirects

.pre-commit-config.yaml

@@ -17,6 +17,7 @@ repos:
     hooks:
       - id: mypy
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.275
+    rev: v0.2.1
     hooks:
       - id: ruff
+        args: [--fix]

pyproject.toml

@@ -69,9 +69,9 @@ include = ["/src"]
 [tool.mypy]
 python_version = "3.12"
 
-[tool.ruff]
-line-length = 88
-select = ["E", "F", "I", "C"]
+[tool.ruff.lint]
+select = ["E", "F", "I", "C", "TCH", "FA", "UP"]
+flake8-type-checking = {exempt-modules = [], strict = true}
 
 [tool.isort]
 line_length = 88

src/pytest_codspeed/_wrapper/.gitignore

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

src/pytest_codspeed/_wrapper/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 from typing import TYPE_CHECKING
 
@@ -22,7 +24,7 @@ def _get_ffi():
     return ffi
 
 
-def get_lib() -> "LibType":
+def get_lib() -> LibType:
     try:
         ffi = _get_ffi()
         build_lock = FileLock(f"{_wrapper_dir}/build.lock")

src/pytest_codspeed/plugin.py

@@ -1,19 +1,11 @@
+from __future__ import annotations
+
 import gc
 import os
 import pkgutil
 import sys
 from dataclasses import dataclass, field
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Callable,
-    Dict,
-    List,
-    Optional,
-    Tuple,
-    TypeVar,
-    Union,
-)
+from typing import TYPE_CHECKING, TypeVar
 
 import pytest
 from _pytest.fixtures import FixtureManager
@@ -24,14 +16,16 @@
 from ._wrapper import get_lib
 
 if TYPE_CHECKING:
+    from typing import Any, Callable
+
     from ._wrapper import LibType
 
 IS_PYTEST_BENCHMARK_INSTALLED = pkgutil.find_loader("pytest_benchmark") is not None
 SUPPORTS_PERF_TRAMPOLINE = sys.version_info >= (3, 12)
 
 
 @pytest.hookimpl(trylast=True)
-def pytest_addoption(parser: "pytest.Parser"):
+def pytest_addoption(parser: pytest.Parser):
     group = parser.getgroup("CodSpeed benchmarking")
     group.addoption(
         "--codspeed",
@@ -45,20 +39,20 @@ def pytest_addoption(parser: "pytest.Parser"):
 class CodSpeedPlugin:
     is_codspeed_enabled: bool
     should_measure: bool
-    lib: Optional["LibType"]
-    disabled_plugins: Tuple[str, ...]
+    lib: LibType | None
+    disabled_plugins: tuple[str, ...]
     benchmark_count: int = field(default=0, hash=False, compare=False)
 
 
 PLUGIN_NAME = "codspeed_plugin"
 
 
-def get_plugin(config: "pytest.Config") -> "CodSpeedPlugin":
+def get_plugin(config: pytest.Config) -> CodSpeedPlugin:
     return config.pluginmanager.get_plugin(PLUGIN_NAME)
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_configure(config: "pytest.Config"):
+def pytest_configure(config: pytest.Config):
     config.addinivalue_line(
         "markers", "codspeed_benchmark: mark an entire test for codspeed benchmarking"
     )
@@ -72,7 +66,7 @@ def pytest_configure(config: "pytest.Config"):
     lib = get_lib() if should_measure else None
     if lib is not None:
         lib.dump_stats_at(f"Metadata: pytest-codspeed {__version__}".encode("ascii"))
-    disabled_plugins: List[str] = []
+    disabled_plugins: list[str] = []
     # Disable pytest-benchmark if codspeed is enabled
     if is_codspeed_enabled and IS_PYTEST_BENCHMARK_INSTALLED:
         object.__setattr__(config.option, "benchmark_disable", True)
@@ -88,7 +82,7 @@ def pytest_configure(config: "pytest.Config"):
     config.pluginmanager.register(plugin, PLUGIN_NAME)
 
 
-def pytest_plugin_registered(plugin, manager: "pytest.PytestPluginManager"):
+def pytest_plugin_registered(plugin, manager: pytest.PytestPluginManager):
     """Patch the benchmark fixture to use the codspeed one if codspeed is enabled"""
     if IS_PYTEST_BENCHMARK_INSTALLED and isinstance(plugin, FixtureManager):
         fixture_manager = plugin
@@ -107,7 +101,7 @@ def pytest_plugin_registered(plugin, manager: "pytest.PytestPluginManager"):
 
 
 @pytest.hookimpl(trylast=True)
-def pytest_report_header(config: "pytest.Config"):
+def pytest_report_header(config: pytest.Config):
     out = [
         f"codspeed: {__version__} "
         f"(callgraph: {'enabled' if SUPPORTS_PERF_TRAMPOLINE  else 'not supported'})"
@@ -128,24 +122,24 @@ def pytest_report_header(config: "pytest.Config"):
     return "\n".join(out)
 
 
-def has_benchmark_fixture(item: "pytest.Item") -> bool:
+def has_benchmark_fixture(item: pytest.Item) -> bool:
     item_fixtures = getattr(item, "fixturenames", [])
     return "benchmark" in item_fixtures or "codspeed_benchmark" in item_fixtures
 
 
-def has_benchmark_marker(item: "pytest.Item") -> bool:
+def has_benchmark_marker(item: pytest.Item) -> bool:
     return (
         item.get_closest_marker("codspeed_benchmark") is not None
         or item.get_closest_marker("benchmark") is not None
     )
 
 
-def should_benchmark_item(item: "pytest.Item") -> bool:
+def should_benchmark_item(item: pytest.Item) -> bool:
     return has_benchmark_fixture(item) or has_benchmark_marker(item)
 
 
 @pytest.hookimpl()
-def pytest_sessionstart(session: "pytest.Session"):
+def pytest_sessionstart(session: pytest.Session):
     plugin = get_plugin(session.config)
     if plugin.is_codspeed_enabled:
         plugin.benchmark_count = 0
@@ -155,7 +149,7 @@ def pytest_sessionstart(session: "pytest.Session"):
 
 @pytest.hookimpl(trylast=True)
 def pytest_collection_modifyitems(
-    session: "pytest.Session", config: "pytest.Config", items: "List[pytest.Item]"
+    session: pytest.Session, config: pytest.Config, items: list[pytest.Item]
 ):
     plugin = get_plugin(config)
     if plugin.is_codspeed_enabled:
@@ -171,9 +165,9 @@ def pytest_collection_modifyitems(
 
 
 def _run_with_instrumentation(
-    lib: "LibType",
+    lib: LibType,
     nodeId: str,
-    config: "pytest.Config",
+    config: pytest.Config,
     fn: Callable[..., Any],
     *args,
     **kwargs,
@@ -205,7 +199,7 @@ def __codspeed_root_frame__():
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_runtest_protocol(item: "pytest.Item", nextitem: Union["pytest.Item", None]):
+def pytest_runtest_protocol(item: pytest.Item, nextitem: pytest.Item | None):
     plugin = get_plugin(item.config)
     if not plugin.is_codspeed_enabled or not should_benchmark_item(item):
         return (
@@ -234,7 +228,10 @@ def pytest_runtest_protocol(item: "pytest.Item", nextitem: Union["pytest.Item",
         assert plugin.lib is not None
         runtest_call = pytest.CallInfo.from_call(
             lambda: _run_with_instrumentation(
-                plugin.lib, item.nodeid, item.config, item.runtest
+                plugin.lib,
+                item.nodeid,
+                item.config,
+                lambda: ihook.pytest_runtest_call(item=item),
             ),
             "call",
         )
@@ -260,8 +257,8 @@ def pytest_runtest_protocol(item: "pytest.Item", nextitem: Union["pytest.Item",
 class BenchmarkFixture:
     """The fixture that can be used to benchmark a function."""
 
-    def __init__(self, request: "pytest.FixtureRequest"):
-        self.extra_info: Dict = {}
+    def __init__(self, request: pytest.FixtureRequest):
+        self.extra_info: dict = {}
 
         self._request = request
 
@@ -279,22 +276,22 @@ def __call__(self, func: Callable[..., T], *args: Any, **kwargs: Any) -> T:
 
 
 @pytest.fixture(scope="function")
-def codspeed_benchmark(request: "pytest.FixtureRequest") -> Callable:
+def codspeed_benchmark(request: pytest.FixtureRequest) -> Callable:
     return BenchmarkFixture(request)
 
 
 if not IS_PYTEST_BENCHMARK_INSTALLED:
 
     @pytest.fixture(scope="function")
-    def benchmark(codspeed_benchmark, request: "pytest.FixtureRequest"):
+    def benchmark(codspeed_benchmark, request: pytest.FixtureRequest):
         """
         Compatibility with pytest-benchmark
         """
         return codspeed_benchmark
 
 
 @pytest.hookimpl()
-def pytest_sessionfinish(session: "pytest.Session", exitstatus):
+def pytest_sessionfinish(session: pytest.Session, exitstatus):
     plugin = get_plugin(session.config)
     if plugin.is_codspeed_enabled:
         reporter = session.config.pluginmanager.get_plugin("terminalreporter")

tests/benchmarks/test_print.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from pytest import CaptureFixture
+
+
+@pytest.mark.benchmark
+def test_print():
+    """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)."""
+    print("print to stdout")
+    print("print to stderr", file=sys.stderr)
+
+
+@pytest.mark.benchmark
+def test_capsys(capsys: CaptureFixture):
+    """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."""
+    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"

tests/test_pytest_plugin.py

@@ -304,7 +304,7 @@ def fixtured_child():
     perf_filepath = f"/tmp/perf-{current_pid}.map"
     print(perf_filepath)
 
-    with open(perf_filepath, "r") as perf_file:
+    with open(perf_filepath) as perf_file:
         lines = perf_file.readlines()
         assert any(
             "py::_run_with_instrumentation.<locals>.__codspeed_root_frame__" in line