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

pytest_regtest/snapshot_handler.py

@@ -1,188 +0,0 @@
-import abc
-import difflib
-import os
-import pickle
-import pprint
-from collections.abc import Callable
-from typing import Any, Union
-
-import pytest
-
-
-class BaseSnapshotHandler(abc.ABC):
-    """
-    Abstract base class to implement snapshot handlers.
-    """
-
-    @abc.abstractmethod
-    def __init__(
-        handler_options: dict[str, Any],
-        pytest_config: type[pytest.Config],
-        tw: int,
-    ) -> None:
-        """
-        This method is called within `snapshot.check` to configure the handler.
-
-        Parameters:
-                handler_options: Keyword arguments from `shapshot.check` call
-                pytest_config: `pytest` config object.
-                tw: Terminal width.
-        """
-
-    @abc.abstractmethod
-    def save(self, folder: Union[str, os.PathLike], 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
-        entirely up to the snapshot handler. It can be a single file, or a complex
-        structure of multiple files and sub-folders.
-
-
-        Parameters:
-                folder: Path to the folder. The folder exists already when this
-                        method is called.
-                obj: The object from the `snapshot.check` call.
-        """
-
-    @abc.abstractmethod
-    def load(self, folder: Union[str, os.PathLike]) -> Any:
-        """
-        This method loads an existing snapshot from the given folder and must
-        be consistent with the `save` method.
-
-        Parameters:
-                folder: Path to the folder. The folder exists already when this
-                        method is called.
-
-        Returns:
-               The loaded object.
-        """
-
-    @abc.abstractmethod
-    def show(self, obj: Any) -> list[str]:
-        """
-        This method returns a line wise textual representation of the given object.
-
-        Parameters:
-                obj: The object the snapshot handler is managing.
-
-        Returns:
-                List of strings.
-        """
-
-    @abc.abstractmethod
-    def compare(self, current_obj: Any, recorded_obj: Any) -> bool:
-        """
-        The method compares if the current object from the
-        `snapshot.check` call and the object loaded with the `load`
-        method are considered to be the same. If this returns `True`
-        the `snapshot.check` call will pass.
-
-        Parameters:
-                current_obj: The object the snapshot handler receiving from
-                            `snapshot.check`.
-                recorded_obj: The object the snapshot handler is loading with
-                        the `load` method.
-
-        Returns:
-                Boolean value which decides is the `snapshot.check` call will pass.
-        """
-
-    @abc.abstractmethod
-    def show_differences(
-        self, current_obj: Any, recorded_obj: Any, has_markup: bool
-    ) -> list[str]:
-        """
-        The method shows differences between the object from the
-        `snapshot.check` call and the object loaded with the `load`
-        method.
-
-        Parameters:
-                current_obj: The object the snapshot handler receiving from
-                            `snapshot.check`.
-                recorded_obj: The object the snapshot handler is loading with
-                        the `load` method.
-                has_markup: Indicates if the tests run within a terminal and
-                        the method can use color output in case `has_markup` is
-                        `True`.
-
-        Returns:
-                List of strings to describe the differences.
-        """
-
-
-class SnapshotHandlerRegistry:
-    """
-    This class serves as a registry for the builtin snapshot handlers
-    and can be used to add more handlers for particular data types.
-    """
-
-    _snapshot_handlers: list[tuple[Callable[[Any], bool]]] = []
-
-    @classmethod
-    def add_handler(
-        clz,
-        check_function: Callable[[Any], bool],
-        handler_class: type[BaseSnapshotHandler],
-    ):
-        """Add a handler.
-
-        Parameters:
-                check_function: A function which takes an object and returns `True`
-                                if the `handler_class` argument should be
-                                used for the given object.
-        """
-
-        clz._snapshot_handlers.append((check_function, handler_class))
-
-    @classmethod
-    def get_handler(clz, obj: Any) -> BaseSnapshotHandler:
-        """Find and initialize handler for the given object.
-
-        Parameters:
-            obj: The object for which we try to find a handler.
-
-        Returns:
-            An instance of the handler or `None` if no appropriate handler was found.
-        """
-        for check_function, handler in clz._snapshot_handlers:
-            if check_function(obj):
-                return handler
-        return None
-
-
-class PythonObjectHandler(BaseSnapshotHandler):
-    def __init__(self, handler_options, pytest_config, tw):
-        self.compact = handler_options.get("compact", False)
-
-    def save(self, folder, obj):
-        with open(os.path.join(folder, "object.pkl"), "wb") as fh:
-            pickle.dump(obj, fh)
-
-    def load(self, folder):
-        with open(os.path.join(folder, "object.pkl"), "rb") as fh:
-            return pickle.load(fh)
-
-    def show(self, obj):
-        return pprint.pformat(obj, compact=self.compact).splitlines()
-
-    def compare(self, current_obj, recorded_obj):
-        return recorded_obj == current_obj
-
-    def show_differences(self, current_obj, recorded_obj, has_markup):
-        return list(
-            difflib.unified_diff(
-                self.show(current_obj),
-                self.show(recorded_obj),
-                "current",
-                "expected",
-                lineterm="",
-            )
-        )
-
-
-def register_python_object_handler():
-    SnapshotHandlerRegistry.add_handler(
-        lambda obj: isinstance(obj, (int, float, str, list, tuple, dict, set)),
-        PythonObjectHandler,
-    )

pytest_regtest/utils.py

@@ -1,28 +0,0 @@
-def highlight_mismatches(l1, l2):
-    if not l1 and not l2:
-        return l1, l2
-
-    l1 = l1.ljust(max(len(l1), len(l2)), " ")
-    l2 = l2.ljust(max(len(l1), len(l2)), " ")
-
-    chars_1 = [l1[0]]
-    chars_2 = [l2[0]]
-    UNDERLINE_ON = "\x1b[21m"
-    UNDERLINE_OFF = "\x1b[24m"
-
-    is_invert = False
-
-    for c1, c2 in zip(l1[1:], l2[1:]):
-        if not is_invert and c1 != c2:
-            chars_1.append(UNDERLINE_ON)
-            chars_2.append(UNDERLINE_ON)
-            is_invert = True
-        if is_invert and c1 == c2:
-            chars_1.append(UNDERLINE_OFF)
-            chars_2.append(UNDERLINE_OFF)
-            is_invert = False
-        chars_1.append(c1)
-        chars_2.append(c2)
-    chars_1.append(UNDERLINE_OFF)
-    chars_2.append(UNDERLINE_OFF)
-    return "".join(chars_1), "".join(chars_2)

pytest_regtest-2.3.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-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=B1CFNz0L96W8ktFMAT_j13q7nJZVN8ug402ILJjuBZA,3771
-pytest_regtest/pytest_regtest.py,sha256=umtd97AIpY4FpaYJCd741mTlJbrToWkUfrkoKCvHDAE,22135
-pytest_regtest/register_third_party_handlers.py,sha256=mfmcyeMKuxFykkKLO7T1Tz5RPitn1pKLYRM7B9lA1Kg,1132
-pytest_regtest/snapshot_handler.py,sha256=5q1oMisifbQ_i8LCSPsD1OxPVEHVUIWwZeEDcZcBNDI,6036
-pytest_regtest/utils.py,sha256=2jYTlV_qL5hH6FCeg7T1HJJvKual-Kux2scJ9_aB1lY,811
-pytest_regtest-2.3.0.dist-info/METADATA,sha256=AJQuXnr5Dqc2mcGI5zdXdOoxRs227YIa7owdSFY2SQU,4097
-pytest_regtest-2.3.0.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-pytest_regtest-2.3.0.dist-info/entry_points.txt,sha256=4VuIhXeMGhDo0ATbaUfyjND0atofmZjV_P-o6_uEk2s,36
-pytest_regtest-2.3.0.dist-info/licenses/LICENSE.txt,sha256=Tue36uAzpW79-9WAqzkwPhsDDVd1X-VWUmdZ0MfGYvk,1068
-pytest_regtest-2.3.0.dist-info/RECORD,,