Adding test coverage to the codespell utility

Author: Alex Lee

.github/workflows/ci.yml

@@ -25,6 +25,8 @@ jobs:
         run: pip install -e .[test]
       - name: Run doctests
         run: pytest --doctest-modules --ignore=causalpy/tests/ causalpy/
+      - name: Run extra tests
+        run: pytest docs/source/.codespell/test_notebook_to_markdown.py
       - name: Run tests
         run: pytest --cov-report=xml --no-cov-on-fail
       - name: Upload coverage to Codecov

.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
     hooks:
       - id: convert-notebooks
         name: Convert Notebooks to Markdown
-        entry: python ./.codespell/notebook_to_markdown.py
+        entry: python ./docs/source/.codespell/notebook_to_markdown.py
         language: python
         pass_filenames: false
         always_run: false
@@ -64,7 +64,7 @@ repos:
             "*.svg",
             "-S",
             "*.ipynb",
-            "--ignore-words=./.codespell/codespell-whitelist.txt",
+            "--ignore-words=./docs/source/.codespell/codespell-whitelist.txt",
           ]
         additional_dependencies:
           # Support pyproject.toml configuration

.codespell/codespell-whitelist.txt renamed to docs/source/.codespell/codespell-whitelist.txt

@@ -0,0 +1,31 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(f\"{os.__file}__\")\n",
+    "\n",
+    "# Speling mistake."
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

.codespell/notebook_to_markdown.py renamed to docs/source/.codespell/notebook_to_markdown.py

@@ -0,0 +1,43 @@
+#   Copyright 2024 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+"""Notebook to markdown tests."""
+
+import os
+from tempfile import TemporaryDirectory
+
+import pytest
+from notebook_to_markdown import notebook_to_markdown
+
+
+@pytest.fixture
+def data_dir() -> str:
+    """Get current directory."""
+    return os.path.join(os.path.dirname(os.path.realpath(__file__)), "test_data")
+
+
+def test_notebook_to_markdown_empty_pattern(data_dir: str) -> None:
+    """Test basic functionality of notebook_to_markdown with empty pattern."""
+    with TemporaryDirectory() as tmp_dir:
+        pattern = "*.missing"
+        notebook_to_markdown(f"{data_dir}/{pattern}", tmp_dir)
+        assert len(os.listdir(tmp_dir)) == 0
+
+
+def test_notebook_to_markdown(data_dir: str) -> None:
+    """Test basic functionality of notebook_to_markdown with a correct pattern."""
+    with TemporaryDirectory() as tmp_dir:
+        pattern = "*.ipynb"
+        notebook_to_markdown(f"{data_dir}/{pattern}", tmp_dir)
+        assert len(os.listdir(tmp_dir)) == 1
+        assert "test_notebook.md" in os.listdir(tmp_dir)