pytest-approval 0.1.0__py3-none-any.whl

pytest_approval/__init__.py

@@ -0,0 +1,30 @@
+try:
+    from pytest_approval.main import (
+        verify,
+        verify_binary,
+        verify_image,
+        verify_image_pillow,
+        verify_json,
+    )
+
+    __all__ = (
+        "verify",
+        "verify_binary",
+        "verify_image",
+        "verify_image_pillow",
+        "verify_json",
+    )
+except ImportError:
+    from pytest_approval.main import (
+        verify,
+        verify_binary,
+        verify_image,
+        verify_json,
+    )
+
+    __all__ = (
+        "verify",
+        "verify_binary",
+        "verify_image",
+        "verify_json",
+    )

pytest_approval/approver.toml

@@ -0,0 +1,23 @@
+approvers = [
+    [
+        "meld",
+        "%received",
+        "%approved"
+    ],
+    [
+        "/usr/bin/flatpak",
+        "run",
+        "com.jetbrains.PyCharm-Community",
+        "diff",
+        "%received",
+        "%approved"
+    ],
+    [
+        "alacritty",
+        "--command",
+        "nvim",
+        "-d",
+        "%received",
+        "%approved"
+    ],
+]

pytest_approval/compare.py

@@ -0,0 +1,44 @@
+import filecmp
+import logging
+from pathlib import Path
+
+from pytest_approval.definitions import BINARY_EXTENSIONS
+
+logger = logging.getLogger(__name__)
+
+
+def compare_files(received: Path, approved: Path) -> bool:
+    logger.debug(f"Compare {received} with {approved}.")
+    if filecmp.cmp(received, approved, shallow=False):
+        return True
+    elif received.suffix not in BINARY_EXTENSIONS:
+        return approved.read_text() == received.read_text()
+    else:
+        return False
+
+
+def compare_files_shallow(received: Path, approved: Path) -> bool:
+    logger.debug(f"Compare {received} with {approved}.")
+    if filecmp.cmp(received, approved, shallow=True):
+        return True
+    elif received.suffix not in BINARY_EXTENSIONS:
+        return approved.read_text() == received.read_text()
+    else:
+        return False
+
+
+def compare_image_contents_only(received: Path, approved: Path) -> bool:
+    """Compare image contents without metadata."""
+    try:
+        import numpy
+        from PIL import Image
+    except ImportError as error:
+        raise RuntimeError(
+            'To use content_only, please install "pytest-approval[image]"'
+            + '\n\n\tpip install "pytest-approval[image]"'
+        ) from error
+    received_image = Image.open(received)
+    approved_image = Image.open(approved)
+    received_array = numpy.array(received_image)
+    approved_array = numpy.array(approved_image)
+    return numpy.array_equiv(received_array, approved_array)

pytest_approval/config.py

@@ -0,0 +1,32 @@
+import logging
+import tomllib
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+
+def _find_config(path: Path | None = None) -> Path | None:
+    """Recursively walk up to root from current working dir to find pyproject.toml"""
+    if path is None:
+        path = Path.cwd()
+    if str(path) == path.root:
+        logger.debug("No pyproject.toml found.")
+        return None
+    config_path = path / "pyproject.toml"
+    if config_path.exists():
+        return config_path
+    else:
+        return _find_config(path.parent)
+
+
+def _read_config() -> dict:
+    path = _find_config()
+    if path is None:
+        return {}
+    with open(path, "rb") as file:
+        config = tomllib.load(file)
+    try:
+        return config["tool"]["pytest-approval"]
+    except KeyError:
+        logger.debug("No configuration table found.")
+        return {}

pytest_approval/definitions.py

@@ -0,0 +1,178 @@
+from contextlib import suppress
+from pathlib import Path
+
+from pytest_approval.config import _read_config
+
+BASE_DIR = Path(__file__).parent.resolve()
+
+REPORTERS_TEXT: list[list[str]] = [
+    [
+        "meld",
+        "%received",
+        "%approved",
+    ],
+    [
+        "pycharm",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/flatpak",
+        "run",
+        "com.jetbrains.PyCharm-Community",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/code",
+        "--new-window",
+        "--wait",
+        "--diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/open",
+        # -W: Wait until the application is closed
+        "-W",
+        # -n: new instance
+        "-n",
+        # -a: application
+        "-a",
+        "/Applications/PyCharm Professional Edition.app/Contents/MacOS/pycharm",
+        "--args",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/open",
+        # -W: Wait until the application is closed
+        "-W",
+        # -n: New instance
+        "-n",
+        # -a: Application
+        "-a",
+        "/Applications/PyCharm CE.app/Contents/MacOS/pycharm",
+        "--args",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/open",
+        # -W: Wait until the application is closed
+        "-W",
+        # -n: New instance
+        "-n",
+        # -a: Application
+        "-a",
+        "/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code",
+        "--args",
+        "--new-window",
+        "--wait",
+        "--diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "diff",
+        "--unified",
+        "--color",
+        "--suppress-common-lines",
+        "--label",
+        "received",
+        "--label",
+        "approved",
+        "%received",
+        "%approved",
+    ],
+]
+
+
+REPORTERS_BINARY: list[list[str]] = [
+    [
+        "pycharm",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "/usr/bin/flatpak",
+        "run",
+        "com.jetbrains.PyCharm-Community",
+        "diff",
+        "%received",
+        "%approved",
+    ],
+    [
+        "diff",
+        "--unified",
+        "--color",
+        "--suppress-common-lines",
+        "--label",
+        "received",
+        "--label",
+        "approved",
+        "%received",
+        "%approved",
+    ],
+]
+
+BINARY_EXTENSIONS: list[str] = [
+    # "7z",
+    # "7zip",
+    # "avif",
+    # "bmp",
+    # "bz2",
+    # "bzip2",
+    # "dds",
+    # "dib",
+    # "docx",
+    # "emf",
+    # "exif",
+    # "gif",
+    # "gz",
+    # "gzip",
+    # "heic",
+    # "heif",
+    # "ico",
+    # "j2c",
+    # "jfif",
+    # "jp2",
+    # "jpc",
+    # "jpe",
+    ".jpeg",
+    ".jpg",
+    # "jxr",
+    # "nupkg",
+    # "odp",
+    # "ods",
+    # "odt",
+    # "pbm",
+    # "pcx",
+    # "pdf",
+    # "pgm",
+    ".png",
+    # "ppm",
+    # "pptx",
+    # "rle",
+    # "rtf",
+    # "tar",
+    # "tga",
+    # "tif",
+    # "tiff",
+    # "wdp",
+    # "webp",
+    # "wmp",
+    # "xlsx",
+    # "xz",
+    # "zip",
+]
+
+CONFIG = _read_config()
+
+with suppress(KeyError):
+    REPORTERS_TEXT = list(set(CONFIG["reporters"] + REPORTERS_TEXT))

pytest_approval/empty_files/empty.pbm

@@ -0,0 +1,3 @@
+P4
+1 1
+�

pytest_approval/empty_files/empty.pdf

@@ -0,0 +1,12 @@
+%PDF-1.0
+1 0 obj<</Type/Catalog/Pages 2 0 R>>endobj 2 0 obj<</Type/Pages/Kids[3 0 R]/Count 1>>endobj 3 0 obj<</Type/Page/MediaBox[0 0 3 3]>>endobj
+xref
+0 4
+0000000000 65535 f
+0000000010 00000 n
+0000000053 00000 n
+0000000102 00000 n
+trailer<</Size 4/Root 1 0 R>>
+startxref
+149
+%EOF

pytest_approval/empty_files/empty.rtf

@@ -0,0 +1 @@
+{\rtf}