Refactor: using Path instead of join (#281)

Author: Jason2866

builder/frameworks/_embed_files.py

@@ -14,7 +14,8 @@
 
 import shutil
 from os import SEEK_CUR, SEEK_END
-from os.path import basename, isfile, join
+from os.path import basename, isfile
+from pathlib import Path
 
 from SCons.Script import Builder
 
@@ -24,6 +25,14 @@
 mcu = board.get("build.mcu", "esp32")
 is_xtensa = mcu in ("esp32", "esp32s2", "esp32s3")
 
+cmake_dir = str(env.PioPlatform().get_package_dir("tool-cmake"))
+cmake_cmd = f'"{Path(cmake_dir) / "bin" / "cmake"}"'
+
+idf_dir = str(env.PioPlatform().get_package_dir("framework-espidf"))
+data_embed_script = (
+    f'"{Path(idf_dir) / "tools" / "cmake" / "scripts" / "data_file_embed_asm.cmake"}"'
+)
+
 #
 # Embedded files helpers
 #
@@ -33,7 +42,7 @@ def extract_files(cppdefines, files_type):
     result = []
     files = env.GetProjectOption("board_build.%s" % files_type, "").splitlines()
     if files:
-        result.extend([join("$PROJECT_DIR", f.strip()) for f in files if f])
+        result.extend([str(Path("$PROJECT_DIR") / f.strip()) for f in files if f.strip()])
     else:
         files_define = "COMPONENT_" + files_type.upper()
         for define in cppdefines:
@@ -53,9 +62,10 @@ def extract_files(cppdefines, files_type):
                 return []
 
             for f in value.split(":"):
+                f = f.strip()
                 if not f:
                     continue
-                result.append(join("$PROJECT_DIR", f))
+                result.append(str(Path("$PROJECT_DIR") / f))
 
     for f in result:
         if not isfile(env.subst(f)):
@@ -76,10 +86,14 @@ def prepare_file(source, target, env):
     shutil.copy(filepath, filepath + ".piobkp")
 
     with open(filepath, "rb+") as fp:
-        fp.seek(-1, SEEK_END)
-        if fp.read(1) != "\0":
-            fp.seek(0, SEEK_CUR)
+        fp.seek(0, SEEK_END)
+        size = fp.tell()
+        if size == 0:
             fp.write(b"\0")
+        else:
+            fp.seek(-1, SEEK_END)
+            if fp.read(1) != b"\0":
+                fp.write(b"\0")
 
 
 def revert_original_file(source, target, env):
@@ -91,17 +105,17 @@ def revert_original_file(source, target, env):
 def embed_files(files, files_type):
     for f in files:
         filename = basename(f) + ".txt.o"
-        file_target = env.TxtToBin(join("$BUILD_DIR", filename), f)
+        file_target = env.TxtToBin(str(Path("$BUILD_DIR") / filename), f)
         env.Depends("$PIOMAINPROG", file_target)
         if files_type == "embed_txtfiles":
             env.AddPreAction(file_target, prepare_file)
             env.AddPostAction(file_target, revert_original_file)
-        env.AppendUnique(PIOBUILDFILES=[env.File(join("$BUILD_DIR", filename))])
+        env.AppendUnique(PIOBUILDFILES=[env.File(str(Path("$BUILD_DIR") / filename))])
 
 
 def transform_to_asm(target, source, env):
-    files = [join("$BUILD_DIR", s.name + ".S") for s in source]
-    return files, source
+    asm_targets = [str(Path("$BUILD_DIR") / (s.name + ".S")) for s in source]
+    return asm_targets, source
 
 
 env.Append(
@@ -133,22 +147,12 @@ def transform_to_asm(target, source, env):
             action=env.VerboseAction(
                 " ".join(
                     [
-                        join(
-                            env.PioPlatform().get_package_dir("tool-cmake") or "",
-                            "bin",
-                            "cmake",
-                        ),
+                        cmake_cmd,
                         "-DDATA_FILE=$SOURCE",
                         "-DSOURCE_FILE=$TARGET",
                         "-DFILE_TYPE=$FILE_TYPE",
                         "-P",
-                        join(
-                            env.PioPlatform().get_package_dir("framework-espidf") or "",
-                            "tools",
-                            "cmake",
-                            "scripts",
-                            "data_file_embed_asm.cmake",
-                        ),
+                        data_embed_script,
                     ]
                 ),
                 "Generating assembly for $TARGET",
@@ -171,7 +175,7 @@ def transform_to_asm(target, source, env):
     files = extract_files(flags, files_type)
     if "espidf" in env.subst("$PIOFRAMEWORK"):
         env.Requires(
-            join("$BUILD_DIR", "${PROGNAME}.elf"),
+            str(Path("$BUILD_DIR") / "${PROGNAME}.elf"),
             env.FileToAsm(
                 files,
                 FILE_TYPE="TEXT" if files_type == "embed_txtfiles" else "BINARY",

builder/frameworks/arduino.py

@@ -35,8 +35,7 @@
 from SCons.Script import DefaultEnvironment, SConscript
 from platformio import fs
 from platformio.package.manager.tool import ToolPackageManager
-
-IS_WINDOWS = sys.platform.startswith("win")
+from platformio.compat import IS_WINDOWS
 
 # Constants for better performance
 UNICORE_FLAGS = {
@@ -73,7 +72,7 @@ def get_platform_default_threshold(mcu):
         "esp32": 32000,      # Standard ESP32
         "esp32s2": 32000,    # ESP32-S2
         "esp32s3": 32766,    # ESP32-S3
-        "esp32c3": 30000,    # ESP32-C3
+        "esp32c3": 32000,    # ESP32-C3
         "esp32c2": 32000,    # ESP32-C2
         "esp32c6": 31600,    # ESP32-C6
         "esp32h2": 32000,    # ESP32-H2
@@ -311,7 +310,7 @@ def framework_lib_dir(self):
     def sdk_dir(self):
         if self._sdk_dir is None:
             self._sdk_dir = fs.to_unix_path(
-                join(self.framework_lib_dir, self.mcu, "include")
+                str(Path(self.framework_lib_dir) / self.mcu / "include")
             )
         return self._sdk_dir
 
@@ -507,7 +506,7 @@ def safe_remove_sdkconfig_files():
     envs = [section.replace("env:", "") for section in config.sections()
             if section.startswith("env:")]
     for env_name in envs:
-        file_path = join(project_dir, f"sdkconfig.{env_name}")
+        file_path = str(Path(project_dir) / f"sdkconfig.{env_name}")
         if exists(file_path):
             safe_delete_file(file_path)
 
@@ -566,9 +565,7 @@ def safe_remove_sdkconfig_files():
 
 SConscript("_embed_files.py", exports="env")
 
-flag_any_custom_sdkconfig = exists(join(
-    platform.get_package_dir("framework-arduinoespressif32-libs"),
-    "sdkconfig"))
+flag_any_custom_sdkconfig = exists(str(Path(FRAMEWORK_LIB_DIR) / "sdkconfig"))
 
 
 def has_unicore_flags():
@@ -599,7 +596,7 @@ def matching_custom_sdkconfig():
     if not flag_any_custom_sdkconfig:
         return True, cust_sdk_is_present
 
-    last_sdkconfig_path = join(project_dir, "sdkconfig.defaults")
+    last_sdkconfig_path = str(Path(project_dir) / "sdkconfig.defaults")
     if not exists(last_sdkconfig_path):
         return False, cust_sdk_is_present
 
@@ -901,12 +898,12 @@ def get_frameworks_in_current_env():
     component_manager = ComponentManager(env)
     component_manager.handle_component_settings()
     silent_action = env.Action(component_manager.restore_pioarduino_build_py)
-    # hack to silence scons command output
+    # silence scons command output
     silent_action.strfunction = lambda target, source, env: ''
     env.AddPostAction("checkprogsize", silent_action)
 
     if IS_WINDOWS:
         env.AddBuildMiddleware(smart_include_length_shorten)
 
-    build_script_path = join(FRAMEWORK_DIR, "tools", "pioarduino-build.py")
+    build_script_path = str(Path(FRAMEWORK_DIR) / "tools" / "pioarduino-build.py")
     SConscript(build_script_path)

builder/frameworks/component_manager.py

@@ -13,7 +13,7 @@
 import re
 import yaml
 from yaml import SafeLoader
-from os.path import join
+from pathlib import Path
 from typing import Set, Optional, Dict, Any, List, Tuple
 
 
@@ -49,8 +49,12 @@ def __init__(self, env):
         self.project_src_dir = env.subst("$PROJECT_SRC_DIR")
         # Get Arduino framework installation directory
         self.arduino_framework_dir = self.platform.get_package_dir("framework-arduinoespressif32")
+        # Get Arduino libraries installation directory
+        ald = self.platform.get_package_dir("framework-arduinoespressif32-libs")
         # Get MCU-specific Arduino libraries directory
-        self.arduino_libs_mcu = join(self.platform.get_package_dir("framework-arduinoespressif32-libs"), self.mcu)
+        self.arduino_libs_mcu = (
+            str(Path(ald) / self.mcu) if ald else ""
+        )
 
 
 class ComponentLogger:
@@ -228,13 +232,14 @@ def _get_or_create_component_yml(self) -> str:
             Absolute path to the component YAML file
         """
         # Try Arduino framework first
-        framework_yml = join(self.config.arduino_framework_dir, "idf_component.yml")
-        if os.path.exists(framework_yml):
+        afd = self.config.arduino_framework_dir
+        framework_yml = str(Path(afd) / "idf_component.yml") if afd else ""
+        if framework_yml and os.path.exists(framework_yml):
             self._create_backup(framework_yml)
             return framework_yml
 
         # Try project source directory
-        project_yml = join(self.config.project_src_dir, "idf_component.yml")
+        project_yml = str(Path(self.config.project_src_dir) / "idf_component.yml")
         if os.path.exists(project_yml):
             self._create_backup(project_yml)
             return project_yml
@@ -416,9 +421,12 @@ def _backup_pioarduino_build_py(self) -> None:
         """
         if "arduino" not in self.config.env.subst("$PIOFRAMEWORK"):
             return
-        
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
-        backup_path = join(self.config.arduino_libs_mcu, f"pioarduino-build.py.{self.config.mcu}")
+
+        if not self.config.arduino_libs_mcu:
+            return
+
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
+        backup_path = str(Path(self.config.arduino_libs_mcu) / f"pioarduino-build.py.{self.config.mcu}")
 
         if os.path.exists(build_py_path) and not os.path.exists(backup_path):
             shutil.copy2(build_py_path, backup_path)
@@ -446,7 +454,7 @@ def _remove_include_directory(self, component: str) -> None:
         Args:
             component: Component name in filesystem format
         """
-        include_path = join(self.config.arduino_libs_mcu, "include", component)
+        include_path = str(Path(self.config.arduino_libs_mcu) / "include" / component)
 
         if os.path.exists(include_path):
             shutil.rmtree(include_path)
@@ -459,7 +467,7 @@ def _remove_cpppath_entries(self) -> None:
         for all components that were removed from the project. Uses
         multiple regex patterns to catch different include path formats.
         """
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
 
         if not os.path.exists(build_py_path):
             return
@@ -667,14 +675,17 @@ def _get_arduino_core_libraries(self) -> Dict[str, str]:
         libraries_mapping = {}
 
         # Path to Arduino Core Libraries
-        arduino_libs_dir = join(self.config.arduino_framework_dir, "libraries")
+        afd = self.config.arduino_framework_dir
+        if not afd:
+            return libraries_mapping
+        arduino_libs_dir = str(Path(afd).resolve() / "libraries")
 
         if not os.path.exists(arduino_libs_dir):
             return libraries_mapping
 
         try:
             for entry in os.listdir(arduino_libs_dir):
-                lib_path = join(arduino_libs_dir, entry)
+                lib_path = str(Path(arduino_libs_dir) / entry)
                 if os.path.isdir(lib_path):
                     lib_name = self._get_library_name_from_properties(lib_path)
                     if lib_name:
@@ -699,7 +710,7 @@ def _get_library_name_from_properties(self, lib_dir: str) -> Optional[str]:
         Returns:
             Official library name or None if not found or readable
         """
-        prop_path = join(lib_dir, "library.properties")
+        prop_path = str(Path(lib_dir) / "library.properties")
         if not os.path.isfile(prop_path):
             return None
 
@@ -891,7 +902,7 @@ def _remove_ignored_lib_includes(self) -> None:
         components when dependencies are detected. Uses multiple regex
         patterns to catch different include path formats.
         """
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
 
         if not os.path.exists(build_py_path):
             self.logger.log_change("Build file not found")
@@ -930,7 +941,10 @@ def _remove_ignored_lib_includes(self) -> None:
                     rf'.*"[^"]*{re.escape(lib_name)}[^"]*include[^"]*"[^,\n]*,?\n',
                     rf'.*join\([^)]*"include"[^)]*"{re.escape(lib_name)}"[^)]*\),?\n',
                     rf'.*"{re.escape(lib_name)}/include"[^,\n]*,?\n',
-                    rf'\s*"[^"]*/{re.escape(lib_name)}/[^"]*",?\n'
+                    rf'\s*"[^"]*[\\/]{re.escape(lib_name)}[\\/][^"]*",?\n',
+                    # pathlib-style: Path(...)/"include"/"<name>"
+                    rf'.*Path\([^)]*\)\s*/\s*"include"\s*/\s*"{re.escape(lib_name)}"[^,\n]*,?\n',
+                    rf'.*Path\([^)]*{re.escape(lib_name)}[^)]*\)\s*/\s*"include"[^,\n]*,?\n'
                 ]
 
                 removed_count = 0
@@ -992,8 +1006,10 @@ def _backup_pioarduino_build_py(self) -> None:
         if "arduino" not in self.config.env.subst("$PIOFRAMEWORK"):
             return
 
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
-        backup_path = join(self.config.arduino_libs_mcu, f"pioarduino-build.py.{self.config.mcu}")
+        if not self.config.arduino_libs_mcu:
+            return
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
+        backup_path = str(Path(self.config.arduino_libs_mcu) / f"pioarduino-build.py.{self.config.mcu}")
 
         if os.path.exists(build_py_path) and not os.path.exists(backup_path):
             shutil.copy2(build_py_path, backup_path)
@@ -1007,7 +1023,7 @@ class BackupManager:
     framework build scripts, ensuring that original files can be restored
     when needed or when builds are cleaned.
     """
-    
+
     def __init__(self, config: ComponentManagerConfig):
         """
         Initialize the backup manager with configuration access.
@@ -1019,7 +1035,7 @@ def __init__(self, config: ComponentManagerConfig):
             config: Configuration manager instance providing access to paths
         """
         self.config = config
-    
+
     def backup_pioarduino_build_py(self) -> None:
         """
         Create backup of the original pioarduino-build.py file.
@@ -1030,13 +1046,13 @@ def backup_pioarduino_build_py(self) -> None:
         """
         if "arduino" not in self.config.env.subst("$PIOFRAMEWORK"):
             return
-        
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
-        backup_path = join(self.config.arduino_libs_mcu, f"pioarduino-build.py.{self.config.mcu}")
-        
+
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
+        backup_path = str(Path(self.config.arduino_libs_mcu) / f"pioarduino-build.py.{self.config.mcu}")
+
         if os.path.exists(build_py_path) and not os.path.exists(backup_path):
             shutil.copy2(build_py_path, backup_path)
-    
+
     def restore_pioarduino_build_py(self, target=None, source=None, env=None) -> None:
         """
         Restore the original pioarduino-build.py from backup.
@@ -1050,9 +1066,9 @@ def restore_pioarduino_build_py(self, target=None, source=None, env=None) -> Non
             source: Build source (unused, for PlatformIO compatibility)
             env: Environment (unused, for PlatformIO compatibility)
         """
-        build_py_path = join(self.config.arduino_libs_mcu, "pioarduino-build.py")
-        backup_path = join(self.config.arduino_libs_mcu, f"pioarduino-build.py.{self.config.mcu}")
-        
+        build_py_path = str(Path(self.config.arduino_libs_mcu) / "pioarduino-build.py")
+        backup_path = str(Path(self.config.arduino_libs_mcu) / f"pioarduino-build.py.{self.config.mcu}")
+
         if os.path.exists(backup_path):
             shutil.copy2(backup_path, build_py_path)
             os.remove(backup_path)