pytest-regtest 2.2.1__py2.py3-none-any.whl → 2.3.1__py2.py3-none-any.whl

pytest_regtest/__init__.py

@@ -16,7 +16,9 @@ from .pytest_regtest import (
 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__)
@@ -97,3 +99,10 @@ try:
     register_numpy_handler()
 except ImportError:
     pass
+
+try:
+    import polars  # noqa: F401
+
+    register_polars_handler()
+except ImportError:
+    pass

pytest_regtest/numpy_handler.py

@@ -11,12 +11,19 @@ from .utils import highlight_mismatches
 
 class NumpyHandler(BaseSnapshotHandler):
     def __init__(self, handler_options, pytest_config, tw):
-        self.print_options = np.get_printoptions() | handler_options.get(
-            "print_options", {}
-        )
         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")

pytest_regtest/pandas_handler.py

@@ -1,6 +1,7 @@
 import difflib
 import io
 import os.path
+import warnings
 
 import numpy as np
 import pandas as pd
@@ -10,6 +11,13 @@ 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())

pytest_regtest/polars_handler.py

@@ -0,0 +1,114 @@
+import difflib
+import io
+import os
+from typing import Any, Union
+
+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: Union[str, os.PathLike[Any]]) -> str:
+        return os.path.join(folder, "polars.parquet")
+
+    def save(self, folder: Union[str, os.PathLike[Any]], obj: pl.DataFrame):
+        obj.write_parquet(self._filename(folder))
+
+    def load(self, folder: Union[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

pytest_regtest/pytest_regtest.py

@@ -271,8 +271,7 @@ class SnapshotPlugin:
             return SnapshotException(results)
 
     def check_snapshot(self, idx, item, snapshot):
-        obj, version, handler_options, _ = snapshot
-        handler = get_snapshot_handler(obj, handler_options, item.config)
+        handler, obj, version, _ = snapshot
 
         test_folder = item.fspath.dirname
         if version is not None:
@@ -328,11 +327,10 @@ class SnapshotPlugin:
                 path = item.fspath.relto(item.session.fspath)
                 code_lines = item.fspath.readlines()
 
-                for obj, version, handler_options, line_no in snapshots:
+                for handler, obj, version, line_no in snapshots:
                     info = code_lines[line_no - 1].strip()
                     tw.line(f"> {path} +{line_no}")
                     tw.line(f"> {info}")
-                    handler = get_snapshot_handler(obj, handler_options, item.config)
                     lines = handler.show(obj)
                     for line in lines:
                         tw.line(line, cyan=True)
@@ -490,9 +488,14 @@ class Snapshot:
 
         self.snapshots = []
 
-    def check(self, obj, *, version=None, **kw):
+    def check(self, obj, *, version=None, **options):
+        handler_class = SnapshotHandlerRegistry.get_handler(obj)
+        if handler_class is None:
+            raise ValueError(f"no handler registered for {obj}")
+
+        handler = handler_class(options, self.request.config, tw)
         line_no = inspect.currentframe().f_back.f_lineno
-        self.snapshots.append((obj, version, kw, line_no))
+        self.snapshots.append((handler, obj, version, line_no))
 
 
 def cleanup(output, request):
@@ -631,10 +634,3 @@ class CollectErrorRepr(TerminalRepr):
     def toterminal(self, out):
         for message, color in zip(self.messages, self.colors):
             out.line(message, **color)
-
-
-def get_snapshot_handler(obj, handler_options, pytest_config):
-    handler = SnapshotHandlerRegistry.get_handler(obj)
-    if handler is None:
-        raise ValueError(f"cannot take snapshot for type {obj.__class__}")
-    return handler(handler_options, pytest_config, tw)

pytest_regtest/register_third_party_handlers.py

@@ -26,3 +26,18 @@ def register_numpy_handler():
     from .snapshot_handler import SnapshotHandlerRegistry
 
     SnapshotHandlerRegistry.add_handler(is_numpy, NumpyHandler)
+
+
+def register_polars_handler():
+    def is_polars(obj):
+        try:
+            import polars as pl
+
+            return isinstance(obj, pl.DataFrame)
+        except ImportError:
+            return False
+
+    from .polars_handler import PolarsHandler
+    from .snapshot_handler import SnapshotHandlerRegistry
+
+    SnapshotHandlerRegistry.add_handler(is_polars, PolarsHandler)

pytest_regtest/snapshot_handler.py

@@ -14,15 +14,14 @@ class BaseSnapshotHandler(abc.ABC):
     Abstract base class to implement snapshot handlers.
     """
 
+    @abc.abstractmethod
     def __init__(
-        self,
         handler_options: dict[str, Any],
         pytest_config: type[pytest.Config],
         tw: int,
     ) -> None:
         """
-        This method does not need to be implemented in a subclass, but
-        can e.g. be used to process entries from `handler_options`.
+        This method is called within `snapshot.check` to configure the handler.
 
         Parameters:
                 handler_options: Keyword arguments from `shapshot.check` call
@@ -31,7 +30,7 @@ class BaseSnapshotHandler(abc.ABC):
         """
 
     @abc.abstractmethod
-    def save(self, folder: Union[str, os.PathLike], obj: Any) -> None:
+    def save(self, folder: Union[str, os.PathLike[Any]], obj: Any) -> None:
         """
         This method is called when a snapshot is reset, and a subclass must store the
         given object in the given folder. How this folder is managed internally is
@@ -46,7 +45,7 @@ class BaseSnapshotHandler(abc.ABC):
         """
 
     @abc.abstractmethod
-    def load(self, folder: Union[str, os.PathLike]) -> Any:
+    def load(self, folder: Union[str, os.PathLike[Any]]) -> Any:
         """
         This method loads an existing snapshot from the given folder and must
         be consistent with the `save` method.

{pytest_regtest-2.2.1.dist-info → pytest_regtest-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pytest-regtest
-Version: 2.2.1
+Version: 2.3.1
 Summary: pytest plugin for snapshot regression testing
 Project-URL: Source, https://gitlab.com/uweschmitt/pytest-regtest
 Project-URL: Documentation, https://pytest-regtest.readthedocs.org
@@ -25,7 +25,10 @@ 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; extra == 'dev'
 Requires-Dist: pandas; extra == 'dev'
+Requires-Dist: pandas>=2; extra == 'dev'
+Requires-Dist: polars>=1.9; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
@@ -33,6 +36,13 @@ 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
+https://pytest-regtest.readthedocs.org
+
 # About
 
 ## Introduction
@@ -42,7 +52,7 @@ Description-Content-Type: text/markdown
 
 Unlike [functional testing](https://en.wikipedia.org/wiki/Functional_testing),
 [regression testing](https://en.wikipedia.org/wiki/Regression_testing)
-testing does not test whether the software produces the correct
+does not test whether the software produces the correct
 results, but whether it behaves as it did before changes were introduced.
 
 More specifically, `pytest-regtest` provides **snapshot testing**, which
@@ -58,30 +68,41 @@ To install and activate this plugin execute:
     $ pip install pytest-regtest
 
 
+!!! 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.
+
+
 ## Use case 1: Changing code with no or little testing setup yet
 If you're working with code that has little or no unit testing, you
 can use regression testing to ensure that your changes don't break or
 alter previous results.
 
-**Example**: This can be useful when working with scientific data
-analysis scripts, which often start a long script and then are
-restructured into different functions.
+**Example**:
+This can be useful when working with data analysis scripts, which often
+start as one long script and then are restructured into different
+functions as they evolve.
 
 
 ## Use case 2:  Testing complex data
-
-If your unit tests contain a lot of `assert` statements to check
-a complex data structure you can use regression tests instead.
+If a unit tests contains many `assert` statements to check a complex
+data structure you can use regression tests instead.
 
 **Example**: To test code which ingests data into a database one can
 use regression tests on textual database dumps.
 
-## Use case 3: Testing numpy arrays or pandas data frames
+## Use case 3: Testing NumPy arrays or pandas data frames
+
+If your code generates numerical results, such as `NumPy` arrays,
+`pandas` or `polars` data frames, you can use `pytest-regtest` to simply record such
+results and test them later, taking into account relative and absolute
+tolerances.
 
-If code produces numerical results, such as `numpy` arrays or
-`pandas` data frames, you can use `pytest-regtest` to simply record
-such results and test later with considering relative
-and absolute tolerances.
 
 **Example**:
 A function creates a 10 x 10 matrix. Either you have to write 100

pytest_regtest-2.3.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+pytest_regtest/__init__.py,sha256=q3wEEi3ZZXaN5CXc0jKCeupbAl73t64Fz1pFNcYYPYo,2536
+pytest_regtest/numpy_handler.py,sha256=hKrVY9dId-45rUR_83w9jbUWgUhd0ABk8uLbOhgm0IM,7173
+pytest_regtest/pandas_handler.py,sha256=7vKaHyODcKMltgn9MbbbL1FsOBQK994dEY5fVlDoQ1g,4528
+pytest_regtest/polars_handler.py,sha256=G25GmzZo95MzHoehvKXiv-SV8TkKA4TnLEqQ-nZa3d8,3796
+pytest_regtest/pytest_regtest.py,sha256=umtd97AIpY4FpaYJCd741mTlJbrToWkUfrkoKCvHDAE,22135
+pytest_regtest/register_third_party_handlers.py,sha256=mfmcyeMKuxFykkKLO7T1Tz5RPitn1pKLYRM7B9lA1Kg,1132
+pytest_regtest/snapshot_handler.py,sha256=MbWpNYOSkhQRs6U0qLT1kz5CV6JCay26yHntju8h9uU,6046
+pytest_regtest/utils.py,sha256=2jYTlV_qL5hH6FCeg7T1HJJvKual-Kux2scJ9_aB1lY,811
+pytest_regtest-2.3.1.dist-info/METADATA,sha256=16asDzUZLiNEDdtGYRvqz9bp_XAk4uEbbqxmtkwLT90,4087
+pytest_regtest-2.3.1.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+pytest_regtest-2.3.1.dist-info/entry_points.txt,sha256=4VuIhXeMGhDo0ATbaUfyjND0atofmZjV_P-o6_uEk2s,36
+pytest_regtest-2.3.1.dist-info/licenses/LICENSE.txt,sha256=Tue36uAzpW79-9WAqzkwPhsDDVd1X-VWUmdZ0MfGYvk,1068
+pytest_regtest-2.3.1.dist-info/RECORD,,

pytest_regtest-2.2.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-pytest_regtest/__init__.py,sha256=d-L1wYyQqhts4dHKV5SnOqlhyjk6I7Yva78xgDrS8Zk,2408
-pytest_regtest/numpy_handler.py,sha256=UZyp9GqO07Kq07qgNSGJq5JXw2vUlgfljGeoxco95Mk,6919
-pytest_regtest/pandas_handler.py,sha256=wlCVYLQU_CJ0x6r9Nok3ToF4CXm8eydBkoil-Nu2rEk,4249
-pytest_regtest/pytest_regtest.py,sha256=NfeOsO-YtnEq0K7fltTQMvFmA4EP6QWlqg3r59ABLyw,22344
-pytest_regtest/register_third_party_handlers.py,sha256=UboIatgRB8I2uvZyL-4BfRLZw5YDyh2wpElP8jeOH10,755
-pytest_regtest/snapshot_handler.py,sha256=QxPKP8fNA69OEFUcfM0OlYUzd3cYrMgSOqzRzbYxpxM,6085
-pytest_regtest/utils.py,sha256=2jYTlV_qL5hH6FCeg7T1HJJvKual-Kux2scJ9_aB1lY,811
-pytest_regtest-2.2.1.dist-info/METADATA,sha256=6qoBsWn6A8m37ff-PnqJRnivHf1KjlAvDnuaS23GZy0,3302
-pytest_regtest-2.2.1.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-pytest_regtest-2.2.1.dist-info/entry_points.txt,sha256=4VuIhXeMGhDo0ATbaUfyjND0atofmZjV_P-o6_uEk2s,36
-pytest_regtest-2.2.1.dist-info/licenses/LICENSE.txt,sha256=Tue36uAzpW79-9WAqzkwPhsDDVd1X-VWUmdZ0MfGYvk,1068
-pytest_regtest-2.2.1.dist-info/RECORD,,