如何在PyCharm中添加Python额外路径解析Bazel生成代码的导入

场景说明 #

团队要求从VSCode切换到PyCharm开发Python项目，项目中GRPC生成的代码未提交到源码仓库，需通过bazel build //...命令生成，输出目录为项目根目录下的.bazel-bin/。由于生成代码不在默认源码根目录，PyCharm无法识别如下导入语句：

# PyCharm无法识别这些模块
from api.protos.authentication import AuthenticationRequest 
from api.protos import awesome_pb2 as api_awersome_pb2
from api.protos import awesome_service_pb2

需求 #

1. 不移动.bazel-bin目录下的生成代码；
2. 让PyCharm解释器识别.bazel-bin/下的指定源码路径（对应VSCode中的python.analysis.extraPaths配置）。

PyCharm配置步骤 #

方式一：通过UI界面配置（推荐） #

• 打开PyCharm，按下快捷键Ctrl+Alt+Shift+S打开Project Structure窗口（或通过菜单File > Project Structure进入）；
• 左侧面板选择Modules，选中当前项目对应的模块；
• 切换到Sources标签页；
• 点击右侧的Add Content Root按钮，浏览并选中以下目录：
  • ${workspaceFolder}/.bazel-bin/api
  • ${workspaceFolder}/.bazel-bin/cloud
  • ${workspaceFolder}/.bazel-bin/storage
• 选中这些目录后，在窗口下方的Mark as区域选择Sources，将它们标记为源码根目录；
• 点击Apply和OK保存设置。

方式二：手动修改配置文件 #

如果需要批量配置或通过版本控制同步设置，可以修改PyCharm的项目配置文件：

• 找到项目根目录下的.idea/modules/<your-module-name>.iml文件；
• 在<component name="NewModuleRootManager">节点内的<content>标签下，添加对应目录的配置，示例如下：

<content url="file://$MODULE_DIR$/.bazel-bin/api">
  <sourceFolder url="file://$MODULE_DIR$/.bazel-bin/api" isTestSource="false" />
</content>
<content url="file://$MODULE_DIR$/.bazel-bin/cloud">
  <sourceFolder url="file://$MODULE_DIR$/.bazel-bin/cloud" isTestSource="false" />
</content>
<content url="file://$MODULE_DIR$/.bazel-bin/storage">
  <sourceFolder url="file://$MODULE_DIR$/.bazel-bin/storage" isTestSource="false" />
</content>

• 保存文件后，重启PyCharm生效。

验证 #

配置完成后，PyCharm将不再对api.protos相关的导入标红，代码补全、跳转功能也能正常使用。

内容的提问来源于stack exchange，提问作者Daniel Kurniadi