Apply ruff formatting to notebooks

Author: FlorentinD

examples/gds-nvl-example.ipynb

@@ -89,7 +89,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "G_sample.node_properties()\n"
+    "G_sample.node_properties()"
    ]
   },
   {
@@ -108,7 +108,12 @@
     "from neo4j_viz.gds import from_gds\n",
     "\n",
     "# TODO inform about automatic size scaling\n",
-    "VG = from_gds(gds, G_sample, size_property=\"pagerank\", additional_node_properties=[\"componentId\", \"subject\"])"
+    "VG = from_gds(\n",
+    "    gds,\n",
+    "    G_sample,\n",
+    "    size_property=\"pagerank\",\n",
+    "    additional_node_properties=[\"componentId\", \"subject\"],\n",
+    ")"
    ]
   },
   {
@@ -143,7 +148,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "VG.render()\n"
+    "VG.render()"
    ]
   },
   {

examples/neo4j-nvl-example.ipynb

@@ -50,7 +50,9 @@
     "    driver.verify_connectivity()\n",
     "\n",
     "    result = driver.execute_query(\n",
-    "        \"MATCH (n)-[r]-(m) RETURN n,r,m LIMIT 10\", database_=\"neo4j\", result_transformer_=Result.graph\n",
+    "        \"MATCH (n)-[r]-(m) RETURN n,r,m LIMIT 10\",\n",
+    "        database_=\"neo4j\",\n",
+    "        result_transformer_=Result.graph,\n",
     "    )\n",
     "\n",
     "    result\n",

python-wrapper/pyproject.toml

@@ -129,5 +129,9 @@ select = [
 
 [tool.mypy]
 strict = true
-exclude = '(^build|^\.?venv)'
+exclude = [
+    '(^build|^\.?venv)',
+    'build',
+    ]
 plugins = ['pydantic.mypy']
+untyped_calls_exclude=["nbconvert"]

scripts/checkstyle.sh

@@ -7,7 +7,7 @@ set -o pipefail
 
 python -m ruff check .
 python -m ruff format --check .
-mypy .
+mypy --config-file python-wrapper/pyproject.toml .
 
 
 if [ "${SKIP_NOTEBOOKS:-false}" == "true" ]; then

scripts/clean_notebooks.py

@@ -25,11 +25,15 @@ class CustomClearOutputPreprocessor(Preprocessor):
     Option to keep cell output for cells with a given metadata tag
     """
 
-    def preprocess_cell(self, cell: Any, resources: Any, cell_index: Any) -> tuple[Any, Any]:
+    def preprocess_cell(
+        self, cell: Any, resources: Any, cell_index: Any
+    ) -> tuple[Any, Any]:
         """
         Apply a transformation on each cell. See base.py for details.
         """
-        if cell.cell_type == "code" and PRESERVE_CELL_OUTPUT_KEY not in cell["metadata"].get(METADATA_TAG_KEY, []):
+        if cell.cell_type == "code" and PRESERVE_CELL_OUTPUT_KEY not in cell[
+            "metadata"
+        ].get(METADATA_TAG_KEY, []):
             cell.outputs = []
             cell.execution_count = None
         return cell, resources
@@ -41,7 +45,9 @@ def main(input_path: Path, output_mode: OutputMode) -> None:
 
     exporter = nbconvert.NotebookExporter()
 
-    metadata_cleaner = nbconvert.preprocessors.ClearMetadataPreprocessor(preserve_cell_metadata_mask=METADATA_TAG_KEY)
+    metadata_cleaner = nbconvert.preprocessors.ClearMetadataPreprocessor(
+        preserve_cell_metadata_mask=METADATA_TAG_KEY
+    )
     output_cleaner = CustomClearOutputPreprocessor()  # type: ignore
 
     exporter.register_preprocessor(metadata_cleaner, enabled=True)
@@ -50,7 +56,9 @@ def main(input_path: Path, output_mode: OutputMode) -> None:
     if input_path.is_file():
         notebooks = [input_path]
     else:
-        notebooks = [f for f in input_path.iterdir() if f.is_file() and f.suffix == ".ipynb"]
+        notebooks = [
+            f for f in input_path.iterdir() if f.is_file() and f.suffix == ".ipynb"
+        ]
 
     logger.info(f"Formatting {len(notebooks)} notebooks.")
 
@@ -69,7 +77,9 @@ def main(input_path: Path, output_mode: OutputMode) -> None:
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
     parser.add_argument("-o", "--output", choices=[e.value for e in OutputMode])
-    parser.add_argument("-i", "--input", default="examples", help="path to the notebook file or folder")
+    parser.add_argument(
+        "-i", "--input", default="examples", help="path to the notebook file or folder"
+    )
 
     args = parser.parse_args()
 

scripts/makestyle.sh

@@ -14,5 +14,4 @@ if [ "${SKIP_NOTEBOOKS:-false}" == "true" ]; then
   exit 0
 fi
 
-GIT_ROOT=$(git rev-parse --show-toplevel)
 python "${GIT_ROOT}/scripts/clean_notebooks.py" -i "${GIT_ROOT}/examples/" -o inplace