use pathlib

Author: nschloe

test/helpers.py

@@ -1,4 +1,5 @@
 import os
+import pathlib
 import subprocess
 import tempfile
 
@@ -41,8 +42,8 @@ def assert_equality(
     )
     plt.close()
 
-    this_dir = os.path.dirname(os.path.abspath(__file__))
-    with open(os.path.join(this_dir, filename), encoding="utf-8") as f:
+    this_dir = pathlib.Path(__file__).resolve().parent
+    with open(this_dir / filename, encoding="utf-8") as f:
         reference = f.read()
     assert reference == code, filename + "\n" + _unidiff_output(reference, code)
 

test/refresh_reference_files.py

@@ -1,6 +1,6 @@
 import argparse
 import importlib.util
-import os
+import pathlib
 
 import matplotlib.pyplot as plt
 
@@ -11,16 +11,14 @@ def _main():
     parser = argparse.ArgumentParser(description="Refresh all reference TeX files.")
     parser.parse_args()
 
-    this_dir = os.path.dirname(os.path.abspath(__file__))
+    this_dir = pathlib.Path(__file__).resolve().parent
 
     test_files = [
         f
-        for f in os.listdir(this_dir)
-        if os.path.isfile(os.path.join(this_dir, f))
-        and f[:5] == "test_"
-        and f[-3:] == ".py"
+        for f in this_dir.iterdir()
+        if (this_dir / f).is_file() and f.name[:5] == "test_" and f.name[-3:] == ".py"
     ]
-    test_modules = [f[:-3] for f in test_files]
+    test_modules = [f.name[:-3] for f in test_files]
 
     # remove some edge cases
     test_modules.remove("test_rotated_labels")
@@ -36,7 +34,7 @@ def _main():
         plt.close()
 
         tex_filename = mod + "_reference.tex"
-        with open(os.path.join(this_dir, tex_filename), "w", encoding="utf8") as f:
+        with open(this_dir / tex_filename, "w", encoding="utf8") as f:
             f.write(code)
 
 

test/test_image_plot_lower.py

@@ -1,3 +1,5 @@
+import pathlib
+
 import matplotlib.pyplot as plt
 from helpers import assert_equality
 
@@ -6,13 +8,11 @@
 
 
 def plot():
-    import os
-
     import matplotlib.image as mpimg
     from matplotlib import rcParams
 
-    this_dir = os.path.dirname(os.path.realpath(__file__))
-    img = mpimg.imread(os.path.join(this_dir, "lena.png"))
+    this_dir = pathlib.Path(__file__).resolve().parent
+    img = mpimg.imread(this_dir / "lena.png")
 
     dpi = rcParams["figure.dpi"]
     figsize = img.shape[0] / dpi, img.shape[1] / dpi

test/test_image_plot_upper.py

@@ -1,17 +1,17 @@
+import pathlib
+
 import matplotlib.pyplot as plt
 
 # the picture 'lena.png' with origin='lower' is flipped upside-down.
 # So it has to be upside-down in the pdf-file as well.
 
 
 def plot():
-    import os
-
     import matplotlib.image as mpimg
     from matplotlib import rcParams
 
-    this_dir = os.path.dirname(os.path.realpath(__file__))
-    img = mpimg.imread(os.path.join(this_dir, "lena.png"))
+    this_dir = pathlib.Path(__file__).resolve().parent
+    img = mpimg.imread(this_dir / "lena.png")
 
     dpi = rcParams["figure.dpi"]
     figsize = img.shape[0] / dpi, img.shape[1] / dpi

tikzplotlib/_files.py

@@ -1,14 +1,13 @@
-import os
-import posixpath
+import pathlib
 
 
-def _gen_filename(data, nb_key, ext):
+def _gen_filepath(data, nb_key, ext):
     name = data["base name"] + f"-{data[nb_key]:03d}{ext}"
-    return os.path.join(data["output dir"], name), name
+    return pathlib.Path(data["output dir"]) / name
 
 
-def new_filename(data, file_kind, ext):
-    """Returns an available filename.
+def new_filepath(data, file_kind, ext):
+    """Returns an available filepath.
 
     :param file_kind: Name under which numbering is recorded, such as 'img' or
                       'table'.
@@ -17,7 +16,7 @@ def new_filename(data, file_kind, ext):
     :param ext: Filename extension.
     :type ext: str
 
-    :returns: (filename, rel_filepath) where filename is a path in the
+    :returns: (filepath, rel_filepath) where filepath is a path in the
               filesystem and rel_filepath is the path to be used in the tex
               code.
     """
@@ -26,20 +25,19 @@ def new_filename(data, file_kind, ext):
     if nb_key not in data.keys():
         data[nb_key] = -1
 
+    data[nb_key] = data[nb_key] + 1
+    filepath = _gen_filepath(data, nb_key, ext)
     if not data["override externals"]:
         # Make sure not to overwrite anything.
-        file_exists = True
+        file_exists = filepath.is_file()
         while file_exists:
             data[nb_key] = data[nb_key] + 1
-            filename, name = _gen_filename(data, nb_key, ext)
-            file_exists = os.path.isfile(filename)
-    else:
-        data[nb_key] = data[nb_key] + 1
-        filename, name = _gen_filename(data, nb_key, ext)
+            filepath = _gen_filepath(data, nb_key, ext)
+            file_exists = filepath.is_file()
 
     if data["rel data path"]:
-        rel_filepath = posixpath.join(data["rel data path"], name)
+        rel_filepath = pathlib.Path(data["rel data path"]) / filepath
     else:
-        rel_filepath = name
+        rel_filepath = filepath.name
 
-    return filename, rel_filepath
+    return filepath, rel_filepath

tikzplotlib/_save.py

@@ -1,6 +1,6 @@
 import codecs
 import enum
-import os
+import pathlib
 import tempfile
 import warnings
 
@@ -154,14 +154,13 @@ def get_tikz_code(
     data["override externals"] = override_externals
 
     if filepath:
-        data["output dir"] = os.path.dirname(filepath)
+        filepath = pathlib.Path(filepath)
+        data["output dir"] = filepath.parent
     else:
         directory = tempfile.mkdtemp()
-        data["output dir"] = directory
+        data["output dir"] = pathlib.Path(directory)
 
-    data["base name"] = (
-        os.path.splitext(os.path.basename(filepath))[0] if filepath else "tmp"
-    )
+    data["base name"] = filepath.stem if filepath else "tmp"
     data["strict"] = strict
     data["tikz libs"] = set()
     data["pgfplots libs"] = set()
@@ -254,7 +253,6 @@ def save(filepath, *args, encoding=None, **kwargs):
     file_handle = codecs.open(filepath, "w", encoding)
     file_handle.write(code)
     file_handle.close()
-    return
 
 
 def _tex_comment(comment):
@@ -282,7 +280,6 @@ def _print_pgfplot_libs_message(data):
     print("Please add the following lines to your LaTeX preamble:\n")
     print(data["flavor"].preamble(data))
     print(70 * "=")
-    return
 
 
 class _ContentManager: