Change path manipulations to use pathlib

Author: foster999

jupyter_sphinx/__init__.py

@@ -8,6 +8,7 @@
 from sphinx.util.fileutil import copy_asset
 from sphinx.errors import ExtensionError
 from IPython.lib.lexers import IPythonTracebackLexer, IPython3Lexer
+from pathlib import Path
 
 from .ast import (
     JupyterCell,
@@ -121,18 +122,20 @@ def build_finished(app, env):
     if app.builder.format != "html":
         return
 
+    module_path = Path(__file__)
+    outdir_path = Path(app.outdir)
+
     # Copy stylesheet
-    src = os.path.join(os.path.dirname(__file__), "css")
-    dst = os.path.join(app.outdir, "_static")
+    src = module_path / "css"
+    dst = outdir_path / "_static"
     copy_asset(src, dst)
 
     thebe_config = app.config.jupyter_sphinx_thebelab_config
     if not thebe_config:
         return
 
     # Copy all thebelab related assets
-    src = os.path.join(os.path.dirname(__file__), "thebelab")
-    dst = os.path.join(app.outdir, "_static")
+    src = module_path / "thebelab"
     copy_asset(src, dst)
 
 

jupyter_sphinx/ast.py

@@ -229,7 +229,7 @@ def html(self):
         )
 
 
-def cell_output_to_nodes(outputs, data_priority, write_stderr, dir, thebe_config):
+def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_config):
     """Convert a jupyter cell with outputs and filenames to doctree nodes.
 
     Parameters
@@ -239,7 +239,7 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, dir, thebe_config
         Which media types to prioritize.
     write_stderr : bool
         If True include stderr in cell output
-    dir : string
+    out_dir : string
         Sphinx "absolute path" to the output folder, so it is a relative path
         to the source folder prefixed with ``/``.
     thebe_config: dict
@@ -305,19 +305,17 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, dir, thebe_config
                 continue
             data = output["data"][mime_type]
             if mime_type.startswith("image"):
+                file_path = Path(output.metadata["filenames"][mime_type])
+                out_dir = Path(out_dir)
                 # Sphinx treats absolute paths as being rooted at the source
                 # directory, so make a relative path, which Sphinx treats
                 # as being relative to the current working directory.
-                filename = os.path.basename(output.metadata["filenames"][mime_type])
+                filename = file_path.name
 
-                # checks if file dir path is inside a subdir of dir
-                filedir = os.path.dirname(output.metadata["filenames"][mime_type])
-                subpaths = filedir.split(dir)
-                if subpaths and len(subpaths) > 1:
-                    subpath = subpaths[1]
-                    dir += subpath
+                if out_dir in file_path.parents:
+                    out_dir = file_path.parent
 
-                uri = Path(os.path.join(dir, filename)).as_posix()
+                uri = (out_dir / filename).as_posix()
                 to_add.append(docutils.nodes.image(uri=uri))
             elif mime_type == "text/html":
                 to_add.append(

jupyter_sphinx/execute.py

@@ -1,6 +1,7 @@
 """Execution and managing kernels."""
 
 import os
+from pathlib import Path
 
 from sphinx.transforms import SphinxTransform
 from sphinx.errors import ExtensionError
@@ -86,8 +87,9 @@ class ExecuteJupyterCells(SphinxTransform):
 
     def apply(self):
         doctree = self.document
-        doc_relpath = os.path.dirname(self.env.docname)  # relative to src dir
-        docname = os.path.basename(self.env.docname)
+        docname_path = Path(self.env.docname)
+        doc_dir_relpath = docname_path.parent  # relative to src dir
+        docname = docname_path.name
         default_kernel = self.config.jupyter_execute_default_kernel
         default_names = default_notebook_names(docname)
         thebe_config = self.config.jupyter_sphinx_thebelab_config
@@ -105,7 +107,7 @@ def apply(self):
             add_thebelab_library(doctree, self.env)
 
         js.logger.info("executing {}".format(docname))
-        output_dir = os.path.join(output_directory(self.env), doc_relpath)
+        output_dir = Path(output_directory(self.env)) / doc_dir_relpath
 
         # Start new notebook whenever a JupyterKernelNode is encountered
         jupyter_nodes = (JupyterCellNode, JupyterKernelNode)
@@ -205,7 +207,7 @@ def apply(self):
             # Write certain cell outputs (e.g. images) to separate files, and
             # modify the metadata of the associated cells in 'notebook' to
             # include the path to the output file.
-            write_notebook_output(notebook, output_dir, file_name, self.env.docname)
+            write_notebook_output(notebook, str(output_dir), file_name, self.env.docname)
 
             try:
                 cm_language = notebook.metadata.language_info.codemirror_mode.name
@@ -265,8 +267,10 @@ def write_notebook_output(notebook, output_dir, notebook_name, location=None):
             location=location,
         )
     contents = "\n\n".join(cell.source for cell in notebook.cells)
-    with open(os.path.join(output_dir, notebook_name + ext), "w",
-              encoding = "utf8") as f:
+
+    notebook_file = notebook_name + ext
+    output_dir = Path(output_dir)
+    with (output_dir / notebook_file).open("w", encoding = "utf8") as f:
         f.write(contents)
 
 

jupyter_sphinx/thebelab.py

@@ -3,6 +3,7 @@
 import json
 import docutils
 from docutils.parsers.rst import Directive
+from pathlib import Path
 
 import jupyter_sphinx as js
 
@@ -86,16 +87,17 @@ def add_thebelab_library(doctree, env):
     if isinstance(thebe_config, dict):
         pass
     elif isinstance(thebe_config, str):
-        if os.path.isabs(thebe_config):
+        thebe_config = Path(thebe_config)
+        if thebe_config.is_absolute():
             filename = thebe_config
         else:
-            filename = os.path.join(os.path.abspath(env.app.srcdir), thebe_config)
+            filename = Path(env.app.srcdir).resolve() / thebe_config
 
-        if not os.path.exists(filename):
+        if not filename.exists():
             js.logger.warning("The supplied thebelab configuration file does not exist")
             return
 
-        with open(filename, "r") as config_file:
+        with filename.open("r") as config_file:
             try:
                 thebe_config = json.load(config_file)
             except ValueError:

jupyter_sphinx/utils.py

@@ -75,20 +75,13 @@ def sphinx_abs_dir(env, *paths):
     # output_directory / jupyter_execute / path relative to source directory
     # Sphinx expects download links relative to source file or relative to
     # source dir and prepended with '/'. We use the latter option.
-    out_path = Path(
-        os.path.abspath(
-            os.path.join(output_directory(env), os.path.dirname(env.docname), *paths)
-        )
-    ).as_posix()
-    
+    out_path = (output_directory(env) /  Path(env.docname).parent / Path(*paths)).resolve()
+      
     if os.name == "nt":
         # Can't get relative path between drives on Windows
-        return out_path
+        return out_path.as_posix()
 
-    return "/" + os.path.relpath(
-            out_path,
-            os.path.abspath(env.app.srcdir),
-        )
+    return "/" + out_path.relative_to(env.app.srcdir).as_posix()
 
 
 def output_directory(env):
@@ -99,6 +92,4 @@ def output_directory(env):
 
     # Note: we are using an implicit fact that sphinx output directories are
     # direct subfolders of the build directory.
-    return os.path.abspath(
-        os.path.join(env.app.outdir, os.path.pardir, "jupyter_execute")
-    )
+    return (Path(env.app.outdir) / os.path.pardir / "jupyter_execute").resolve()

tests/test_execute.py

@@ -35,13 +35,13 @@ def doctree():
     def doctree(
         source, config=None, return_warnings=False, entrypoint="jupyter_sphinx"
     ):
-        src_dir = tempfile.mkdtemp()
+        src_dir = Path(tempfile.mkdtemp())
         source_trees.append(src_dir)
-        with open(os.path.join(src_dir, "conf.py"), "w", encoding = "utf8") as f:
+        with (src_dir / "conf.py").open("w", encoding = "utf8") as f:
             f.write("extensions = ['%s']" % entrypoint)
             if config is not None:
                 f.write("\n" + config)
-        with open(os.path.join(src_dir, "contents.rst"), "w", encoding = "utf8") as f:
+        with (src_dir / "contents.rst").open("w", encoding = "utf8") as f:
             f.write(source)
         warnings = StringIO()
         app = SphinxTestApp(srcdir=path(src_dir), status=StringIO(), warning=warnings)
@@ -590,7 +590,7 @@ def test_download_role(text, reftarget, caption, tmp_path):
 
     if os.name == "nt":
         # Get equivalent abs path for Windows
-        reftarget = Path(os.path.join(tmp_path, reftarget[1:])).resolve().as_posix()
+        reftarget = (Path(tmp_path) / reftarget[1:]).resolve().as_posix()
 
     assert_node(ret[0], [download_reference], reftarget=reftarget)
     assert_node(ret[0][0], [literal, caption])