Merge pull request #16 from ayasyrev/dev_0.2

v 0.2

Author: ayasyrev

noxfile.py

@@ -1,18 +1,8 @@
 import nox
 
 
-@nox.session(python=["3.8", "3.9", "3.7"])
-def tests(session):
+@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
+def tests(session: nox.Session) -> None:
     args = session.posargs or ["--cov"]
-    session.install(".", "pytest", "pytest-cov", "coverage[toml]")
+    session.install(".", "pytest", "pytest-cov")
     session.run("pytest", *args)
-
-
-locations = "nbdocs", "tests", "noxfile.py"
-
-
-@nox.session(python=["3.8", "3.9", "3.7"])
-def lint(session):
-    args = session.posargs or locations
-    session.install("flake8")
-    session.run("flake8", *args)

noxfile_conda.py

@@ -0,0 +1,9 @@
+import nox
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11"], venv_backend="mamba")
+def tests(session: nox.Session) -> None:
+    args = session.posargs or ["--cov"]
+    session.install("pytest", "pytest-cov")
+    session.install("-e", ".")
+    session.run("pytest", *args)

noxfile_conda_lint.py

@@ -0,0 +1,10 @@
+import nox
+
+locations = "src/nbdocs", "tests", "noxfile.py"
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11"], venv_backend="mamba")
+def lint(session: nox.Session) -> None:
+    args = session.posargs or locations
+    session.conda_install("flake8")
+    session.run("flake8", *args)

noxfile_cov.py

@@ -0,0 +1,16 @@
+import nox
+
+
+@nox.session(python=["3.10"])
+def tests(session: nox.Session) -> None:
+    args = session.posargs or ["--cov"]
+    session.install(".", "pytest", "pytest-cov", "coverage[toml]")
+    session.run("pytest", *args)
+
+
+@nox.session(python="3.10")
+def coverage(session: nox.Session) -> None:
+    """Upload coverage data."""
+    session.install("coverage[toml]", "codecov")
+    session.run("coverage", "xml", "--fail-under=0")
+    session.run("codecov", *session.posargs)

noxfile_lint.py

@@ -0,0 +1,11 @@
+import nox
+
+
+locations = "nbdocs", "tests", "noxfile.py"
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11"])
+def lint(session: nox.Session) -> None:
+    args = session.posargs or locations
+    session.install("flake8")
+    session.run("flake8", *args)

requirements.txt

@@ -1,4 +1,5 @@
 nbformat
 nbconvert
 typer
-rich
+rich
+pydantic

requirements_extra.txt

@@ -1,3 +1,3 @@
-mcdocs
+mkdocs
 mkdocs-material
 pymdown-extensions

setup.cfg

@@ -17,7 +17,7 @@ classifiers =
 package_dir =
     = src
 packages = find:
-python_requires = >=3.7
+python_requires = >=3.8
 
 [options.packages.find]
 where = src

src/nbdocs/clean.py

@@ -1,37 +1,49 @@
 from typing import List, Optional, Tuple, Union
 
+import nbformat
 from nbconvert.exporters.exporter import ResourcesDict
-from nbconvert.preprocessors import ClearMetadataPreprocessor, Preprocessor
+from nbconvert.preprocessors.base import Preprocessor
+from nbconvert.preprocessors.clearmetadata import ClearMetadataPreprocessor
 from nbformat import NotebookNode
-import nbformat
 
-from nbdocs.core import PathOrStr, read_nb, write_nb
+from nbdocs.core import PathOrStr, TPreprocessor, read_nb, write_nb
 
 
 class ClearMetadataPreprocessorRes(ClearMetadataPreprocessor):
     """ClearMetadata Preprocessor same as at nbconvert
     but return True at resources.changed if nb changed."""
 
-    def preprocess_cell(self, cell, resources, cell_index):
+    def preprocess_cell(
+        self,
+        cell: NotebookNode,
+        resources: ResourcesDict,
+        cell_index: int,
+    ) -> Tuple[NotebookNode, ResourcesDict]:
         """
         All the code cells are returned with an empty metadata field.
         """
         if self.clear_cell_metadata:
-            if cell.cell_type == 'code':
+            if cell.cell_type == "code":
                 # Remove metadata
-                if 'metadata' in cell:
+                if "metadata" in cell:
                     current_metadata = cell.metadata
-                    cell.metadata = dict(self.nested_filter(cell.metadata.items(), self.preserve_cell_metadata_mask))
+                    cell.metadata = dict(
+                        self.nested_filter(
+                            cell.metadata.items(), self.preserve_cell_metadata_mask
+                        )
+                    )
                     if cell.metadata != current_metadata:
                         resources["changed"] = True
         return cell, resources
 
-    def preprocess(self, nb, resources):
+    def preprocess(
+        self, nb: NotebookNode, resources: ResourcesDict
+    ) -> Tuple[NotebookNode, ResourcesDict]:
         """
         Preprocessing to apply on each notebook.
-        
+
         Must return modified nb, resources.
-        
+
         Parameters
         ----------
         nb : NotebookNode
@@ -41,9 +53,13 @@ def preprocess(self, nb, resources):
             preprocessors to pass variables into the Jinja engine.
         """
         if self.clear_notebook_metadata:
-            if 'metadata' in nb:
+            if "metadata" in nb:
                 current_metadata = nb.metadata
-                nb.metadata = dict(self.nested_filter(nb.metadata.items(), self.preserve_nb_metadata_mask))
+                nb.metadata = dict(
+                    self.nested_filter(
+                        nb.metadata.items(), self.preserve_nb_metadata_mask
+                    )
+                )
                 if nb.metadata != current_metadata:
                     resources["changed"] = True
         for index, cell in enumerate(nb.cells):
@@ -56,7 +72,12 @@ class ClearExecutionCountPreprocessor(Preprocessor):
     Clear execution_count from all code cells in a notebook.
     """
 
-    def preprocess_cell(self, cell: NotebookNode, resources: ResourcesDict, index: int):
+    def preprocess_cell(
+        self,
+        cell: NotebookNode,
+        resources: ResourcesDict,
+        index: int,
+    ) -> Tuple[NotebookNode, ResourcesDict]:
         """
         Apply a transformation on each cell. See base.py for details.
         """
@@ -78,8 +99,12 @@ class MetadataCleaner:
     """
 
     def __init__(self) -> None:
-        self.cleaner_metadata = ClearMetadataPreprocessorRes(enabled=True)
-        self.cleaner_execution_count = ClearExecutionCountPreprocessor(enabled=True)
+        self.cleaner_metadata: TPreprocessor = ClearMetadataPreprocessorRes(
+            enabled=True
+        )
+        self.cleaner_execution_count: TPreprocessor = ClearExecutionCountPreprocessor(
+            enabled=True
+        )
 
     def __call__(
         self,
@@ -95,7 +120,9 @@ def __call__(
         return nb, resources
 
 
-def clean_nb(nb: NotebookNode, clear_execution_count: bool = True) -> Tuple[NotebookNode, ResourcesDict]:
+def clean_nb(
+    nb: NotebookNode, clear_execution_count: bool = True
+) -> Tuple[NotebookNode, ResourcesDict]:
     """Clean notebook metadata and execution_count.
 
     Args:
@@ -125,7 +152,5 @@ def clean_nb_file(
         nb = read_nb(fn_item, as_version)
         nb, resources = cleaner(nb, clear_execution_count=clear_execution_count)
         if resources["changed"]:
-            write_nb(
-                nb, fn_item, as_version
-            )
+            write_nb(nb, fn_item, as_version)
             print(f"done: {fn_item}")

src/nbdocs/convert.py

@@ -5,7 +5,7 @@
 from nbconvert.exporters.exporter import ResourcesDict
 from nbformat import NotebookNode
 
-from nbdocs.core import read_nb
+from nbdocs.core import TPreprocessor, read_nb
 from nbdocs.process import (
     HideFlagsPreprocessor,
     MarkOutputPreprocessor,
@@ -22,8 +22,10 @@ class MdConverter:
     """MdConverter constructor."""
 
     def __init__(self) -> None:
-        self.md_exporter = nbconvert.MarkdownExporter()
-        self.md_exporter.register_preprocessor(RemoveEmptyCellPreprocessor, enabled=True)
+        self.md_exporter: TPreprocessor = nbconvert.MarkdownExporter()
+        self.md_exporter.register_preprocessor(
+            RemoveEmptyCellPreprocessor, enabled=True
+        )
         self.md_exporter.register_preprocessor(HideFlagsPreprocessor, enabled=True)
         self.md_exporter.register_preprocessor(MarkOutputPreprocessor, enabled=True)
 
@@ -65,7 +67,8 @@ def convert2md(filenames: Union[Path, List[Path]], cfg: NbDocsCfg) -> None:
     md_convertor = MdConverter()
     for nb_fn in filenames:
         nb = read_nb(nb_fn)
-        md, resources = md_convertor.nb2md(nb)
+        resources = ResourcesDict(filename=nb_fn)
+        md, resources = md_convertor.nb2md(nb, resources)
 
         if image_names := resources["image_names"]:
             # dest_images = Path(cfg.docs_path) / cfg.images_path / f"{nb_fn.stem}_files"
@@ -97,6 +100,12 @@ def convert2md(filenames: Union[Path, List[Path]], cfg: NbDocsCfg) -> None:
             fh.write(md)
 
 
+def nb_newer(nb_name: Path, docs_path: Path) -> bool:
+    """return True if nb_name is newer than docs_path."""
+    md_name = (docs_path / nb_name.name).with_suffix(".md")
+    return not md_name.exists() or nb_name.stat().st_mtime > md_name.stat().st_mtime
+
+
 def filter_changed(nb_names: List[Path], cfg: NbDocsCfg) -> List[Path]:
     """Filter list of Nb to changed only (compare modification date with dest name).
 
@@ -109,9 +118,4 @@ def filter_changed(nb_names: List[Path], cfg: NbDocsCfg) -> List[Path]:
         List[Path]: List of Nb filename with newer modification time.
     """
     docs_path = Path(cfg.docs_path)
-    return [
-        nb_name
-        for nb_name in nb_names
-        if not (md_name := (docs_path / nb_name.name).with_suffix(".md")).exists()
-        or nb_name.stat().st_mtime >= md_name.stat().st_mtime
-    ]
+    return [nb_name for nb_name in nb_names if nb_newer(nb_name, docs_path)]

src/nbdocs/core.py

@@ -1,12 +1,16 @@
 from pathlib import Path, PosixPath
-from typing import List, Union, TypeVar
+from typing import Callable, List, Tuple, TypeVar, Union
 
 import nbformat
 import typer
+from nbconvert.exporters.exporter import ResourcesDict
 from nbformat import NotebookNode
 
 
 PathOrStr = TypeVar("PathOrStr", Path, PosixPath, str)
+TPreprocessor = Callable[
+    [NotebookNode, ResourcesDict], Tuple[NotebookNode, ResourcesDict]
+]
 
 
 def read_nb(
@@ -23,7 +27,6 @@ def read_nb(
     """
     with Path(fn).open("r", encoding="utf-8") as fh:
         nb = nbformat.read(fh, as_version=as_version)
-    nb.filename = fn
     return nb
 
 
@@ -41,7 +44,6 @@ def write_nb(
     Returns:
         Path: Filename of writed Nb.
     """
-    nb.pop("filename", None)
     filename = Path(fn)
     if filename.suffix != ".ipynb":
         filename = filename.with_suffix(".ipynb")