Python+Behave项目中如何在导入路径中省略src目录

1. 团队通用核心方案：通过run.sh统一配置PYTHONPATH #

项目通过根目录的run.sh启动，直接在脚本中配置PYTHONPATH是最省心的方式，无需成员额外操作：

• 修改根目录的run.sh，在执行测试命令前添加以下代码：

  # 将项目根目录加入Python搜索路径
  export PYTHONPATH="${PYTHONPATH}:$(pwd)"
  # 保留原有的测试执行命令，例如
  behave src/test/features/
  

  配置后，Python会自动将src识别为顶层模块目录，导入时无需添加src.前缀。

2. 补充：完善模块结构（可选） #

Python 3.3+支持隐式命名空间包，但给src及子目录添加空的__init__.py文件，能让模块结构更清晰，减少潜在导入问题：

• 在以下目录创建空的__init__.py：
  • src/
  • src/main/
  • src/main/utils/
  • src/test/
  • src/test/features/steps/
  • src/test/pages/

3. 排查sys.path.insert失效问题 #

之前使用sys.path.insert未生效，通常是路径插入时机不对：

• 若在environment.py中添加，需确保代码在所有导入语句之前执行：

  import sys
  from pathlib import Path
  
  # 获取项目根目录（适配environment.py的路径层级）
  root_dir = Path(__file__).parent.parent.parent.parent
  sys.path.insert(0, str(root_dir))
  
  # 现在可直接导入模块
  from main.device import Device
  

  但这种方式不如run.sh统一配置便捷，不推荐作为团队方案。

4. VSCode开发体验同步（可选） #

为让VSCode代码分析与运行环境一致，可在项目根目录创建.vscode/settings.json并提交到仓库：

{
  "python.analysis.extraPaths": ["${workspaceFolder}"],
  "python.envFile": "${workspaceFolder}/.env"
}

同时创建.env文件（提交到仓库）：

PYTHONPATH=${PYTHONPATH}:${PWD}

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