install penv before calling tl-install and use penv for tl-install (#298)

Author: Jason2866

builder/frameworks/arduino.py

@@ -22,10 +22,10 @@
 http://arduino.cc/en/Reference/HomePage
 """
 
+import hashlib
 import os
-import sys
 import shutil
-import hashlib
+import sys
 import threading
 from contextlib import suppress
 from os.path import join, exists, isabs, splitdrive, commonpath, relpath
@@ -886,7 +886,7 @@ def get_frameworks_in_current_env():
 if flag_custom_sdkconfig and not flag_any_custom_sdkconfig:
     call_compile_libs()
 
-# Main logic for Arduino Framework
+# Arduino framework configuration and build logic
 pioframework = env.subst("$PIOFRAMEWORK")
 arduino_lib_compile_flag = env.subst("$ARDUINO_LIB_COMPILE_FLAG")
 

builder/frameworks/component_manager.py

@@ -12,9 +12,9 @@
 import shutil
 import re
 import yaml
-from yaml import SafeLoader
 from pathlib import Path
 from typing import Set, Optional, Dict, Any, List, Tuple, Pattern
+from yaml import SafeLoader
 
 
 class ComponentManagerConfig:
@@ -252,7 +252,7 @@ def _get_or_create_component_yml(self) -> str:
         Returns:
             Absolute path to the component YAML file
         """
-        # Try Arduino framework first
+        # Check Arduino framework directory first
         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):

builder/frameworks/espidf.py

@@ -23,14 +23,14 @@
 import copy
 import importlib.util
 import json
-import subprocess
-import sys
-import shutil
 import os
-from os.path import join
+import platform as sys_platform
 import re
 import requests
-import platform as sys_platform
+import shutil
+import subprocess
+import sys
+from os.path import join
 from pathlib import Path
 from urllib.parse import urlsplit, unquote
 
@@ -1668,6 +1668,7 @@ def get_python_exe():
     if not os.path.isfile(python_exe_path):
         sys.stderr.write("Error: Missing Python executable file `%s`\n" % python_exe_path)
         env.Exit(1)
+
     return python_exe_path
 
 
@@ -1677,8 +1678,8 @@ def get_python_exe():
 
 ensure_python_venv_available()
 
-# ESP-IDF package doesn't contain .git folder, instead package version is specified
-# in a special file "version.h" in the root folder of the package
+# ESP-IDF package version is determined from version.h file
+# since the package distribution doesn't include .git metadata
 
 create_version_file()
 
@@ -1717,7 +1718,7 @@ def get_python_exe():
 
 
 #
-# Current build script limitations
+# Known build system limitations
 #
 
 if any(" " in p for p in (FRAMEWORK_DIR, BUILD_DIR)):
@@ -1756,12 +1757,12 @@ def get_python_exe():
         LIBSOURCE_DIRS=[str(Path(ARDUINO_FRAMEWORK_DIR) / "libraries")]
     )
 
-# Set ESP-IDF version environment variables (needed for proper Kconfig processing)
+# Configure ESP-IDF version environment variables for Kconfig processing
 framework_version = get_framework_version()
 major_version = framework_version.split('.')[0] + '.' + framework_version.split('.')[1]
 os.environ["ESP_IDF_VERSION"] = major_version
 
-# Configure CMake arguments with ESP-IDF version
+# Setup CMake configuration arguments
 extra_cmake_args = [
     "-DIDF_TARGET=" + idf_variant,
     "-DPYTHON_DEPS_CHECKED=1",
@@ -1855,7 +1856,7 @@ def get_python_exe():
     env.Depends("$BUILD_DIR/$PROGNAME$PROGSUFFIX", build_bootloader(sdk_config))
 
 #
-# Target: ESP-IDF menuconfig
+# ESP-IDF menuconfig target implementation
 #
 
 env.AddPlatformTarget(
@@ -2000,8 +2001,8 @@ def _skip_prj_source_files(node):
 ):
     project_env = env.Clone()
     if project_target_name != "__idf_main":
-        # Manually add dependencies to CPPPATH since ESP-IDF build system doesn't generate
-        # this info if the folder with sources is not named 'main'
+        # Add dependencies to CPPPATH for non-main source directories
+        # ESP-IDF build system requires manual dependency handling for custom source folders
         # https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#rename-main
         project_env.AppendUnique(CPPPATH=app_includes["plain_includes"])
 
@@ -2049,7 +2050,7 @@ def _skip_prj_source_files(node):
 #
 
 extra_elf2bin_flags = "--elf-sha256-offset 0xb0"
-# https://github.com/espressif/esp-idf/blob/master/components/esptool_py/project_include.cmake#L58
+# Reference: ESP-IDF esptool_py component configuration
 # For chips that support configurable MMU page size feature
 # If page size is configured to values other than the default "64KB" in menuconfig,
 mmu_page_size = "64KB"

builder/main.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import importlib.util
 import locale
 import os
 import re
@@ -20,7 +21,6 @@
 import sys
 from os.path import isfile, join
 from pathlib import Path
-import importlib.util
 
 from SCons.Script import (
     ARGUMENTS,
@@ -34,9 +34,8 @@
 from platformio.project.helpers import get_project_dir
 from platformio.util import get_serial_ports
 from platformio.compat import IS_WINDOWS
-from penv_setup import setup_python_environment
 
-# Initialize environment and configuration
+# Initialize SCons environment and project configuration
 env = DefaultEnvironment()
 platform = env.PioPlatform()
 projectconfig = env.GetProjectConfig()
@@ -46,10 +45,10 @@
 core_dir = projectconfig.get("platformio", "core_dir")
 build_dir = Path(projectconfig.get("platformio", "build_dir"))
 
-# Setup Python virtual environment and get executable paths
-PYTHON_EXE, esptool_binary_path = setup_python_environment(env, platform, core_dir)
+# Configure Python environment through centralized platform management
+PYTHON_EXE, esptool_binary_path = platform.setup_python_env(env)
 
-# Initialize board configuration and MCU settings
+# Load board configuration and determine MCU architecture
 board = env.BoardConfig()
 board_id = env.subst("$BOARD")
 mcu = board.get("build.mcu", "esp32")
@@ -451,7 +450,7 @@ def switch_off_ldf():
 if not is_xtensa:
     toolchain_arch = "riscv32-esp"
 
-# Initialize integration extra data if not present
+# Ensure integration extra data structure exists
 if "INTEGRATION_EXTRA_DATA" not in env:
     env["INTEGRATION_EXTRA_DATA"] = {}
 
@@ -461,7 +460,7 @@ def switch_off_ldf():
     if ' ' in esptool_binary_path 
     else esptool_binary_path
 )
-# Configure build tools and environment variables
+# Configure SCons build tools and compiler settings
 env.Replace(
     __get_board_boot_mode=_get_board_boot_mode,
     __get_board_f_flash=_get_board_f_flash,
@@ -637,7 +636,7 @@ def firmware_metrics(target, source, env):
         if env.GetProjectOption("custom_esp_idf_size_verbose", False):
             print(f"Running command: {' '.join(cmd)}")
 
-        # Call esp-idf-size with modified environment
+        # Execute esp-idf-size with current environment
         result = subprocess.run(cmd, check=False, capture_output=False, env=os.environ)
 
         if result.returncode != 0: