diff --git a/tools/test_build_system/test_build_system_helpers/idf_utils.py b/tools/test_build_system/test_build_system_helpers/idf_utils.py index ff2e7978b4d..2fbe11a0cd0 100644 --- a/tools/test_build_system/test_build_system_helpers/idf_utils.py +++ b/tools/test_build_system/test_build_system_helpers/idf_utils.py @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD +# SPDX-FileCopyrightText: 2022-2026 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Apache-2.0 import logging import os @@ -7,7 +7,6 @@ import subprocess import sys import typing from pathlib import Path -from typing import Union try: EXT_IDF_PATH = os.environ['IDF_PATH'] # type: str @@ -16,7 +15,7 @@ except KeyError: exit(1) -EnvDict = typing.Dict[str, str] +EnvDict = dict[str, str] IdfPyFunc = typing.Callable[..., subprocess.CompletedProcess] @@ -99,11 +98,12 @@ def get_idf_build_env(idf_path: str) -> EnvDict: sys.executable, os.path.join(idf_path, 'tools', 'idf_tools.py'), 'export', - '--format=key-value' + '--format=key-value', ] keys_values = subprocess.check_output(cmd, stderr=subprocess.PIPE).decode() - idf_tool_py_env = {key: os.path.expandvars(value) for key, value in - [line.split('=') for line in keys_values.splitlines()]} + idf_tool_py_env = { + key: os.path.expandvars(value) for key, value in [line.split('=') for line in keys_values.splitlines()] + } env_vars = {} # type: EnvDict env_vars.update(os.environ) env_vars.update(idf_tool_py_env) @@ -113,13 +113,15 @@ def get_idf_build_env(idf_path: str) -> EnvDict: return env_vars -def run_idf_py(*args: str, - env: typing.Optional[EnvDict] = None, - idf_path: typing.Optional[typing.Union[str,Path]] = None, - workdir: typing.Optional[str] = None, - check: bool = True, - python: typing.Optional[str] = None, - input_str: typing.Optional[str] = None) -> subprocess.CompletedProcess: +def run_idf_py( + *args: str, + env: EnvDict | None = None, + idf_path: str | Path | None = None, + workdir: str | None = None, + check: bool = True, + python: str | None = None, + input_str: str | None = None, +) -> subprocess.CompletedProcess: """ Run idf.py command with given arguments, raise an exception on failure :param args: arguments to pass to idf.py @@ -144,27 +146,36 @@ def run_idf_py(*args: str, cmd = [ python, - os.path.join(idf_path, 'tools', 'idf.py') + os.path.join(idf_path, 'tools', 'idf.py'), ] cmd += args # type: ignore - logging.debug('running {} in {}'.format(' '.join(cmd), workdir)) + logging.debug(f'running {" ".join(cmd)} in {workdir}') try: return subprocess.run( - cmd, env=env, cwd=workdir, - check=check, stdout=subprocess.PIPE, stderr=subprocess.PIPE, - text=True, encoding='utf-8', errors='backslashreplace', input=input_str) + cmd, + env=env, + cwd=workdir, + check=check, + capture_output=True, + text=True, + encoding='utf-8', + errors='backslashreplace', + input=input_str, + ) except subprocess.CalledProcessError as e: - logging.error('The following idf.py command has failed: {}'.format(' '.join(cmd))) - logging.error('Working directory: {}'.format(workdir)) - logging.error('Stdout: {}'.format(_clip_log_output(e.stdout))) - logging.error('Stderr: {}'.format(_clip_log_output(e.stderr))) + logging.error(f'The following idf.py command has failed: {" ".join(cmd)}') + logging.error(f'Working directory: {workdir}') + logging.error(f'Stdout: {_clip_log_output(e.stdout)}') + logging.error(f'Stderr: {_clip_log_output(e.stderr)}') raise -def run_cmake(*cmake_args: str, - env: typing.Optional[EnvDict] = None, - check: bool = True, - workdir: typing.Optional[Union[Path,str]] = None) -> subprocess.CompletedProcess: +def run_cmake( + *cmake_args: str, + env: EnvDict | None = None, + check: bool = True, + workdir: Path | str | None = None, +) -> subprocess.CompletedProcess: """ Run cmake command with given arguments, raise an exception on failure :param cmake_args: arguments to pass cmake @@ -178,27 +189,33 @@ def run_cmake(*cmake_args: str, if workdir: build_dir = Path(workdir, 'build') else: - build_dir = (Path(os.getcwd()) / 'build') + build_dir = Path(os.getcwd()) / 'build' build_dir.mkdir(parents=True, exist_ok=True) cmd = ['cmake'] + list(cmake_args) - logging.debug('running {} in {}'.format(' '.join(cmd), build_dir)) + logging.debug(f'running {" ".join(cmd)} in {build_dir}') try: return subprocess.run( - cmd, env=env, cwd=build_dir, - check=check, stdout=subprocess.PIPE, stderr=subprocess.PIPE, - text=True, encoding='utf-8', errors='backslashreplace') + cmd, + env=env, + cwd=build_dir, + check=check, + capture_output=True, + text=True, + encoding='utf-8', + errors='backslashreplace', + ) except subprocess.CalledProcessError as e: - logging.error('The following cmake command has failed: {}'.format(' '.join(cmd))) - logging.error('Working directory: {}'.format(workdir)) - logging.error('Stdout: {}'.format(_clip_log_output(e.stdout))) - logging.error('Stderr: {}'.format(_clip_log_output(e.stderr))) + logging.error(f'The following cmake command has failed: {" ".join(cmd)}') + logging.error(f'Working directory: {workdir}') + logging.error(f'Stdout: {_clip_log_output(e.stdout)}') + logging.error(f'Stderr: {_clip_log_output(e.stderr)}') raise -def run_cmake_and_build(*cmake_args: str, env: typing.Optional[EnvDict] = None) -> None: +def run_cmake_and_build(*cmake_args: str, env: EnvDict | None = None) -> None: """ Run cmake command with given arguments and build afterwards, raise an exception on failure :param cmake_args: arguments to pass cmake