feat: add a few useful pytest fixtures

pyproject.toml

@@ -12,9 +12,13 @@ dynamic = ["description", "version"]
 dependencies = ["coloredlogs", "docstring-parser", "python-dateutil", "xxhash"]
 
 [project.optional-dependencies]
-test = ["flaky", "pytest", "pytest-asyncio", "pytest-coverage", "types-python-dateutil", "types-xxhash"]
+testing = ["pytest", "pyyaml"]
+test = ["flaky", "pytest", "pytest-asyncio", "pytest-coverage", "replete[testing]", "types-python-dateutil", "types-xxhash"]
 dev = ["replete[test]", "ruff"]
 
+[project.entry-points.pytest11]
+replete = "replete.testing"
+
 [tool.flit.sdist]
 include = ["README.md"]
 exclude = [".github", ".gitignore", "tests/*"]

replete/testing.py

@@ -0,0 +1,44 @@
+import pickle  # noqa: S403
+import warnings
+from pathlib import Path
+
+try:
+    import pytest
+    import yaml
+except ModuleNotFoundError as exc:
+    raise ModuleNotFoundError(
+        "this file requires optional dependencies, please install using: replete[testing]",
+    ) from exc
+
+
+DATA_DIRECTORY_NAME = "data"
+
+
+@pytest.fixture(scope="module")
+def build_data_file_full_path(request):
+    def path_builder(file_path: Path) -> Path:
+        test_module_name = Path(request.fspath).stem
+        return Path(request.fspath).parent / DATA_DIRECTORY_NAME / test_module_name / file_path
+
+    return path_builder
+
+
+@pytest.fixture(scope="module")
+def load_file(build_data_file_full_path):
+    def loader(file_path: Path):
+        full_file_path = build_data_file_full_path(file_path)
+        ext = full_file_path.suffix
+        if ext == ".pkl":
+            with full_file_path.open("rb") as f:
+                warnings.simplefilter("ignore")
+                return pickle.load(f)  # noqa: S301
+        elif ext == ".yaml":
+            with full_file_path.open("r") as f:
+                return yaml.safe_load(f)
+        elif ext == ".txt":
+            with full_file_path.open() as f:
+                return f.read()
+        else:
+            raise ValueError(f"Unknown file type: {ext=}")
+
+    return loader

tests/data/test_testing/test.txt

@@ -0,0 +1 @@
+foo text

tests/data/test_testing/test.yaml

@@ -0,0 +1,2 @@
+---
+foo: yaml

tests/test_testing.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+import pytest
+
+
+def test_build_data_file_full_path(build_data_file_full_path):
+    assert build_data_file_full_path("test.pkl") == Path(__file__).parent / "data" / "test_testing" / "test.pkl"
+
+
+@pytest.mark.parametrize(
+    ("filename", "expected"),
+    [("test.pkl", {"foo": "pickle"}), ("test.yaml", {"foo": "yaml"}), ("test.txt", "foo text\n")],
+)
+def test_load_file(load_file, filename: str, expected: dict | str):
+    assert load_file(filename) == expected