pytest-regtest 2.3.0__py2.py3-none-any.whl → 2.3.2__py2.py3-none-any.whl

{pytest_regtest-2.3.0.dist-info → pytest_regtest-2.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-regtest
-Version: 2.3.0
+Version: 2.3.2
 Summary: pytest plugin for snapshot regression testing
 Project-URL: Source, https://gitlab.com/uweschmitt/pytest-regtest
 Project-URL: Documentation, https://pytest-regtest.readthedocs.org
@@ -14,33 +14,13 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: pytest>7.2
-Provides-Extra: dev
-Requires-Dist: black; extra == 'dev'
-Requires-Dist: build; extra == 'dev'
-Requires-Dist: hatchling; extra == 'dev'
-Requires-Dist: jinja2-cli; extra == 'dev'
-Requires-Dist: mistletoe; extra == 'dev'
-Requires-Dist: mkdocs; extra == 'dev'
-Requires-Dist: mkdocs-awesome-pages-plugin; extra == 'dev'
-Requires-Dist: mkdocs-material; extra == 'dev'
-Requires-Dist: mkdocstrings[python]; extra == 'dev'
-Requires-Dist: numpy; extra == 'dev'
-Requires-Dist: numpy>=2.1.1; extra == 'dev'
-Requires-Dist: pandas; extra == 'dev'
-Requires-Dist: pandas>=2.2.3; extra == 'dev'
-Requires-Dist: polars>=1.9.0; extra == 'dev'
-Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Requires-Dist: twine; extra == 'dev'
-Requires-Dist: wheel; extra == 'dev'
 Description-Content-Type: text/markdown
 
 ![](https://gitlab.com/uweschmitt/pytest-regtest/badges/main/pipeline.svg)
 ![](https://gitlab.com/uweschmitt/pytest-regtest/badges/main/coverage.svg?job=coverage)
 
 
-The full documentatin for this package are available at
+The full documentation for this package are available at
 https://pytest-regtest.readthedocs.org
 
 # About
@@ -70,12 +50,12 @@ To install and activate this plugin execute:
 
 !!! note
 
-    `pyteset-regtest` offers some functionalities which are tailored
-     for `NumPy`, `pandas` and `polars`. These depencies are not
-     installed if you install `pytest-regtest`. In case you are using
-     e.g. `NumPy` snapshots, we assume that your productive code (the
-     code under test) uses `NumPy` and thus should be part of the setup
-     of your project.
+     `pytest-regtest` provides some functionality specific to `NumPy`,
+     `pandas`, and `polars`. These dependencies are not installed when
+     you install `pytest-regtest`. For example, if you are using NumPy
+     snapshots, we assume that your production code (the code under
+     test) uses NumPy and therefore should be part of your project's
+     setup.
 
 
 ## Use case 1: Changing code with no or little testing setup yet

pytest_regtest-2.3.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+pytest_regtest-2.3.2.dist-info/METADATA,sha256=g-6og_8Il3fBjTHYBRA1eGHHQ-FMIWU1Nd37oJgUBys,3275
+pytest_regtest-2.3.2.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+pytest_regtest-2.3.2.dist-info/entry_points.txt,sha256=4VuIhXeMGhDo0ATbaUfyjND0atofmZjV_P-o6_uEk2s,36
+pytest_regtest-2.3.2.dist-info/licenses/LICENSE.txt,sha256=Tue36uAzpW79-9WAqzkwPhsDDVd1X-VWUmdZ0MfGYvk,1068
+pytest_regtest-2.3.2.dist-info/RECORD,,

pytest_regtest/__init__.py

@@ -1,108 +0,0 @@
-from importlib.metadata import version as _version
-
-import pytest
-
-from .pytest_regtest import clear_converters  # noqa: F401
-from .pytest_regtest import patch_terminal_size  # noqa: F401
-from .pytest_regtest import register_converter_post  # noqa: F401
-from .pytest_regtest import register_converter_pre  # noqa: F401
-from .pytest_regtest import (
-    PytestRegtestCommonHooks,
-    PytestRegtestPlugin,
-    RegtestStream,
-    Snapshot,
-    SnapshotPlugin,
-)
-from .register_third_party_handlers import (
-    register_numpy_handler,
-    register_pandas_handler,
-    register_polars_handler,
-)
-
-from .snapshot_handler import register_python_object_handler
-
-__version__ = _version(__package__)
-
-
-def pytest_addoption(parser):
-    """Add options to control the timeout plugin"""
-    group = parser.getgroup("regtest", "regression test plugin")
-    group.addoption(
-        "--regtest-reset",
-        action="store_true",
-        help="do not run regtest but record current output",
-    )
-    group.addoption(
-        "--regtest-tee",
-        action="store_true",
-        default=False,
-        help="print recorded results to console too",
-    )
-    group.addoption(
-        "--regtest-consider-line-endings",
-        action="store_true",
-        default=False,
-        help="do not strip whitespaces at end of recorded lines",
-    )
-    group.addoption(
-        "--regtest-nodiff",
-        action="store_true",
-        default=False,
-        help="do not show diff output for failed regresson tests",
-    )
-    group.addoption(
-        "--regtest-disable-stdconv",
-        action="store_true",
-        default=False,
-        help=(
-            "do not apply standard output converters to clean up indeterministic output"
-        ),
-    )
-
-
-def pytest_configure(config):
-    common = PytestRegtestCommonHooks()
-    config.pluginmanager.register(common)
-    config.pluginmanager.register(PytestRegtestPlugin(common))
-    config.pluginmanager.register(SnapshotPlugin(common))
-
-
-@pytest.fixture
-def regtest(request):
-    yield RegtestStream(request)
-
-
-@pytest.fixture
-def snapshot(request):
-    yield Snapshot(request)
-
-
-@pytest.fixture
-def regtest_all(regtest):
-    yield regtest
-
-
-snapshot_all_output = regtest_all
-
-register_python_object_handler()
-
-try:
-    import pandas  # noqa: F401
-
-    register_pandas_handler()
-except ImportError:
-    pass
-
-try:
-    import numpy  # noqa: F401
-
-    register_numpy_handler()
-except ImportError:
-    pass
-
-try:
-    import polars  # noqa: F401
-
-    register_polars_handler()
-except ImportError:
-    pass

pytest_regtest/numpy_handler.py

@@ -1,216 +0,0 @@
-import difflib
-import io
-import os.path
-import warnings
-
-import numpy as np
-
-from .snapshot_handler import BaseSnapshotHandler
-from .utils import highlight_mismatches
-
-
-class NumpyHandler(BaseSnapshotHandler):
-    def __init__(self, handler_options, pytest_config, tw):
-        self.atol = handler_options.get("atol", 0.0)
-        self.rtol = handler_options.get("rtol", 0.0)
-        self.equal_nan = handler_options.get("equal_nan", True)
-        if handler_options.get("print_options"):
-            warnings.warn(
-                "please use the numpy.printoptions context manager instead of"
-                " the print_options argument.",
-                DeprecationWarning,
-            )
-
-        self.print_options = np.get_printoptions() | handler_options.get(
-            "print_options", {}
-        )
-
-    def _filename(self, folder):
-        return os.path.join(folder, "arrays.npy")
-
-    def save(self, folder, obj):
-        np.save(self._filename(folder), obj)
-
-    def load(self, folder):
-        return np.load(self._filename(folder))
-
-    def show(self, obj):
-        stream = io.StringIO()
-        with np.printoptions(**self.print_options):
-            print(obj, file=stream)
-        return stream.getvalue().splitlines()
-
-    def compare(self, current_obj, recorded_obj):
-        return (
-            isinstance(current_obj, np.ndarray)
-            and current_obj.shape == recorded_obj.shape
-            and current_obj.dtype == recorded_obj.dtype
-            and np.allclose(
-                recorded_obj,
-                current_obj,
-                atol=self.atol,
-                rtol=self.rtol,
-                equal_nan=self.equal_nan,
-            )
-        )
-
-    def show_differences(self, current_obj, recorded_obj, has_markup):
-        lines = []
-
-        if recorded_obj.dtype != current_obj.dtype:
-            lines.extend(
-                [
-                    f"dtype mismatch: current dtype: {current_obj.dtype}",
-                    f"               recorded dtype: {recorded_obj.dtype}",
-                ]
-            )
-
-        recorded_as_text = self.show(recorded_obj)
-        current_as_text = self.show(current_obj)
-
-        if recorded_obj.shape == current_obj.shape:
-            if np.allclose(current_obj, recorded_obj, rtol=self.rtol, atol=self.atol):
-                return lines or None
-
-            lines.extend(self.error_diagnostics(recorded_obj, current_obj))
-
-        else:
-            lines.extend(
-                [
-                    f"shape mismatch: current shape: {current_obj.shape}",
-                    f"               recorded shape: {recorded_obj.shape}",
-                ]
-            )
-
-        if recorded_obj.ndim > 2:
-            return lines
-
-        if recorded_obj.ndim == 1:
-            diff_lines = list(
-                difflib.unified_diff(
-                    current_as_text,
-                    recorded_as_text,
-                    "current",
-                    "expected",
-                    lineterm="",
-                )
-            )
-            lines.append("")
-            lines.extend(diff_lines)
-
-        else:
-            diff_lines = self.error_diagnostics_2d_linewise(
-                current_obj,
-                current_as_text,
-                recorded_obj,
-                recorded_as_text,
-                has_markup,
-            )
-            lines.extend(diff_lines)
-
-        if not diff_lines:
-            lines.append("diff is empty, you may want to change the print options")
-
-        return lines
-
-    def error_diagnostics(self, recorded_obj, current_obj):
-        with warnings.catch_warnings():
-            warnings.simplefilter("ignore", RuntimeWarning)
-            rel_err = np.abs(current_obj - recorded_obj) / recorded_obj
-        rel_err[(recorded_obj == 0) * (current_obj == recorded_obj)] = 0.0
-        rel_err_max_1 = np.max(rel_err)
-        rel_err_max_2 = np.max(rel_err[recorded_obj != 0])
-
-        abs_err = np.abs(current_obj - recorded_obj)
-        abs_err_max = np.max(abs_err)
-
-        lines = []
-
-        if rel_err_max_1 == rel_err_max_2:
-            lines.append(f"max relative deviation: {rel_err_max_1:e}")
-        else:
-            lines.append(f"max relative deviation: {rel_err_max_1:e}")
-            lines.append(f"max relative deviation except inf: {rel_err_max_2:e}")
-
-        lines.append(f"max absolute deviation: {abs_err_max:e}")
-
-        n_diff = np.sum(
-            np.logical_not(
-                np.isclose(current_obj, recorded_obj, rtol=self.rtol, atol=self.atol)
-            )
-        )
-
-        lines.append(
-            f"both arrays differ in {n_diff} out of {np.prod(recorded_obj.shape)}"
-            " entries"
-        )
-        lines.append(
-            f"up to given precision settings rtol={self.rtol:e} and"
-            f" atol={self.atol:e}"
-        )
-
-        return lines
-
-    def error_diagnostics_2d_linewise(
-        self, current_obj, current_as_text, recorded_obj, recorded_as_text, has_markup
-    ):
-        sub_diff = []
-
-        for i, (l1, l2, r1, r2) in enumerate(
-            zip(current_as_text, recorded_as_text, current_obj, recorded_obj)
-        ):
-            if r1.shape == r2.shape and np.allclose(
-                r1, r2, rtol=self.rtol, atol=self.atol
-            ):
-                continue
-
-            if r1.shape == r2.shape:
-                # enforces more uniform formatting of both lines:
-                rows_together = np.vstack((r1, r2))
-                lines_together = self.show(rows_together)
-                line_diff = list(
-                    difflib.unified_diff(
-                        [lines_together[0][1:].strip()],
-                        [lines_together[1][:-1].strip()],
-                        "current",
-                        "expected",
-                        lineterm="",
-                    )
-                )
-            else:
-                row_1 = self.show(r1)
-                row_2 = self.show(r2)
-                line_diff = list(
-                    difflib.unified_diff(
-                        row_1,
-                        row_2,
-                        "current",
-                        "expected",
-                        lineterm="",
-                    )
-                )
-
-            if line_diff:
-                if not sub_diff:
-                    sub_diff = line_diff[:2]
-
-                l1, l2 = line_diff[-2], line_diff[-1]
-                if has_markup:
-                    l1, l2 = highlight_mismatches(l1, l2)
-
-                sub_diff.append(f"row {i:3d}: {l1}")
-                sub_diff.append(f"         {l2}")
-
-        missing = len(current_as_text) - len(recorded_as_text)
-        if missing > 0:
-            for i, row in enumerate(current_as_text[-missing:], len(recorded_as_text)):
-                # remove duplicate brackets
-                row = row.rstrip("]") + "]"
-                sub_diff.append(f"row {i:3d}: -{row.lstrip()}")
-        if missing < 0:
-            for i, row in enumerate(recorded_as_text[missing:], len(current_as_text)):
-                # remove duplicate brackets
-                row = row.rstrip("]") + "]"
-                sub_diff.append(f"row {i:3d}: +{row.lstrip()}")
-
-        return sub_diff

pytest_regtest/pandas_handler.py

@@ -1,143 +0,0 @@
-import difflib
-import io
-import os.path
-import warnings
-
-import numpy as np
-import pandas as pd
-
-from .snapshot_handler import BaseSnapshotHandler
-
-
-class DataFrameHandler(BaseSnapshotHandler):
-    def __init__(self, handler_options, pytest_config, tw):
-        if handler_options.get("display_options"):
-            warnings.warn(
-                "please use the 'pandas.option_context' context manager instead of"
-                " the display_options argument.",
-                DeprecationWarning,
-            )
-
-        # default contains a few nested dicts and we flatten those, e.g.
-        # { "html": {"border": 1} } -> { "html.border": 1 }
-        default = list(pd.options.display.d.items())
-        default_flattened = {}
-        for k, v in default:
-            if isinstance(v, dict):
-                for k0, v0 in v.items():
-                    default_flattened[f"{k}.{k0}"] = v0
-            else:
-                default_flattened[k] = v
-
-        # overwrite with user settings:
-        items = (default_flattened | handler_options.get("display_options", {})).items()
-
-        # flatten items as required by pandas.option_context:
-        self.display_options_flat = [
-            entry for item in items for entry in (f"display.{item[0]}", item[1])
-        ]
-        self.atol = handler_options.get("atol", 0.0)
-        self.rtol = handler_options.get("rtol", 0.0)
-
-    def _filename(self, folder):
-        return os.path.join(folder, "dataframe.pkl")
-
-    def save(self, folder, obj):
-        obj.to_pickle(self._filename(folder), compression="gzip")
-
-    def load(self, folder):
-        return pd.read_pickle(self._filename(folder), compression="gzip")
-
-    def show(self, obj):
-        stream = io.StringIO()
-        with pd.option_context(*self.display_options_flat):
-            print(obj, file=stream)
-        return stream.getvalue().splitlines()
-
-    def compare(self, current, recorded):
-        missing = set(
-            n
-            for (n, t) in set(zip(recorded.columns, recorded.dtypes))
-            ^ set(zip(current.columns, current.dtypes))
-        )
-
-        if missing:
-            return False
-
-        common = set(
-            n
-            for (n, t) in set(zip(recorded.columns, recorded.dtypes))
-            & set(zip(current.columns, current.dtypes))
-        )
-        current_reduced = current[[n for n in current.columns if n in common]]
-        recorded_reduced = recorded[[n for n in recorded.columns if n in common]]
-
-        def extract(df, selector):
-            return df[[n for (n, t) in zip(df.columns, df.dtypes) if selector(t)]]
-
-        current_reduced_floats = extract(
-            current_reduced, lambda t: t.type is np.float64
-        ).to_numpy()
-
-        current_reduced_other = extract(
-            current_reduced, lambda t: t.type is not np.float64
-        )
-
-        recorded_reduced_floats = extract(
-            recorded_reduced, lambda t: t.type is np.float64
-        ).to_numpy()
-
-        recorded_reduced_other = extract(
-            recorded_reduced, lambda t: t.type is not np.float64
-        )
-
-        return np.allclose(
-            current_reduced_floats,
-            recorded_reduced_floats,
-            atol=self.atol,
-            rtol=self.rtol,
-            equal_nan=True,
-        ) and (current_reduced_other == recorded_reduced_other).all(axis=None)
-
-    def show_differences(self, current, recorded, has_markup):
-        lines = []
-
-        stream = io.StringIO()
-        current.info(buf=stream, verbose=True, memory_usage=False)
-        current_info = stream.getvalue().splitlines()[2:][:-1]
-
-        stream = io.StringIO()
-        recorded.info(buf=stream, verbose=True, memory_usage=False)
-        recorded_info = stream.getvalue().splitlines()[2:][:-1]
-
-        info_diff = list(
-            difflib.unified_diff(
-                current_info,
-                recorded_info,
-                "current",
-                "expected",
-                lineterm="",
-            )
-        )
-        lines.extend(info_diff)
-
-        recorded_as_text = self.show(recorded)
-        current_as_text = self.show(current)
-
-        diffs = list(
-            difflib.unified_diff(
-                current_as_text,
-                recorded_as_text,
-                "current",
-                "expected",
-                lineterm="",
-            )
-        )
-
-        lines.append("")
-        if diffs:
-            lines.extend(diffs)
-        else:
-            lines.append("diff is empty, you may want to change the print options")
-
-        return lines

pytest_regtest/polars_handler.py

@@ -1,114 +0,0 @@
-import difflib
-import io
-import os
-from typing import Any
-
-import polars as pl
-from polars.testing import assert_frame_equal
-
-from .snapshot_handler import BaseSnapshotHandler
-
-
-class PolarsHandler(BaseSnapshotHandler):
-    """
-    PolarsHandler is a class for handling Polars DataFrame snapshots in pytest-regtest.
-    """
-
-    def __init__(self, handler_options: dict[str, Any], pytest_config, tw):
-        self.atol = handler_options.get("atol", 0.0)
-        self.rtol = handler_options.get("rtol", 0.0)
-        self.display_options = handler_options.get("display_options", None)
-
-    def _filename(self, folder: str | os.PathLike[Any]) -> str:
-        return os.path.join(folder, "polars.parquet")
-
-    def save(self, folder: str | os.PathLike[Any], obj: pl.DataFrame):
-        obj.write_parquet(self._filename(folder))
-
-    def load(self, folder: str | os.PathLike[Any]) -> pl.DataFrame:
-        return pl.read_parquet(self._filename(folder))
-
-    def show(self, obj: pl.DataFrame) -> list[str]:
-        stream = io.StringIO()
-        if self.display_options:
-            with pl.Config(**self.display_options):
-                stream.write(str(obj))
-        else:
-            stream.write(str(obj))
-        return stream.getvalue().splitlines()
-
-    def compare(self, current_obj: pl.DataFrame, recorded_obj: pl.DataFrame) -> bool:
-        try:
-            assert_frame_equal(
-                current_obj, recorded_obj, atol=self.atol, rtol=self.rtol
-            )
-            return True
-        except AssertionError:
-            return False
-
-    @staticmethod
-    def create_schema_info(df: pl.DataFrame) -> list[str]:
-        """
-        Generate a summary of the schema information for a given Polars DataFrame.
-
-        Parameters:
-            df (pl.DataFrame): The Polars DataFrame for which to generate schema information.
-
-        Returns:
-            list[str]: A list of strings representing the schema information, including
-                   the total number of columns, column names, non-null counts, and data types.
-        """
-        schema = df.schema
-        schema_string_repr = [
-            "Data columns (total {} columns):".format(len(schema)),
-            " #   Column  Non-Null Count  Dtype  ",
-            "---  ------  --------------  -----  ",
-        ]
-        for i, (column, dtype) in enumerate(schema.items()):
-            total_count = df.height
-            null_count = df[column].null_count()
-            non_null_count = total_count - null_count
-            dtype_str = str(dtype)
-            schema_string_repr.append(
-                f" {i}   {column}       {non_null_count} non-null      {dtype_str}"
-            )
-        return schema_string_repr
-
-    def show_differences(
-        self, current_obj: pl.DataFrame, recorded_obj: pl.DataFrame, has_markup: bool
-    ) -> list[str]:
-        lines = []
-
-        current_schema = self.create_schema_info(current_obj)
-        recorded_schema = self.create_schema_info(recorded_obj)
-
-        info_diff = list(
-            difflib.unified_diff(
-                current_schema,
-                recorded_schema,
-                "current",
-                "expected",
-                lineterm="",
-            )
-        )
-        lines.extend(info_diff)
-        recorded_as_text = self.show(recorded_obj)
-        current_as_text = self.show(current_obj)
-
-        diffs = list(
-            difflib.unified_diff(
-                current_as_text,
-                recorded_as_text,
-                "current",
-                "expected",
-                lineterm="",
-            )
-        )
-
-        lines.append("")
-        if diffs:
-            lines.extend(diffs)
-        else:
-            lines.append("diff is empty, you may want to change the print options")
-
-        return lines