Ruff PTH118: pathlib everywhere except for tests, which get a noqa for now

Author: evertlammerts

scripts/generate_connection_methods.py

@@ -1,10 +1,11 @@
 import json
 import os
+from pathlib import Path
 
 os.chdir(os.path.dirname(__file__))
 
-JSON_PATH = os.path.join("connection_methods.json")
-PYCONNECTION_SOURCE = os.path.join("..", "src", "pyconnection.cpp")
+JSON_PATH = "connection_methods.json"
+PYCONNECTION_SOURCE = Path("..")  / "src" / "duckdb_py" / "pyconnection.cpp"
 
 INITIALIZE_METHOD = (
     "static void InitializeConnectionMethods(py::class_<DuckDBPyConnection, shared_ptr<DuckDBPyConnection>> &m) {"

scripts/generate_connection_stubs.py

@@ -1,10 +1,11 @@
 import json
 import os
+from pathlib import Path
 
 os.chdir(os.path.dirname(__file__))
 
-JSON_PATH = os.path.join("connection_methods.json")
-DUCKDB_STUBS_FILE = os.path.join("..", "duckdb-stubs", "__init__.pyi")
+JSON_PATH = "connection_methods.json"
+DUCKDB_STUBS_FILE = Path("..") / "duckdb" / "__init__.pyi"
 
 START_MARKER = "    # START OF CONNECTION METHODS"
 END_MARKER = "    # END OF CONNECTION METHODS"

scripts/generate_connection_wrapper_methods.py

@@ -1,13 +1,14 @@
 import json
 import os
+from pathlib import Path
 
 # Requires `python3 -m pip install cxxheaderparser pcpp`
 from get_cpp_methods import ConnectionMethod, get_methods
 
 os.chdir(os.path.dirname(__file__))
 
-JSON_PATH = os.path.join("connection_methods.json")
-DUCKDB_PYTHON_SOURCE = os.path.join("..", "duckdb_python.cpp")
+JSON_PATH = "connection_methods.json"
+DUCKDB_PYTHON_SOURCE = Path("..")  / "src" / "duckdb_py" / "duckdb_python.cpp"
 
 START_MARKER = "\t// START_OF_CONNECTION_METHODS"
 END_MARKER = "\t// END_OF_CONNECTION_METHODS"
@@ -31,9 +32,9 @@
 ])
 """
 
-WRAPPER_JSON_PATH = os.path.join("connection_wrapper_methods.json")
+WRAPPER_JSON_PATH = "connection_wrapper_methods.json"
 
-DUCKDB_INIT_FILE = os.path.join("..", "duckdb", "__init__.py")
+DUCKDB_INIT_FILE = Path("..") / "duckdb" / "__init__.py"
 INIT_PY_START = "# START OF CONNECTION WRAPPER"
 INIT_PY_END = "# END OF CONNECTION WRAPPER"
 

scripts/generate_connection_wrapper_stubs.py

@@ -1,11 +1,12 @@
 import json
 import os
+from pathlib import Path
 
 os.chdir(os.path.dirname(__file__))
 
-JSON_PATH = os.path.join("connection_methods.json")
-WRAPPER_JSON_PATH = os.path.join("connection_wrapper_methods.json")
-DUCKDB_STUBS_FILE = os.path.join("..", "duckdb-stubs", "__init__.pyi")
+JSON_PATH = "connection_methods.json"
+WRAPPER_JSON_PATH = "connection_wrapper_methods.json"
+DUCKDB_STUBS_FILE = Path("..") / "duckdb" / "__init__.pyi"
 
 START_MARKER = "# START OF CONNECTION WRAPPER"
 END_MARKER = "# END OF CONNECTION WRAPPER"

scripts/generate_import_cache_cpp.py

@@ -1,11 +1,12 @@
 import json
 import os
+from pathlib import Path
 
 script_dir = os.path.dirname(__file__)
 
 # Load existing JSON data from a file if it exists
 json_data = {}
-json_cache_path = os.path.join(script_dir, "cache_data.json")
+json_cache_path = Path(script_dir) / "cache_data.json"
 try:
     with open(json_cache_path) as file:
         json_data = json.load(file)
@@ -182,7 +183,7 @@ def to_string(self):
 for file in files:
     content = file.to_string()
     path = f"src/duckdb_py/include/duckdb_python/import_cache/modules/{file.file_name}"
-    import_cache_path = os.path.join(script_dir, '..', path)
+    import_cache_path = Path(script_dir) / ".." / path
     with open(import_cache_path, "w") as f:
         f.write(content)
 
@@ -236,7 +237,7 @@ def get_root_modules(files: list[ModuleFile]):
 
 """
 
-import_cache_path = os.path.join(script_dir, "..", "src/duckdb_py/include/duckdb_python/import_cache/python_import_cache.hpp")
+import_cache_path = Path(script_dir) / ".." / "src/duckdb_py/include/duckdb_python/import_cache/python_import_cache.hpp"
 with open(import_cache_path, "w") as f:
     f.write(import_cache_file)
 
@@ -250,9 +251,8 @@ def get_module_file_path_includes(files: list[ModuleFile]):
 
 module_includes = get_module_file_path_includes(files)
 
-modules_header = os.path.join(
-    script_dir, "..", "src/duckdb_py/include/duckdb_python/import_cache/python_import_cache_modules.hpp"
-)
+modules_header = Path(script_dir) / ".." / ("src/duckdb_py/include/duckdb_python/"
+                                            "import_cache/python_import_cache_modules.hpp")
 with open(modules_header, "w") as f:
     f.write(module_includes)
 

scripts/generate_import_cache_json.py

@@ -1,5 +1,6 @@
 import json
 import os
+from pathlib import Path
 from typing import Union
 
 script_dir = os.path.dirname(__file__)
@@ -155,7 +156,7 @@ def to_json(self):
 
 # Load existing JSON data from a file if it exists
 existing_json_data = {}
-json_cache_path = os.path.join(script_dir, "cache_data.json")
+json_cache_path = Path(script_dir) / "cache_data.json"
 try:
     with open(json_cache_path) as file:
         existing_json_data = json.load(file)

scripts/get_cpp_methods.py

@@ -1,5 +1,6 @@
 # Requires `python3 -m pip install cxxheaderparser pcpp`
 import os
+from pathlib import Path
 from typing import Callable
 
 import cxxheaderparser.parser
@@ -51,16 +52,8 @@ def on_class_method(self, state, node):
 
 def get_methods(class_name: str) -> dict[str, ConnectionMethod]:
     CLASSES = {
-        "DuckDBPyConnection": os.path.join(
-            scripts_folder,
-            "..",
-            "src",
-            "include",
-            "duckdb_python",
-            "pyconnection",
-            "pyconnection.hpp",
-        ),
-        "DuckDBPyRelation": os.path.join(scripts_folder, "..", "src", "include", "duckdb_python", "pyrelation.hpp"),
+        "DuckDBPyConnection": Path(scripts_folder) / ".." / "src" / "duckdb_py" / "include" / "duckdb_python" / "pyconnection" / "pyconnection.hpp",  # noqa: E501
+        "DuckDBPyRelation": Path(scripts_folder) / ".." / "src" / "duckdb_py" / "include" / "duckdb_python" / "pyrelation.hpp",  # noqa: E501
     }
 
     path = CLASSES[class_name]

tests/conftest.py

@@ -4,6 +4,7 @@
 import warnings
 from importlib import import_module
 from os.path import abspath, dirname, join, normpath
+from pathlib import Path
 from typing import Any
 
 import pytest
@@ -192,12 +193,12 @@ def require():
     def _require(extension_name, db_name="") -> duckdb.DuckDBPyConnection | None:
         # Paths to search for extensions
 
-        build = normpath(join(dirname(__file__), "../../../build/"))
+        build = Path(__file__).parent.parent / "build"
         extension = "extension/*/*.duckdb_extension"
 
         extension_search_patterns = [
-            join(build, "release", extension),
-            join(build, "debug", extension),
+            build / "release" / extension,
+            build / "debug" / extension,
         ]
 
         # DUCKDB_PYTHON_TEST_EXTENSION_PATH can be used to add a path for the extension test to search for extensions

tests/extensions/json/test_read_json.py

@@ -8,7 +8,7 @@
 def TestFile(name):
     import os
 
-    filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data", name)
+    filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data", name)  # noqa: PTH118
     return filename
 
 

tests/fast/adbc/test_adbc.py

@@ -99,7 +99,7 @@ def test_connection_get_objects_filters(duck_conn):
 
 
 def test_commit(tmp_path):
-    db = os.path.join(tmp_path, "tmp.db")
+    db = os.path.join(tmp_path, "tmp.db")  # noqa: PTH118
     if os.path.exists(db):
         os.remove(db)
     table = example_table()
@@ -239,7 +239,7 @@ def test_insertion(duck_conn):
 
 def test_read(duck_conn):
     with duck_conn.cursor() as cursor:
-        filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "data", "category.csv")
+        filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "data", "category.csv")  # noqa: PTH118
         cursor.execute(f"SELECT * FROM '{filename}'")
         assert cursor.fetch_arrow_table().to_pydict() == {
             "CATEGORY_ID": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
@@ -301,7 +301,7 @@ def test_large_chunk(tmp_path):
     # Create the table
     table = pyarrow.table([col1, col2, col3], names=["ints", "floats", "strings"])
 
-    db = os.path.join(tmp_path, "tmp.db")
+    db = os.path.join(tmp_path, "tmp.db")  # noqa: PTH118
     if os.path.exists(db):
         os.remove(db)
     db_kwargs = {"path": f"{db}"}
@@ -327,7 +327,7 @@ def test_dictionary_data(tmp_path):
 
     # Wrap in a table
     table = pyarrow.table({"fruits": dict_array})
-    db = os.path.join(tmp_path, "tmp.db")
+    db = os.path.join(tmp_path, "tmp.db")  # noqa: PTH118
     if os.path.exists(db):
         os.remove(db)
     db_kwargs = {"path": f"{db}"}
@@ -355,7 +355,7 @@ def test_ree_data(tmp_path):
 
     table = pyarrow.table({"fruits": ree_array})
 
-    db = os.path.join(tmp_path, "tmp.db")
+    db = os.path.join(tmp_path, "tmp.db")  # noqa: PTH118
     if os.path.exists(db):
         os.remove(db)
     db_kwargs = {"path": f"{db}"}