pytest-shm 0.1.0__py3-none-any.whl

pytest_shm/__init__.py

@@ -0,0 +1,9 @@
+"""Put pytest's temporary files on the `/dev/shm` tmpfs."""
+
+try:
+    from pytest_shm._version import __version__, __version_tuple__
+except ImportError:
+    __version__ = "0.0.0"
+    __version_tuple__ = (0, 0, 0)
+
+__all__ = ["__version__", "__version_tuple__"]

pytest_shm/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None

pytest_shm/plugin.py

@@ -0,0 +1,184 @@
+"""Run pytest with its temporary files on the `/dev/shm` tmpfs."""
+
+from __future__ import annotations
+
+import os
+import shutil
+import sys
+import tempfile
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from collections.abc import Generator, Mapping
+
+    from xdist.workermanage import WorkerController
+
+SHM = Path("/dev/shm")  # noqa: S108
+_TEMP_ROOT_VARIABLES = ("TMPDIR", "TEMP", "TMP")
+_MIN_FREE_INI = "shm_min_free_gib"
+_CONTAINED_NAME = "shm-tmp"
+_OWNS_BASETEMP_KEY = "shm_owns_basetemp"
+_OFF_REASON = pytest.StashKey[str]()
+_CONTAINED = pytest.StashKey[bool]()
+_OWNED_BASETEMP = pytest.StashKey[Path]()
+_NOTHING_TO_INSPECT = (
+    pytest.ExitCode.OK,
+    pytest.ExitCode.NO_TESTS_COLLECTED,
+    pytest.ExitCode.USAGE_ERROR,
+)
+
+
+def off_reason(
+    min_free_gib: float,
+    environ: Mapping[str, str],
+    basetemp: str | None = None,
+) -> str | None:
+    """Return why the temp root should stay where it is, or `None` to move it to `/dev/shm`.
+
+    `basetemp` is the caller's `--basetemp`, which, like `PYTEST_DEBUG_TEMPROOT`,
+    decides where pytest's base directory goes regardless of the temp root.
+    """
+    if sys.platform != "linux":
+        return "not Linux"
+    for name in _TEMP_ROOT_VARIABLES:
+        if name in environ:
+            return f"{name} is exported"
+    base_source, base = (
+        ("--basetemp", basetemp)
+        if basetemp
+        else ("PYTEST_DEBUG_TEMPROOT", environ.get("PYTEST_DEBUG_TEMPROOT"))
+    )
+    if base and not Path(base).resolve().is_relative_to(SHM.resolve()):
+        return f"{base_source} is outside {SHM}"
+    return _shm_off_reason(min_free_gib)
+
+
+def _shm_off_reason(min_free_gib: float) -> str | None:
+    """Return why `/dev/shm` itself cannot hold the session's files, or `None`."""
+    if not SHM.is_dir() or not os.access(SHM, os.W_OK | os.X_OK):
+        return f"{SHM} is missing or not writable"
+    if os.statvfs(SHM).f_flag & os.ST_NOEXEC:
+        return f"{SHM} is mounted noexec"
+    free_gib = shutil.disk_usage(SHM).free / 2**30
+    if free_gib < min_free_gib:
+        return f"{SHM} has {free_gib:.1f} GiB free, below {_MIN_FREE_INI} = {min_free_gib:g}"
+    return None
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    """Register the free-space threshold."""
+    parser.addini(
+        _MIN_FREE_INI,
+        f"Minimum free GiB {SHM} needs before temporary files move there (default: 1).",
+        type="float",
+        default=1.0,
+    )
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_load_initial_conftests(early_config: pytest.Config) -> None:
+    """Point the temp root at `/dev/shm` before any `conftest.py` can read it."""
+    reason = off_reason(
+        early_config.getini(_MIN_FREE_INI),
+        os.environ,
+        # pytest's tmpdir plugin registers --basetemp, so it is missing when that plugin is.
+        getattr(early_config.known_args_namespace, "basetemp", None),
+    )
+    if reason is None and early_config.pluginmanager.is_blocked("tmpdir"):
+        reason = "pytest's tmpdir plugin is disabled"
+    if reason is not None:
+        early_config.stash[_OFF_REASON] = reason
+        return
+    previous_tempdir = tempfile.tempdir
+    os.environ["TMPDIR"] = str(SHM)
+    tempfile.tempdir = None
+
+    def restore() -> None:
+        # pytest runs cleanups even when the session never configures, such as on a usage error.
+        os.environ.pop("TMPDIR", None)
+        tempfile.tempdir = previous_tempdir
+
+    early_config.add_cleanup(restore)
+
+
+def pytest_report_header(config: pytest.Config) -> str:
+    """Say where temporary files go, or why they stay put."""
+    temp_root = tempfile.gettempdir()
+    if Path(temp_root) == SHM:
+        return f"shm: temp root {SHM}"
+    return f"shm: off, {config.stash.get(_OFF_REASON, f'temp root is {temp_root}')}"
+
+
+def _pytest_chose_basetemp(config: pytest.Config) -> bool:
+    """Tell whether pytest picked the base directory rather than the caller."""
+    workerinput = getattr(config, "workerinput", None)
+    if workerinput is not None:
+        return bool(workerinput.get(_OWNS_BASETEMP_KEY, False))
+    return config.option.basetemp is None
+
+
+@pytest.hookimpl(optionalhook=True)
+def pytest_configure_node(node: WorkerController) -> None:
+    """Tell each xdist worker whether its base directory is pytest's own or the caller's.
+
+    xdist hands every worker its directory as `--basetemp`, so only the controller
+    still knows whether the caller chose one, which must outlive a passing session.
+    """
+    node.workerinput[_OWNS_BASETEMP_KEY] = node.config.option.basetemp is None
+
+
+@pytest.hookimpl(wrapper=True)
+def pytest_sessionstart(session: pytest.Session) -> Generator[None]:
+    """Keep bare `tempfile` output inside pytest's base directory on `/dev/shm`.
+
+    Tests and the code they drive often call `tempfile.mkdtemp()` without removing
+    the result. On disk that only clutters `/tmp`, but on tmpfs it would hold memory
+    until reboot, so from collection on it joins the `tmp_path` directories that
+    `pytest_sessionfinish` frees.
+
+    This runs after every other `pytest_sessionstart`, once xdist has started its
+    workers, so they inherit `/dev/shm` itself rather than this process's directory.
+    Workers never switch the temp root, so this checks where it is rather than
+    whether this process moved it. A worker xdist starts later to replace a crashed
+    one inherits the controller's directory instead, and its files are freed with it.
+    """
+    yield
+    config = session.config
+    # pytest's tmpdir plugin sets this in pytest_configure, and xdist reads it the same way.
+    factory: pytest.TempPathFactory | None = getattr(config, "_tmp_path_factory", None)
+    if factory is None or Path(tempfile.gettempdir()) != SHM:
+        return
+    basetemp = factory.getbasetemp()
+    if not basetemp.is_relative_to(SHM.resolve()):
+        # Containing would move files the caller sent to /dev/shm onto disk.
+        return
+    if _pytest_chose_basetemp(config):
+        config.stash[_OWNED_BASETEMP] = basetemp
+    contained = basetemp / _CONTAINED_NAME
+    contained.mkdir()
+    os.environ["TMPDIR"] = str(contained)
+    tempfile.tempdir = str(contained)
+    config.stash[_CONTAINED] = True
+
+
+@pytest.hookimpl(trylast=True)
+def pytest_sessionfinish(session: pytest.Session, exitstatus: int | pytest.ExitCode) -> None:
+    """Hand back `/dev/shm`, and free the base directory of a session nobody needs to inspect.
+
+    pytest keeps the last three sessions' directories, which on tmpfs pins memory
+    until they are pruned. A session that passed, collected no tests, or stopped at a
+    usage error leaves nothing worth keeping. Each xdist worker owns its own base
+    directory, so a failing session keeps only the workers that saw a failure.
+    Deleting per test is not an option: pytest then reuses the freed names, and
+    caches keyed by path hand the next test the previous one's state.
+    """
+    config = session.config
+    if config.stash.get(_CONTAINED, False):
+        os.environ["TMPDIR"] = str(SHM)
+        tempfile.tempdir = None
+    basetemp = config.stash.get(_OWNED_BASETEMP, None)
+    if basetemp is not None and exitstatus in _NOTHING_TO_INSPECT:
+        shutil.rmtree(basetemp, ignore_errors=True)

pytest_shm-0.1.0.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.5
+Name: pytest-shm
+Version: 0.1.0
+Summary: Put pytest's temporary files on the /dev/shm tmpfs so fsync-heavy suites stop waiting on the disk
+Project-URL: Homepage, https://github.com/basnijholt/pytest-shm
+Project-URL: Repository, https://github.com/basnijholt/pytest-shm
+Project-URL: Documentation, https://github.com/basnijholt/pytest-shm#readme
+Project-URL: Issues, https://github.com/basnijholt/pytest-shm/issues
+Project-URL: Changelog, https://github.com/basnijholt/pytest-shm/releases
+Author-email: Bas Nijholt <bas@nijho.lt>
+Maintainer-email: Bas Nijholt <bas@nijho.lt>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: fsync,performance,pytest,shm,tempfile,testing,tmpfs,xdist
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pytest>=8.4
+Description-Content-Type: text/markdown
+
+# pytest-shm
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-shm)](https://pypi.org/project/pytest-shm/)
+[![Python](https://img.shields.io/pypi/pyversions/pytest-shm)](https://pypi.org/project/pytest-shm/)
+[![License](https://img.shields.io/github/license/basnijholt/pytest-shm)](LICENSE)
+[![CI](https://github.com/basnijholt/pytest-shm/actions/workflows/ci.yml/badge.svg)](https://github.com/basnijholt/pytest-shm/actions/workflows/ci.yml)
+
+A pytest plugin that puts your test suite's temporary files on the `/dev/shm` tmpfs, so tests that fsync stop waiting on the disk.
+
+> [!NOTE]
+> Install it and run pytest.
+> On Linux it moves the temp root to `/dev/shm` when that is safe, keeps stray `tempfile` output from collection on inside pytest's base directory, and frees that directory when the session passes.
+> Everywhere else, and whenever you export `TMPDIR`, it leaves the temp root alone.
+
+## Table of Contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Why](#why)
+- [Installation](#installation)
+- [How it works](#how-it-works)
+- [When it stays off](#when-it-stays-off)
+- [Configuration](#configuration)
+- [Caveats](#caveats)
+- [Development](#development)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Why
+
+SQLite commits, atomic file replacement, and anything else that promises durability call `fsync`, and on a real disk each call waits for the device.
+A suite that exercises durable storage can spend most of its time there.
+tmpfs lives in memory, so `fsync` returns immediately.
+
+In [MindRoom](https://github.com/mindroom-ai/mindroom)'s suite of about 26,000 tests, summed test time on a 32-worker NVMe machine fell from 5236 s to 1426 s, and the GitHub Actions test step fell from about 16 to 12-15 minutes.
+
+No durability test can observe the difference.
+Such tests simulate a crashed process, and a crashed process never needed its writes to leave the page cache.
+The [caveats](#caveats) list the differences other tests can see.
+
+## Installation
+
+```bash
+uv add --dev pytest-shm
+# or
+pip install pytest-shm
+```
+
+It needs Python 3.10+ and pytest 8.4+, and pytest loads it automatically.
+The report header tells you whether it is active:
+
+```text
+shm: temp root /dev/shm
+```
+
+or why it is not:
+
+```text
+shm: off, TMPDIR is exported
+```
+
+## How it works
+
+1. **Temp root.** Before any `conftest.py` is imported, the plugin sets `TMPDIR=/dev/shm`, so `tmp_path`, `tmp_path_factory`, and every `tempfile` call land in memory.
+2. **Containment.** Tests and the code they drive often call `tempfile.mkdtemp()` without removing the result. On disk that clutters `/tmp`; on tmpfs it would hold memory until reboot. When the session starts, before collection, the plugin points `TMPDIR` at `<basetemp>/shm-tmp`, so that output lives and dies with pytest's own base directory.
+3. **Cleanup.** pytest keeps the last three sessions' base directories. When a session passes, collects no tests, or stops at a usage error, the plugin deletes its base directory right away instead of holding it in memory. A failing session keeps everything for inspection.
+4. **pytest-xdist.** Each worker owns `<basetemp>/popen-gwN` and cleans up after itself, so a failing run keeps only the directories of workers that saw a failure. A `--basetemp` you pass yourself is never deleted, with or without xdist.
+
+Deleting per test is deliberately not offered: pytest would then reuse the freed directory names, and caches keyed by path would hand the next test the previous one's state.
+
+## When it stays off
+
+The plugin leaves the temp root alone, and says why in the report header, when any of these holds:
+
+| Condition | Header |
+| --- | --- |
+| Not running on Linux | `shm: off, not Linux` |
+| `TMPDIR`, `TEMP`, or `TMP` is exported | `shm: off, TMPDIR is exported` |
+| `--basetemp` or `PYTEST_DEBUG_TEMPROOT` puts pytest's base directory outside `/dev/shm` | `shm: off, --basetemp is outside /dev/shm` |
+| pytest's `tmpdir` plugin is disabled (`-p no:tmpdir`) | `shm: off, pytest's tmpdir plugin is disabled` |
+| `/dev/shm` is missing, or not writable and searchable | `shm: off, /dev/shm is missing or not writable` |
+| `/dev/shm` is mounted `noexec` (Docker's default), which would break tests that run scripts they write | `shm: off, /dev/shm is mounted noexec` |
+| `/dev/shm` has less free space than `shm_min_free_gib` (Docker's default is 64 MiB) | `shm: off, /dev/shm has 0.1 GiB free, below shm_min_free_gib = 1` |
+
+To turn it off explicitly, export `TMPDIR` to the directory you want, or pass `-o shm_min_free_gib=inf`.
+`-p no:shm` works too, but pytest then warns about the unknown `shm_min_free_gib` option if you configured it, and `--strict-config` makes that an error.
+
+If you export `TMPDIR=/dev/shm` yourself, the plugin still contains and cleans up temporary files, as long as pytest's base directory is on `/dev/shm` too.
+
+## Configuration
+
+One ini option sets how much free space `/dev/shm` needs before the plugin uses it:
+
+```toml
+[tool.pytest.ini_options]
+shm_min_free_gib = 4
+```
+
+The default is `1`.
+Set it above your suite's peak usage, which you can watch with `df -h /dev/shm` during a run.
+Override it for one run with `-o shm_min_free_gib=8`.
+
+## Caveats
+
+- **Only output during the session is contained.** Temporary files created before the session starts (while the initial `conftest.py` files are imported, in `pytest_configure`, or in other plugins' `pytest_sessionstart` hooks) or after it ends (`pytest_terminal_summary`, `pytest_unconfigure`) land directly in `/dev/shm` and stay there until reboot. Create them in fixtures, or remove them yourself.
+- **Caches under the temp root become per-session.** Libraries that cache downloads under `tempfile.gettempdir()` see the contained directory, which the plugin frees after the session. Pin such caches in your root `conftest.py`, where `tempfile.gettempdir()` is still `/dev/shm`. For tiktoken:
+
+  ```python
+  if "TIKTOKEN_CACHE_DIR" not in os.environ and "DATA_GYM_CACHE_DIR" not in os.environ:
+      os.environ["TIKTOKEN_CACHE_DIR"] = str(Path(tempfile.gettempdir()) / "data-gym-cache")
+  ```
+
+- **Temp files live on another filesystem.** `os.rename` or `os.replace` from a temporary file into your project fails with `EXDEV`, as it already does wherever `/tmp` is tmpfs.
+- **Paths get longer.** `/dev/shm/pytest-of-<user>/pytest-N/popen-gwN/shm-tmp/tmpXXXXXXXX` is much longer than `/tmp/tmpXXXXXXXX`, which matters for the 107-byte limit on `AF_UNIX` socket paths.
+- **Files use RAM.** Everything a session writes counts against memory until the session ends. Base directories of failing sessions stay until the machine reboots or later failing sessions push them out of pytest's retention of three numbered directories; passing sessions reuse the freed number instead of advancing it.
+- **Plugin autoloading.** With `PYTEST_DISABLE_PLUGIN_AUTOLOAD` set, pass `-p shm` to load the plugin.
+
+## Development
+
+```bash
+just install  # uv sync --dev
+just test     # uv run pytest -n auto
+just lint     # ruff, mypy, ty
+```
+
+The tests run real pytest sessions in subprocesses with `pytester` and inspect what they leave behind on `/dev/shm`.
+
+## License
+
+MIT

pytest_shm-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pytest_shm/__init__.py,sha256=HFojLqbNQUiHn5wwbp0TxTOVDcDEwqPF2BZ8ihmtTA0,261
+pytest_shm/_version.py,sha256=n_5vdJsPNu7wZ57LGuRL585uvll-hiuvZUBWzdG0RQU,520
+pytest_shm/plugin.py,sha256=lu8mMx2D25xxJIfcixf3KrUkP2hVB5OSmda88Lf_6_Q,7246
+pytest_shm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_shm-0.1.0.dist-info/METADATA,sha256=S07Jy8qjYEEo4Dyxid2MG1RDaYRY9IPQJ3_pwc8c5GE,8700
+pytest_shm-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+pytest_shm-0.1.0.dist-info/entry_points.txt,sha256=kbngM5aH-YhfKRpDiwj-kd97Qns59THCsNzoZh1Xh9k,35
+pytest_shm-0.1.0.dist-info/licenses/LICENSE,sha256=Z-jViiDEIKskSQzvdihxxQ5Z25DDxXFdiPwx4ZK2Jho,1068
+pytest_shm-0.1.0.dist-info/RECORD,,

pytest_shm-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

pytest_shm-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+shm = pytest_shm.plugin

pytest_shm-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bas Nijholt
+
+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.