Migrate more os.path to pathlib (#2980)

* Migrate more `os.path` to `pathlib`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix type errors with recent pathlib code

* pathlib fixes

* more pathlib fixes

* remove unused imports introduced by pathlib migration

* convert `open()` calls to pathlib

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Migrate tex_file_writing to pathlib

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* converted more old code to pathlib, and fixed a bug in module_ops

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix test failures

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix test failures

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

Author: 3 people

manim/_config/utils.py

@@ -74,7 +74,9 @@ def config_file_paths() -> list[Path]:
     return [library_wide, user_wide, folder_wide]
 
 
-def make_config_parser(custom_file: str = None) -> configparser.ConfigParser:
+def make_config_parser(
+    custom_file: str | os.PathLike | None = None,
+) -> configparser.ConfigParser:
     """Make a :class:`ConfigParser` object and load any ``.cfg`` files.
 
     The user-wide file, if it exists, overrides the library-wide file.  The
@@ -85,7 +87,7 @@ def make_config_parser(custom_file: str = None) -> configparser.ConfigParser:
 
     Parameters
     ----------
-    custom_file : :class:`str`
+    custom_file
         Path to a custom config file.  If used, the folder-wide file in the
         relevant directory will be ignored, if it exists.  If None, the
         folder-wide file will be used, if it exists.
@@ -108,10 +110,10 @@ def make_config_parser(custom_file: str = None) -> configparser.ConfigParser:
     # read_file() before calling read() for any optional files."
     # https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.read
     parser = configparser.ConfigParser()
-    with open(library_wide) as file:
+    with library_wide.open() as file:
         parser.read_file(file)  # necessary file
 
-    other_files = [user_wide, custom_file if custom_file else folder_wide]
+    other_files = [user_wide, Path(custom_file) if custom_file else folder_wide]
     parser.read(other_files)  # optional files
 
     return parser
@@ -809,7 +811,7 @@ def digest_args(self, args: argparse.Namespace) -> ManimConfig:
 
         return self
 
-    def digest_file(self, filename: str) -> ManimConfig:
+    def digest_file(self, filename: str | os.PathLike) -> ManimConfig:
         """Process the config options present in a ``.cfg`` file.
 
         This method processes a single ``.cfg`` file, whereas
@@ -818,7 +820,7 @@ def digest_file(self, filename: str) -> ManimConfig:
 
         Parameters
         ----------
-        filename : :class:`str`
+        filename
             Path to the ``.cfg`` file.
 
         Returns
@@ -840,11 +842,11 @@ def digest_file(self, filename: str) -> ManimConfig:
         multiple times.
 
         """
-        if not os.path.isfile(filename):
+        if not Path(filename).is_file():
             raise FileNotFoundError(
                 errno.ENOENT,
                 "Error: --config_file could not find a valid config file.",
-                filename,
+                str(filename),
             )
 
         return self.digest_parser(make_config_parser(filename))

manim/cli/cfg/group.py

@@ -233,7 +233,7 @@ def write(level: str = None, openfile: bool = False) -> None:
         cfg_file_path = config_paths[2]
         guarantee_existence(config_paths[2].parents[0])
         console.print(CWD_CONFIG_MSG)
-    with open(cfg_file_path, "w") as fp:
+    with cfg_file_path.open("w") as fp:
         parser.write(fp)
     if openfile:
         open_file(cfg_file_path)

manim/cli/init/commands.py

@@ -74,7 +74,7 @@ def update_cfg(cfg_dict, project_cfg_path):
         else:
             cli_config[key] = str(value)
 
-    with open(project_cfg_path, "w") as conf:
+    with project_cfg_path.open("w") as conf:
         config.write(conf)
 
 
@@ -154,32 +154,28 @@ def scene(**args):
         type=click.Choice(get_template_names(), False),
         default="Default",
     )
-    scene = ""
-    with open(Path.resolve(get_template_path() / f"{template_name}.mtp")) as f:
-        scene = f.read()
-        scene = scene.replace(template_name + "Template", args["scene_name"], 1)
+    scene = (get_template_path() / f"{template_name}.mtp").resolve().read_text()
+    scene = scene.replace(template_name + "Template", args["scene_name"], 1)
 
     if args["file_name"]:
-        if args["file_name"][-3:] == ".py":
-            file_name = args["file_name"]
-        else:
-            file_name = args["file_name"] + ".py"
+        file_name = Path(args["file_name"])
+
+        if file_name.suffix != ".py":
+            file_name = file_name.with_suffix(file_name.suffix + ".py")
 
-        file_name = Path(file_name)
         if file_name.is_file():
             # file exists so we are going to append new scene to that file
-            with open(file_name, "a") as f:
+            with file_name.open("a") as f:
                 f.write("\n\n\n" + scene)
         else:
             # file does not exist so we create a new file, append the scene and prepend the import statement
-            with open(file_name, "w") as f:
-                f.write("\n\n\n" + scene)
+            file_name.write_text("\n\n\n" + scene)
 
             add_import_statement(file_name)
     else:
         # file name is not provided so we assume it is main.py
         # if main.py does not exist we do not continue
-        with open(Path("main.py"), "a") as f:
+        with Path("main.py").open("a") as f:
             f.write("\n\n\n" + scene)
 
 

manim/cli/new/group.py

@@ -67,7 +67,7 @@ def update_cfg(cfg_dict, project_cfg_path):
         else:
             cli_config[key] = str(value)
 
-    with open(project_cfg_path, "w") as conf:
+    with project_cfg_path.open("w") as conf:
         config.write(conf)
 
 
@@ -150,28 +150,25 @@ def scene(**args):
         type=click.Choice(get_template_names(), False),
         default="Default",
     )
-    scene = ""
-    with open(Path.resolve(get_template_path() / f"{template_name}.mtp")) as f:
-        scene = f.read()
-        scene = scene.replace(template_name + "Template", args["scene_name"], 1)
+    scene = (get_template_path() / f"{template_name}.mtp").resolve().read_text()
+    scene = scene.replace(template_name + "Template", args["scene_name"], 1)
 
     if args["file_name"]:
         file_name = Path(args["file_name"] + ".py")
 
         if file_name.is_file():
             # file exists so we are going to append new scene to that file
-            with open(file_name, "a") as f:
+            with file_name.open("a") as f:
                 f.write("\n\n\n" + scene)
         else:
             # file does not exist so we create a new file, append the scene and prepend the import statement
-            with open(file_name, "w") as f:
-                f.write("\n\n\n" + scene)
+            file_name.write_text("\n\n\n" + scene)
 
             add_import_statement(file_name)
     else:
         # file name is not provided so we assume it is main.py
         # if main.py does not exist we do not continue
-        with open(Path("main.py"), "a") as f:
+        with Path("main.py").open("a") as f:
             f.write("\n\n\n" + scene)
 
 

manim/mobject/svg/svg_mobject.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 from xml.etree import ElementTree as ET
 
 import numpy as np
@@ -86,7 +87,7 @@ class SVGMobject(VMobject, metaclass=ConvertToOpenGL):
 
     def __init__(
         self,
-        file_name: str | None = None,
+        file_name: str | os.PathLike | None = None,
         should_center: bool = True,
         height: float | None = 2,
         width: float | None = None,
@@ -104,7 +105,7 @@ def __init__(
         super().__init__(color=None, stroke_color=None, fill_color=None, **kwargs)
 
         # process keyword arguments
-        self.file_name = file_name
+        self.file_name = Path(file_name) if file_name is not None else None
 
         self.should_center = should_center
         self.svg_height = height
@@ -182,18 +183,17 @@ def generate_mobject(self) -> None:
         element_tree = ET.parse(file_path)
         new_tree = self.modify_xml_tree(element_tree)
         # Create a temporary svg file to dump modified svg to be parsed
-        root, ext = os.path.splitext(file_path)
-        modified_file_path = root + "_" + ext
+        modified_file_path = file_path.with_name(f"{file_path.stem}_{file_path.suffix}")
         new_tree.write(modified_file_path)
 
         svg = se.SVG.parse(modified_file_path)
-        os.remove(modified_file_path)
+        modified_file_path.unlink()
 
         mobjects = self.get_mobjects_from(svg)
         self.add(*mobjects)
         self.flip(RIGHT)  # Flip y
 
-    def get_file_path(self) -> str:
+    def get_file_path(self) -> Path:
         """Search for an existing file based on the specified file name."""
         if self.file_name is None:
             raise ValueError("Must specify file for SVGMobject")

manim/mobject/text/code_mobject.py

@@ -7,8 +7,8 @@
 ]
 
 import html
-import os
 import re
+from pathlib import Path
 
 import numpy as np
 from pygments import highlight
@@ -88,7 +88,7 @@ def construct(self):
 
     Parameters
     ----------
-    file_name : :class:`str`
+    file_name
         Name of the code file to display.
     code : :class:`str`
         If ``file_name`` is not specified, a code string can be
@@ -153,7 +153,7 @@ def construct(self):
 
     def __init__(
         self,
-        file_name=None,
+        file_name: str | os.PathLike = None,
         code=None,
         tab_width=3,
         line_spacing=0.3,
@@ -199,8 +199,7 @@ def __init__(
         self.file_name = file_name
         if self.file_name:
             self._ensure_valid_file()
-            with open(self.file_path, encoding="utf-8") as f:
-                self.code_string = f.read()
+            self.code_string = self.file_path.read_text(encoding="utf-8")
         elif code:
             self.code_string = code
         else:
@@ -284,16 +283,16 @@ def _ensure_valid_file(self):
         if self.file_name is None:
             raise Exception("Must specify file for Code")
         possible_paths = [
-            os.path.join(os.path.join("assets", "codes"), self.file_name),
-            os.path.expanduser(self.file_name),
+            Path() / "assets" / "codes" / self.file_name,
+            Path(self.file_name).expanduser(),
         ]
         for path in possible_paths:
-            if os.path.exists(path):
+            if path.exists():
                 self.file_path = path
                 return
         error = (
-            f"From: {os.getcwd()}, could not find {self.file_name} at either "
-            + f"of these locations: {possible_paths}"
+            f"From: {Path.cwd()}, could not find {self.file_name} at either "
+            + f"of these locations: {list(map(str, possible_paths))}"
         )
         raise OSError(error)
 
@@ -369,20 +368,9 @@ def _gen_html_string(self):
         )
 
         if self.generate_html_file:
-            os.makedirs(
-                os.path.join("assets", "codes", "generated_html_files"),
-                exist_ok=True,
-            )
-            with open(
-                os.path.join(
-                    "assets",
-                    "codes",
-                    "generated_html_files",
-                    self.file_name + ".html",
-                ),
-                "w",
-            ) as file:
-                file.write(self.html_string)
+            output_folder = Path() / "assets" / "codes" / "generated_html_files"
+            output_folder.mkdir(parents=True, exist_ok=True)
+            (output_folder / f"{self.file_name}.html").write_text(self.html_string)
 
     def _gen_code_json(self):
         """Function to background_color, generate code_json and tab_spaces from html_string.
@@ -559,7 +547,7 @@ def _hilite_me(
         Defines whether line numbers should be inserted in the html file.
     divstyles : :class:`str`
         Some html css styles.
-    file_path : :class:`str`
+    file_path : :class:`pathlib.Path`
         Path of code file.
     line_no_from : :class:`int`
         Defines the first line's number in the line count.

manim/renderer/shader.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import os
 import re
 import textwrap
 from pathlib import Path
@@ -24,24 +23,23 @@
 ]
 
 
-def get_shader_code_from_file(file_path):
+def get_shader_code_from_file(file_path: Path) -> str:
     if file_path in file_path_to_code_map:
         return file_path_to_code_map[file_path]
-    with open(file_path) as f:
-        source = f.read()
-        include_lines = re.finditer(
-            r"^#include (?P<include_path>.*\.glsl)$",
-            source,
-            flags=re.MULTILINE,
+    source = file_path.read_text()
+    include_lines = re.finditer(
+        r"^#include (?P<include_path>.*\.glsl)$",
+        source,
+        flags=re.MULTILINE,
+    )
+    for match in include_lines:
+        include_path = match.group("include_path")
+        included_code = get_shader_code_from_file(
+            file_path.parent / include_path,
         )
-        for match in include_lines:
-            include_path = match.group("include_path")
-            included_code = get_shader_code_from_file(
-                os.path.join(file_path.parent / include_path),
-            )
-            source = source.replace(match.group(0), included_code)
-        file_path_to_code_map[file_path] = source
-        return source
+        source = source.replace(match.group(0), included_code)
+    file_path_to_code_map[file_path] = source
+    return source
 
 
 def filter_attributes(unfiltered_attributes, attributes):