Assertion rewriting & failure reports (#36)

Author: MusicalNinjaDad

CHANGELOG.md

@@ -5,14 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.3.0]
+
+### Added
+
+- Implemented assertion rewriting [#36][pr-36]
+
+### Fixed
+
+- Provide meaningful reports for failing test cases [#36][pr-36]
 
 ### Changed
 
+- Simplified xfail_for interface to take testname as keyword and reason as value [#36][pr-36]
 - Consolidated, simplified tests [#29][pr-29] & made them faster [#31][pr-31]
 
 [pr-29]: https://github.com/MusicalNinjaDad/pytest-ipynb2/pull/29
 [pr-31]: https://github.com/MusicalNinjaDad/pytest-ipynb2/pull/31
+[pr-36]: https://github.com/MusicalNinjaDad/pytest-ipynb2/pull/36
 
 ## [0.2.1] - 2025-02-19
 

__pyversion__

@@ -1 +1 @@
-0.2.2
+0.3.0

justfile

@@ -49,6 +49,9 @@ check:
   @- just test
   @- just type-check
 
+lint-main:
+  uv run ruff check . --config=ruff-main.toml
+
 # format and fix linting errors with ruff
 fix:
   - uv run ruff check . --fix

pyproject.toml

@@ -38,6 +38,7 @@
 
 [build-system]
     requires = ["setuptools"]
+    build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
     where = ["."]
@@ -49,13 +50,13 @@
 [dependency-groups]
     lint = ["ruff"]
     typing = [
-        {include-group = "test"},
+        { include-group = "test" },
         "pytype; python_version <= '3.12'",
         "typing_extensions", # required for Python3.10 and below
     ]
     test = ["pytest-doctest-mkdocstrings"]
     cov = [
-        {include-group = "test"},
+        { include-group = "test" },
         "pytest-cov",
     ]
     doc = [
@@ -66,11 +67,11 @@
         "pymdown-extensions",
     ]
     dev = [
-        {include-group = "lint"},
-        {include-group = "typing"},
-        {include-group = "test"},
-        {include-group = "cov"},
-        {include-group = "doc"},
+        { include-group = "lint" },
+        { include-group = "typing" },
+        { include-group = "test" },
+        { include-group = "cov" },
+        { include-group = "doc" },
         "jupyter", # python's toml decoder won't accept a text entry at the start of the array, only at the end!!
     ]
 
@@ -90,11 +91,11 @@
     source = ["pytest_ipynb2"]
 
 [tool.coverage.report]
-exclude_also = [
-    "def __repr__",
-    "if TYPE_CHECKING:",
-    "except ImportError:",
-    "@overload",
+    exclude_also = [
+        "def __repr__",
+        "if TYPE_CHECKING:",
+        "except ImportError:",
+        "@overload",
     ]
 
 [tool.coverage.html]
@@ -144,7 +145,6 @@ exclude_also = [
     ]
 
 [tool.ruff.lint.per-file-ignores]
-    # Additional ignores for tests 
     "**/test_*.py" = [
         "INP001",  # Missing __init__.py
         "ANN",     # Missing type annotations
@@ -165,10 +165,6 @@ exclude_also = [
         "F401", # Unused imports are fine: using __init__.py to expose them with implicit __ALL__
     ]
 
-    "tests/assets/expected.pyi" = [
-        "ANN001", "ANN201", # Cannot automatically generate type annotations
-    ]
-
     "**/*.ipynb" = [
         "T201",    # Allow `print` in Jupyter notebooks
         "ANN",     # Missing type annotations

pytest_ipynb2/_parser.py

@@ -18,7 +18,7 @@
 
 class SourceList(list):
     """
-    A `list` with non-continuous indices for storing the contents of cells.
+    A `list[str]` with non-continuous indices for storing the contents of cells.
 
     - use a full slice `sourcelist[:]`, not list(sourcelist) to get contents.
     - supports `.ids()` analog to a mapping.keys(), yielding only cell-ids with source.

pytest_ipynb2/_pytester_helpers.py

@@ -128,7 +128,7 @@ class _DummyNode:
         A dummy node for a `CollectionTree`, used by `CollectionTree.from_dict()`.
 
         Compares equal to a genuine `pytest.Node` if:
-            - `type(Node)` == `_DummyNode.nodetype` (strict, subclasses will not match)
+            - `isinstance(Node,_DummyNode.nodetype)`
             - `repr(Node)` == `_DummyNode.name`.
         """
 
@@ -143,7 +143,7 @@ def __eq__(self, other: pytest.Item | pytest.Collector | Self) -> bool:
                 sametype = self.nodetype == other.nodetype
             except AttributeError:
                 samename = self.name == repr(other)
-                sametype = self.nodetype is type(other)
+                sametype = isinstance(other, self.nodetype)
             return samename and sametype
 
         def __repr__(self) -> str:
@@ -269,6 +269,7 @@ def example_dir(
             nbformat.write(nb=nbnode, fp=pytester.path / f"{notebook}.ipynb")
         cached_dir = example_dir_cache[example] = ExampleDir(pytester=pytester)
     else:
+        # 1st keyword is the test name (incl. any parametrized id)
         msg = f"Using cached {cached_dir.path} for {next(iter(request.keywords))}"
         warn(msg, stacklevel=1)
     return example_dir_cache[example]
@@ -279,15 +280,15 @@ def add_ipytest_magic(source: str) -> str:
     return f"%%ipytest\n\n{source}"
 
 
-def pytest_configure(config: pytest.Config) -> None: # pragma: no cover
+def pytest_configure(config: pytest.Config) -> None:  # pragma: no cover
     # Tests will be needed if this ever becomes public functionality
     """Register autoskip & xfail_for marks."""
     config.addinivalue_line("markers", "autoskip: automatically skip test if expected results not provided")
     config.addinivalue_line("markers", "xfail_for: xfail specified tests dynamically")
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_runtest_setup(item: pytest.Function) -> None: # pragma: no cover
+def pytest_runtest_setup(item: pytest.Function) -> None:  # pragma: no cover
     # Tests will be needed if this ever becomes public functionality
     if item.get_closest_marker("autoskip"):
         test_name = item.originalname.removeprefix("test_")
@@ -296,12 +297,12 @@ def pytest_runtest_setup(item: pytest.Function) -> None: # pragma: no cover
             item.add_marker(pytest.mark.skip(reason="No expected results"))
 
 
-def pytest_collection_modifyitems(items: list[pytest.Function]) -> None: # pragma: no cover
+def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:  # pragma: no cover
     # Tests will be needed if this ever becomes public functionality
     """xfail on presence of a custom marker: `xfail_for(tests:list[str], reasons:list[str])`."""  # noqa: D403
     for item in items:
         test_name = item.originalname.removeprefix("test_")
         if xfail_for := item.get_closest_marker("xfail_for"):
-            for xfail_test, reason in zip(xfail_for.kwargs.get("tests"), xfail_for.kwargs.get("reasons")):
+            for xfail_test, reason in xfail_for.kwargs.items():
                 if xfail_test == test_name:
                     item.add_marker(pytest.mark.xfail(reason=reason, strict=True))