⬆️ Support nbdime v4 (drop <4 support) (chrisjsewell#62)

This patch addresses the incompatibility with nbdime version 4.
Note this will no longer support v3

Author: amotl

.gitignore

@@ -104,13 +104,19 @@ ENV/
 env.bak/
 venv.bak/
 
+# PyCharm project settings
+.idea
+
 # Spyder project settings
 .spyderproject
 .spyproject
 
 # Rope project settings
 .ropeproject
 
+# VSCode project settings
+.vscode
+
 # mkdocs documentation
 /site
 
@@ -125,4 +131,3 @@ dmypy.json
 .DS_Store
 _archive/
 docs/source/apidoc/
-.vscode/

docs/source/conf.py

@@ -41,6 +41,7 @@
     "_pytest": ("https://doc.pytest.org/en/latest/", None),
     # "PIL": ("http://pillow.readthedocs.org/en/latest/", None),
     "nbclient": ("https://nbclient.readthedocs.io/en/latest/", None),
+    "nbdime": ("https://nbdime.readthedocs.io/en/latest/", None),
     "nbformat": ("https://nbformat.readthedocs.io/en/latest/", None),
     "attr": ("https://www.attrs.org/en/stable/", None),
     "coverage": ("https://coverage.readthedocs.io/en/6.2/", None),
@@ -60,6 +61,7 @@
     ("py:class", "Session"),
     ("py:exc", "nbconvert.preprocessors.CellExecutionError"),
     ("py:class", "nbdime.diff_format.DiffEntry"),
+    ("py:class", "nbdime.diffing.config.DiffConfig"),
     ("py:class", "_pytest._py.path.LocalPath"),
     ("py:meth", "Item.reportinfo"),
 ]

pyproject.toml

@@ -31,7 +31,7 @@ dependencies = [
   "importlib-metadata~=6.0;python_version<'3.10'",
   "importlib-resources~=5.0;python_version<'3.9'",
   "nbclient~=0.5.10",
-  "nbdime",
+  "nbdime>=4",
   "nbformat",
   "jsonschema",
 ]

pytest_notebook/diffing.py

@@ -2,9 +2,10 @@
 import copy
 import operator
 import re
-from typing import List, Sequence, Union
+from typing import List, Sequence
 
 from nbdime.diff_format import DiffEntry, SequenceDiffBuilder
+from nbdime.diffing.config import DiffConfig
 from nbdime.diffing.generic import default_differs, default_predicates, diff
 from nbdime.diffing.notebooks import diff_attachments, diff_single_outputs
 from nbdime.prettyprint import PrettyPrintConfig, pretty_print_diff
@@ -19,23 +20,24 @@ def diff_sequence_simple(
     initial: Sequence,
     final: Sequence,
     path: str = "",
-    predicates: Union[None, dict] = None,
-    differs: Union[None, dict] = None,
+    config: DiffConfig = None,
 ) -> dict:
     """Compute diff of two lists with configurable behaviour.
 
     If the lists are of different lengths,
     we assume that items have been appended or removed from the end of the initial list.
 
     """
+    if config is None:
+        config = DiffConfig()
 
-    if predicates is None:
-        predicates = default_predicates()
-    if differs is None:
-        differs = default_differs()
+    if config.predicates is None:
+        config.predicates = default_predicates()
+    if config.differs is None:
+        config.differs = default_differs()
 
     subpath = "/".join((path, "*"))
-    diffit = differs[subpath]
+    diffit = config.differs[subpath]
 
     di = SequenceDiffBuilder()
 
@@ -48,7 +50,7 @@ def diff_sequence_simple(
                 di.addrange(i, [bval])
                 continue
 
-        cd = diffit(aval, bval, path=subpath, predicates=predicates, differs=differs)
+        cd = diffit(aval, bval, path=subpath, config=config)
         if cd:
             di.patch(i, cd)
 
@@ -75,10 +77,7 @@ def diff_notebooks(
     we shouldn't need to worry about insertions.
 
     """
-    return diff(
-        initial,
-        final,
-        path=initial_path,
+    config = DiffConfig(
         predicates=defaultdict2(lambda: [operator.__eq__], {}),
         differs=defaultdict2(
             lambda: diff,
@@ -91,6 +90,12 @@ def diff_notebooks(
             },
         ),
     )
+    return diff(
+        initial,
+        final,
+        path=initial_path,
+        config=config,
+    )
 
 
 R_IS_INT = re.compile(r"^[-+]?\d+$")