Pydantic v2 compatibility (#119)

* v2 compatibility

* add note to history

HISTORY.md

@@ -1,5 +1,9 @@
 # History
 
+## 0.5.1 (2023-07-18)
+
+- Add support for `pydantic>=2.0.0` ([PR #119](https://github.com/drivendataorg/nbautoexport/pull/119))
+
 ## 0.5.0 (2022-02-16)
 
 - Removes support for Python 3.6.

nbautoexport/sentinel.py

@@ -50,6 +50,20 @@ class NbAutoexportConfig(BaseModel):
     class Config:
         extra = "forbid"
 
+    # deprecated in pydantic v2.0
+    def json(self, *args, **kwargs):
+        if hasattr(self, "model_dump_json"):
+            return self.model_dump_json(*args, **kwargs)
+        else:
+            return super().json(*args, **kwargs)
+
+    # deprecated in pydantic v2.0
+    def dict(self, *args, **kwargs):
+        if hasattr(self, "model_dump"):
+            return self.model_dump(*args, **kwargs)
+        else:
+            return super().dict(*args, **kwargs)
+
 
 def install_sentinel(directory: Path, config: NbAutoexportConfig, overwrite: bool):
     """Writes the configuration file to a specified directory."""

nbautoexport/utils.py

@@ -33,6 +33,10 @@ class JupyterNotebook(BaseModel):
     path: Path
     metadata: nbformat.notebooknode.NotebookNode
 
+    class Config:
+        # NotebookNode not pydantic v2 compatible
+        arbitrary_types_allowed = True
+
     def get_script_extension(self):
         # Match logic of nbconvert.exporters.script.ScriptExporter
         # Order of precedence is: nb_convert_exporter, language, file_extension, .txt
@@ -53,6 +57,13 @@ def from_file(cls, path):
         nbformat.validate(notebook)
         return cls(path=path, metadata=notebook.metadata)
 
+    # deprecated in pydantic v2.0
+    def json(self, *args, **kwargs):
+        if hasattr(self, "model_dump_json"):
+            return self.model_dump_json(*args, **kwargs)
+        else:
+            return super().json(*args, **kwargs)
+
     def __hash__(self):
         return hash(self.json())
 

tests/test_cli_configure.py

@@ -95,7 +95,9 @@ def test_force_overwrite(tmp_path):
     with (tmp_path / ".nbautoexport").open("r", encoding="utf-8") as fp:
         config = json.load(fp)
 
-    expected_config = NbAutoexportConfig(export_formats=["script", "html"], organize_by="notebook")
+    expected_config = NbAutoexportConfig(
+        export_formats=["script", "html"], organize_by="notebook"
+    ).dict()
     assert config == expected_config