CLion加载ESP-IDF项目提示idf_tools.py语法错误如何配置解决

问题现象 #

在macOS下用CLion加载任意ESP-IDF项目（包括官方helloworld示例）时，CMake配置阶段报语法错误，终端下相同项目可正常构建，报错日志如下：

-- Checking Python dependencies...
  File "/Users/viktor/esp/esp-idf/tools/idf_tools.py", line 369
    info(f'Downloading {url}')
                            ^
SyntaxError: invalid syntax

本地终端默认Python版本为3.9.12，符合ESP-IDF版本要求。

根因说明 #

f-string是Python 3.6及以上版本才支持的语法，该报错直接说明CLion执行ESP-IDF构建脚本时，调用了macOS系统自带的Python 2.x解释器。
CLion启动时不会加载用户shell（zsh/bash）的PATH配置和ESP-IDF相关环境变量，自动探测Python解释器时会优先命中系统预装的低版本Python，和终端下激活的Python 3环境不匹配。

配置步骤 #

• 先在终端执行which python3，记录Python 3的可执行文件路径，如果是用ESP-IDF官方安装脚本部署的环境，优先使用ESP-IDF自带虚拟环境的Python路径，通常格式为/Users/你的用户名/.espressif/python_env/idf<对应版本号>_py3.9_env/bin/python3
• 打开CLion设置，进入Build, Execution, Deployment > CMake配置页，选中你当前使用的CMake配置Profile
• 点击配置项里的Environment右侧编辑按钮，新增/修改以下环境变量：
  • 新增IDF_PYTHON_ENV_PATH，值填刚才记录的Python 3解释器所属的目录路径
  • 修改PATH变量，在现有值的最前面拼接Python 3所在的目录路径，例如M系列Mac用Homebrew安装的Python3就加/opt/homebrew/bin:，Intel芯片Mac加/usr/local/bin:，保证构建时优先找到高版本Python
• 如果你安装了CLion官方ESP-IDF插件，额外进入Settings > Languages & Frameworks > ESP-IDF配置页，把Python interpreter path手动指定为刚才记录的Python3绝对路径，不要使用自动探测的结果
• 进入Build, Execution, Deployment > Toolchains配置页，把当前使用的工具链的Shell path指定为你日常使用的终端shell路径（比如macOS默认zsh的路径是/bin/zsh），让CLion加载shell里配置的所有ESP-IDF环境变量
• 点击CLion右侧CMake面板的清除缓存按钮，选择Reload CMake Project重新加载项目

验证 #

重新加载后查看CMake输出日志，Checking Python dependencies步骤不再报语法错误，项目索引、构建、烧录功能均可正常运行。

内容的提问来源于stack exchange，提问作者Viktor Gintner