AWS-CDK项目中sys模块导入为何是取巧做法？如何优化？

问题背景 #

我不是Python专家，目前管理一个AWS-CDK代码仓库，仓库里多数子文件夹的类中都有这样的导入代码：

# Hacky way to get our utils - due to the way folder structure is right now
import sys

sys.path.append("..")
[...]

项目文件夹结构如下：

- [...]
- app.py
- pipeline.py
- requirements.txt
- setup.py
- iam
  |- iam.py
- rds
  |- rds.py
- s3
  | - s3.py

这段import sys的代码存在于iam/iam.py、rds/rds.py和s3/s3.py中，想知道为什么这种导入是取巧做法，以及该怎么优化。

为什么这种导入方式是取巧（Hacky）做法？ #

• 执行路径依赖强：sys.path.append("..")是基于当前脚本的执行目录来添加父目录，如果从项目根目录以外的路径运行脚本（比如直接进入iam文件夹执行python iam.py），就会找不到上级目录的模块，直接报错。
• 违反Python模块规范：Python的导入机制依赖合法的包结构和sys.path里的标准路径，这种硬编码上级目录的方式绕过了正常包管理，代码移植性极差，换个环境就可能跑不起来。
• 容易引发命名冲突：把上级目录直接加入sys.path后，如果不同目录下有同名的模块文件，Python会优先导入sys.path里靠前的那个，导致导入混淆，排查问题非常麻烦。
• 维护成本高：以后要是调整文件夹结构（比如把iam移到另一个子目录下），所有写了这段代码的文件都得修改路径，很容易遗漏出错。

优化方案 #

方案1：利用现有setup.py做可编辑安装（推荐） #

这个方案符合Python包管理规范，一劳永逸：

1. 给iam、rds、s3这几个子文件夹都添加__init__.py文件（空文件就行，用来标识这是Python包）。
2. 修改setup.py，确保它能识别项目里的子包：
   比如用setuptools的find_packages自动发现所有包：

   from setuptools import setup, find_packages
   
   setup(
       name="cdk-project",
       version="0.1",
       packages=find_packages(),
   )
   

   或者也可以手动列出包名：packages=["iam", "rds", "s3"]。
3. 在项目根目录下执行命令，把项目作为本地可编辑包安装：

   pip install -e .
   

4. 修改子文件里的导入语句：比如原来导入上级的utils，现在直接写成from utils import xxx（假设根目录有utils.py），或者导入根目录的其他模块比如from app import xxx，完全不需要再碰sys.path。

方案2：设置PYTHONPATH环境变量 #

如果不想修改setup.py，可以通过环境变量指定项目根目录：

• Linux/macOS终端中，运行脚本前先执行：

  export PYTHONPATH=/你的项目根目录绝对路径
  

• Windows命令提示符中，运行前执行：

  set PYTHONPATH=C:\你的项目根目录绝对路径
  

设置后，子文件里直接用正常的绝对导入即可，不需要sys.path.append("..")。

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