如何开发并组织Python CLI项目？运行及测试遇阻求助

核心原因 #

Python无法找到你的awscli模块，因为项目根目录不在Python的模块搜索路径（sys.path）中。直接运行bin/aws时，Python只会检索系统安装路径和当前脚本所在目录，不会自动识别项目根目录下的模块。

开发阶段无需重复安装的解决方案 #

1. 使用pip可编辑安装（推荐） #

执行以下命令，将项目以“可编辑”模式安装到当前Python环境。修改代码后无需重新安装，Python会直接读取项目目录中的最新代码：

pip install -e .

完成后直接在终端输入aws（或你在setup.py中配置的自定义命令名）即可运行，模块导入问题也会同步解决。

2. 手动添加项目路径到Python搜索路径 #

在bin/aws脚本的开头添加以下代码，将项目根目录加入sys.path：

import sys
import os
# 获取项目根目录（假设bin目录位于项目根目录下）
project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.insert(0, project_root)

之后运行python3 ./bin/aws就能正常导入模块。

单元测试报错的处理思路 #

• 确保在项目根目录下运行测试命令，例如使用python -m pytest tests/（若使用pytest框架），避免直接运行单个测试文件。
• 若测试文件导入模块失败，可在测试文件开头添加上述路径处理代码，或先执行可编辑安装后再运行测试，让Python能正确定位模块。
• 检查并安装完整的测试依赖，例如执行pip install -r requirements-test.txt（若项目提供该依赖文件）。

额外提示 #

• 不要手动复制代码到系统目录，这会导致代码版本混乱，可编辑安装或路径修改是更合理的开发方式。
• 参考aws-cli的setup.py配置，确保你的setup.py正确声明了包（packages参数）和入口脚本（entry_points或scripts参数），这样可编辑安装后能直接通过命令行调用你的CLI。

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