espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-29 18:27:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(tools): Safer clearing IDF_PYTHON_ENV_PATH if existing

Browse Source
This commit is contained in:
Marek Fiala
2025-02-19 19:52:53 +01:00
committed by BOT
parent 77346e0bc7
commit a09fdf2f3e
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tools/idf_tools.py
View File

@ -1,7 +1,7 @@
#!/usr/bin/env python
# coding=utf-8
#
# SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
#
# SPDX-License-Identifier: Apache-2.0
#
@ -2617,7 +2617,7 @@ def action_install_python_env(args): # type: ignore
else:
if subprocess.run([sys.executable, '-m', 'venv', '-h'], check=False, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL).returncode == 0:
# venv available
virtualenv_options = ['--clear'] # delete environment if already exists
virtualenv_options = []
info(f'Creating a new Python environment in {idf_python_env_path}')
@ -2633,6 +2633,18 @@ def action_install_python_env(args): # type: ignore
'recommended to re-run this script from a clean shell where an ESP-IDF environment is '
'not active.')
# Verify if IDF_PYTHON_ENV_PATH is a valid ESP-IDF Python virtual environment directory
# to decide if content should be removed
if (
os.path.exists(os.path.join(environ_idf_python_env_path, VENV_VER_FILE))
or re.search(PYTHON_VENV_DIR_TEMPLATE.format(r'\d+\.\d+', r'\d+\.\d+'), environ_idf_python_env_path)
):
virtualenv_options.append('--clear') # delete environment if already exists
elif os.listdir(environ_idf_python_env_path): # show the message only if the directory is not empty
info(f'IDF_PYTHON_ENV_PATH is set to {environ_idf_python_env_path}, '
'but it does not appear to be an ESP-IDF Python virtual environment directory. '
'Existing data in this folder will be preserved to prevent unintentional data loss.')
except KeyError:
# if IDF_PYTHON_ENV_PATH not defined then the above checks can be skipped
pass