pytest-results 0.1.0__tar.gz

pytest_results-0.1.0/.gitignore

@@ -0,0 +1,322 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,dotenv,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,dotenv,macos
+
+### dotenv ###
+.env
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,dotenv,macos
+
+# Pyenv
+.python-version
+
+# Code editors
+.fleet/
+.idea/
+.vscode/

pytest_results-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: pytest-results
+Version: 0.1.0
+Summary: Easily spot regressions in your tests.
+Project-URL: Repository, https://github.com/100nm/pytest-results
+Author: remimd
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.12
+Requires-Dist: orjson
+Requires-Dist: pytest
+Description-Content-Type: text/markdown
+
+# pytest-results
+
+[![CI](https://github.com/100nm/pytest-results/actions/workflows/ci.yml/badge.svg)](https://github.com/100nm/pytest-results)
+[![PyPI](https://img.shields.io/pypi/v/pytest-results.svg?color=blue)](https://pypi.org/project/pytest-results/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Easily spot regressions in your tests.
+
+The package lets you write non-regression tests.
+
+## Installation
+
+⚠️ _Requires Python 3.12 or higher_
+
+```bash
+pip install pytest-results
+```
+
+## Quick start
+
+First, retrieve the Pytest fixture `assert_results_match` in your test:
+
+```python
+def test_function(assert_results_match):
+    result = {"hello": "world"}
+    assert_results_match(result)
+```
+
+All results are stored in JSON files at the root of your project in the
+`__pytest_results__` folder.
+
+In case of regression, to open the interactive comparison, add the `--ide` parameter
+to Pytest with the name of your IDE:
+
+```bash
+pytest --ide vscode
+```
+
+_At present, the IDEs supported are `cursor`, `pycharm` and `vscode`._
+
+## Resources
+
+* [**assert_results_match fixture**](https://github.com/100nm/pytest-results/tree/prod/documentation/assert-results-match-fixture.md)
+* [**Configuration**](https://github.com/100nm/pytest-results/tree/prod/documentation/configuration.md)

pytest_results-0.1.0/README.md

@@ -0,0 +1,44 @@
+# pytest-results
+
+[![CI](https://github.com/100nm/pytest-results/actions/workflows/ci.yml/badge.svg)](https://github.com/100nm/pytest-results)
+[![PyPI](https://img.shields.io/pypi/v/pytest-results.svg?color=blue)](https://pypi.org/project/pytest-results/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Easily spot regressions in your tests.
+
+The package lets you write non-regression tests.
+
+## Installation
+
+⚠️ _Requires Python 3.12 or higher_
+
+```bash
+pip install pytest-results
+```
+
+## Quick start
+
+First, retrieve the Pytest fixture `assert_results_match` in your test:
+
+```python
+def test_function(assert_results_match):
+    result = {"hello": "world"}
+    assert_results_match(result)
+```
+
+All results are stored in JSON files at the root of your project in the
+`__pytest_results__` folder.
+
+In case of regression, to open the interactive comparison, add the `--ide` parameter
+to Pytest with the name of your IDE:
+
+```bash
+pytest --ide vscode
+```
+
+_At present, the IDEs supported are `cursor`, `pycharm` and `vscode`._
+
+## Resources
+
+* [**assert_results_match fixture**](https://github.com/100nm/pytest-results/tree/prod/documentation/assert-results-match-fixture.md)
+* [**Configuration**](https://github.com/100nm/pytest-results/tree/prod/documentation/configuration.md)

pytest_results-0.1.0/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "hatch",
+    "mypy",
+    "pydantic",
+    "ruff",
+]
+test = [
+    "pytest-cov",
+]
+
+[project]
+name = "pytest-results"
+version = "0.1.0"
+description = "Easily spot regressions in your tests."
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.12, <4"
+authors = [{ name = "remimd" }]
+keywords = []
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Testing",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Typing :: Typed",
+]
+dependencies = [
+    "orjson",
+    "pytest",
+]
+
+[project.entry-points.pytest11]
+pytest-results = "pytest_results.contrib.pytest.plugin"
+
+[project.urls]
+Repository = "https://github.com/100nm/pytest-results"
+
+[tool.coverage.report]
+exclude_lines = [
+    "pass",
+    "pragma: no cover",
+    "raise NotImplementedError",
+]
+omit = ["pytest_results/contrib/pytest/plugin.py"]
+
+[tool.hatch.build]
+skip-excluded-dirs = true
+
+[tool.hatch.build.targets.sdist]
+include = ["pytest_results"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["pytest_results"]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_defs = true
+follow_imports = "silent"
+no_implicit_reexport = true
+plugins = ["pydantic.mypy"]
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.pytest.ini_options]
+python_files = "test_*.py"
+addopts = "--tb short --cov ./ --cov-append --cov-report term-missing:skip-covered"
+testpaths = "**/tests/"
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint]
+extend-select = ["F", "I", "N"]
+fixable = ["ALL"]
+
+[tool.uv]
+default-groups = ["dev", "test"]
+package = true

pytest_results-0.1.0/pytest_results/__init__.py

@@ -0,0 +1,13 @@
+from ._core.assert_results_match import AssertResultsMatch, AssertResultsMatchType
+from ._core.dumpers.abc import Dumper, JSONDumper
+from ._core.storages.abc import Storage
+from ._core.storages.local import LocalStorage
+
+__all__ = (
+    "AssertResultsMatch",
+    "AssertResultsMatchType",
+    "Dumper",
+    "JSONDumper",
+    "Storage",
+    "LocalStorage",
+)

pytest_results-0.1.0/pytest_results/_core/assert_results_match.py

@@ -0,0 +1,77 @@
+from abc import abstractmethod
+from dataclasses import dataclass, field
+from functools import singledispatch
+from pathlib import Path
+from typing import Any, Protocol, runtime_checkable
+
+import pytest
+
+from pytest_results._core.dumpers.abc import Dumper
+from pytest_results._core.dumpers.json import SimpleJSONDumper
+from pytest_results._core.storages.abc import Storage
+from pytest_results.exceptions import ResultsMismatchError
+
+type AssertResultsMatchType = _AssertResultsMatch[Any]
+
+
+@runtime_checkable
+class _AssertResultsMatch[T](Protocol):
+    __slots__ = ()
+
+    @abstractmethod
+    def __call__(self, current_result: T, /, file_suffix: str = ...) -> None:
+        raise NotImplementedError
+
+
+@dataclass(repr=False, eq=False, frozen=True, slots=True)
+class AssertResultsMatch[T](_AssertResultsMatch[T]):
+    request: pytest.FixtureRequest
+    storage: Storage
+    dumper: Dumper[T] | None = field(default=None)
+
+    def __call__(self, current_result: T, /, file_suffix: str = "") -> None:
+        dumper = self.dumper or select_dumper_from(current_result)
+        storage = self.storage
+
+        current_bytes = dumper.dump(current_result)
+        relative_filepath = self.__get_relative_result_filepath(
+            dumper.file_format,
+            file_suffix,
+        )
+        filepath = storage.get_absolute_path(relative_filepath)
+        previous_bytes = storage.read(filepath)
+
+        try:
+            assert current_bytes == previous_bytes
+
+        except AssertionError as exc:
+            temporary_filepath = storage.get_temporary_path(relative_filepath)
+            storage.write(temporary_filepath, current_bytes)
+            raise ResultsMismatchError(temporary_filepath, filepath, storage) from exc
+
+    def __get_relative_result_filepath(self, file_format: str, suffix: str) -> Path:
+        request = self.request
+        segments = request.module.__name__.split(".")
+
+        if cls := request.cls:
+            segments.append(cls.__name__)
+
+        segments.append(f"{request.function.__name__}{suffix}.{file_format}")
+        return Path(*segments)
+
+
+@singledispatch
+def select_dumper_from(value: Any) -> Dumper[Any]:
+    return SimpleJSONDumper()
+
+
+try:
+    from pydantic import BaseModel
+except ImportError:  # pragma: no cover
+    ...
+else:
+    from pytest_results._core.dumpers.pydantic import PydanticJSONDumper
+
+    @select_dumper_from.register
+    def _(value: BaseModel) -> Dumper[BaseModel]:
+        return PydanticJSONDumper()

pytest_results-0.1.0/pytest_results/_core/dumpers/abc.py

@@ -0,0 +1,19 @@
+from abc import ABC, abstractmethod
+from typing import Protocol, runtime_checkable
+
+
+@runtime_checkable
+class Dumper[T](Protocol):
+    __slots__ = ()
+
+    file_format: str
+
+    @abstractmethod
+    def dump(self, value: T) -> bytes:
+        raise NotImplementedError
+
+
+class JSONDumper[T](Dumper[T], ABC):
+    __slots__ = ()
+
+    file_format: str = "json"

pytest_results-0.1.0/pytest_results/_core/dumpers/json.py

@@ -0,0 +1,12 @@
+from typing import Any
+
+import orjson
+
+from pytest_results._core.dumpers.abc import JSONDumper
+
+
+class SimpleJSONDumper(JSONDumper[Any]):
+    __slots__ = ()
+
+    def dump(self, value: Any) -> bytes:
+        return orjson.dumps(value, default=str, option=orjson.OPT_INDENT_2)

pytest_results-0.1.0/pytest_results/_core/dumpers/pydantic.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel
+
+from pytest_results._core.dumpers.abc import JSONDumper
+
+
+class PydanticJSONDumper(JSONDumper[BaseModel]):
+    __slots__ = ()
+
+    def dump(self, value: BaseModel) -> bytes:
+        return value.model_dump_json(indent=2).encode()

pytest_results-0.1.0/pytest_results/_core/storages/abc.py

@@ -0,0 +1,32 @@
+from abc import abstractmethod
+from pathlib import Path
+from typing import Protocol, runtime_checkable
+
+
+@runtime_checkable
+class Storage(Protocol):
+    __slots__ = ()
+
+    @abstractmethod
+    def copy(self, filepath: Path, destination: Path) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def exists(self, path: Path) -> bool:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_absolute_path(self, relative_path: Path) -> Path:
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_temporary_path(self, relative_path: Path) -> Path:
+        raise NotImplementedError
+
+    @abstractmethod
+    def read(self, filepath: Path) -> bytes:
+        raise NotImplementedError
+
+    @abstractmethod
+    def write(self, filepath: Path, result: bytes = ...) -> None:
+        raise NotImplementedError

pytest_results-0.1.0/pytest_results/_core/storages/local.py

@@ -0,0 +1,43 @@
+import os
+import shutil
+from contextlib import suppress
+from dataclasses import dataclass
+from pathlib import Path
+
+from pytest_results._core.storages.abc import Storage
+
+
+@dataclass(repr=False, eq=False, frozen=True, slots=True)
+class LocalStorage(Storage):
+    dir: Path
+    temporary_dir: Path
+
+    def copy(self, filepath: Path, destination: Path) -> None:
+        shutil.copyfile(filepath, destination)
+
+    def exists(self, path: Path) -> bool:
+        return path.exists()
+
+    def get_absolute_path(self, relative_path: Path) -> Path:
+        return self.__get_absolute_path(relative_path, self.dir)
+
+    def get_temporary_path(self, relative_path: Path) -> Path:
+        return self.__get_absolute_path(relative_path, self.temporary_dir)
+
+    def read(self, filepath: Path) -> bytes:
+        with suppress(FileNotFoundError):
+            with open(filepath, "rb") as reader:
+                return reader.read()
+
+        return b""
+
+    def write(self, filepath: Path, result: bytes = b"") -> None:
+        os.makedirs(filepath.parent, exist_ok=True)
+
+        with open(filepath, "wb") as writer:
+            writer.write(result)
+
+    @staticmethod
+    def __get_absolute_path(filepath: Path, directory: Path) -> Path:
+        assert not filepath.is_absolute()
+        return directory / filepath

pytest_results-0.1.0/pytest_results/contrib/pytest/plugin.py

@@ -0,0 +1,127 @@
+import warnings
+from collections.abc import Generator, Iterator, Mapping
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from typing import ClassVar
+
+from pytest import Config, FixtureRequest, Function, Parser, fixture, hookimpl
+
+from pytest_results import AssertResultsMatch, AssertResultsMatchType, LocalStorage
+from pytest_results.exceptions import ResultsMismatchError
+
+__all__ = ()
+
+
+def pytest_addoption(parser: Parser) -> None:
+    group = parser.getgroup("pytest-results")
+
+    group.addoption(
+        "--accept-all-diff",
+        dest="accept_all_diff",
+        action="store_true",
+        help="Parameter for accepting new differences between results.",
+        default=False,
+    )
+
+    diff_help = "Command line to open an interactive comparison. Example: `code -d -w {current} {previous}`."
+    group.addoption(
+        "--diff",
+        dest="diff",
+        metavar="COMMAND_LINE",
+        help=diff_help,
+        default=None,
+    )
+    parser.addini(
+        "diff",
+        type="string",
+        help=diff_help,
+        default=None,
+    )
+
+    ide_help = "The IDE to open for interactive comparison."
+    group.addoption(
+        "--ide",
+        dest="ide",
+        metavar="IDE",
+        help=ide_help,
+        default=None,
+    )
+    parser.addini(
+        "ide",
+        type="string",
+        help=ide_help,
+        default=None,
+    )
+
+
+@hookimpl(wrapper=True)
+def pytest_pyfunc_call(
+    pyfuncitem: Function,
+) -> Generator[None, object | None, object | None]:
+    try:
+        result = yield
+    except ResultsMismatchError as mismatch:
+        config = PytestResultsConfig(pyfuncitem.config)
+
+        if config.accept_all_diff:
+            mismatch.accept_diff()
+            return None
+
+        if command := config.diff_command:
+            mismatch.show_diff(command)
+
+        raise mismatch
+
+    return result
+
+
+@fixture(scope="session")
+def _pytest_results_tmpdir() -> Iterator[Path]:
+    with TemporaryDirectory(prefix="pytest-temporary-results@") as tmpdir:
+        yield Path(tmpdir)
+
+
+@fixture(scope="function")
+def assert_results_match(
+    request: FixtureRequest,
+    _pytest_results_tmpdir: Path,
+) -> AssertResultsMatchType:
+    results_dir = request.config.rootpath / "__pytest_results__"
+    storage = LocalStorage(results_dir, _pytest_results_tmpdir)
+    return AssertResultsMatch(request, storage)
+
+
+class PytestResultsConfig:
+    __slots__ = ("__config",)
+
+    __diff_commands: ClassVar[Mapping[str, str]] = {
+        "cursor": "cursor -d -r -w {current} {previous}",
+        "pycharm": "pycharm diff {current} {previous}",
+        "vscode": "code -d -r -w {current} {previous}",
+    }
+
+    def __init__(self, pytest_config: Config) -> None:
+        self.__config = pytest_config
+
+    @property
+    def accept_all_diff(self) -> bool:
+        return self.__config.getoption("accept_all_diff")
+
+    @property
+    def diff_command(self) -> str | None:
+        if diff := self.__get_option_or_ini("diff"):
+            return diff
+
+        if ide := self.__get_option_or_ini("ide"):
+            lowercase_ide = ide.lower()
+
+            try:
+                return self.__diff_commands[lowercase_ide]
+            except KeyError:
+                warnings.warn(f"pytest-results doesn't yet support the `{ide}` IDE.")
+
+        return None
+
+    def __get_option_or_ini[T](self, key: str) -> T | None:
+        config = self.__config
+        return config.getoption(key, default=config.getini(key))

pytest_results-0.1.0/pytest_results/exceptions.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+import os
+import time
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pytest_results import Storage
+
+__all__ = ("PytestResultsError", "ResultsMismatchError")
+
+
+class PytestResultsError(Exception): ...
+
+
+@dataclass(slots=True)
+class ResultsMismatchError(AssertionError, PytestResultsError):
+    current_filepath: Path
+    previous_filepath: Path
+    storage: Storage = field(repr=False)
+
+    def __str__(self) -> str:
+        return self.__to_string(self.current_filepath, self.previous_filepath)
+
+    def accept_diff(self) -> None:
+        self.__ensure_file_exists(self.previous_filepath)
+        self.storage.copy(self.current_filepath, self.previous_filepath)
+
+    def show_diff(self, command: str) -> None:
+        self.__ensure_file_exists(self.previous_filepath)
+        command = command.format(
+            current=self.current_filepath,
+            previous=self.previous_filepath,
+        )
+        os.system(command)
+        time.sleep(1)
+
+    def __ensure_file_exists(self, filepath: Path) -> None:
+        if self.storage.exists(filepath):
+            return
+
+        self.storage.write(filepath)
+
+    @staticmethod
+    def __to_string(current: object, previous: object) -> str:
+        return f"Results mismatch\n・Current: `{current}`\n・Previous: `{previous}`"