如何以可共享方式在多个Python脚本中导入自定义工具包

现有目录结构 #

└── WORK
    ├── PythonToolBox
    │   └── Tool1
    │       └── module1.py 
    ├── Use1
    │   └── pkg1
    │       └── p1_script.py
    └── SomeSubdirectory
        └── Use2
            └── pkg2
                └── p2_script.py

现有方案的核心问题 #

• 动态修改sys.path方案：需要根据脚本所在目录层级手动调整Path(__file__).parents[n]的索引值，项目迁移、共享给其他使用者时必须逐脚本修改路径处理代码，维护成本极高
• 多副本复制方案：每个项目单独存储一份工具包代码，迭代更新时无法同步所有副本，极易出现版本不一致、功能逻辑不统一的问题

最优实现方案：可编辑模式安装自定义工具包 #

这是Python生态下复用本地自定义代码的标准方案，完全不需要手动处理路径，也不会产生多副本问题，步骤如下：

1. 补全包配置文件
   如果希望保留原有import PythonToolBox.Tool1.module1 as mod1的导入写法，直接在WORK根目录下新建pyproject.toml文件，写入最小配置：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "python-custom-toolbox"
version = "0.1.0"
packages = ["PythonToolBox"]

2. 执行可编辑安装
   打开终端，激活你当前使用的Python环境（虚拟环境/系统环境均可），切换到WORK目录下执行命令：

pip install -e .

命令中-e是可编辑模式标记：安装完成后Python解释器会直接关联本地PythonToolBox目录，你对module1.py做的任何修改、功能迭代都会实时生效，不需要重复执行安装操作，也不会生成额外的代码副本。

3. 直接导入使用
   无论脚本在哪个目录层级（不管是p1_script.py还是更深层的p2_script.py），都不需要加任何sys.path处理逻辑，直接写导入语句即可：

import PythonToolBox.Tool1.module1 as mod1

共享项目时，只需要让协作者在自己的环境里，对着你提供的PythonToolBox目录执行一次同样的pip install -e命令，所有导入逻辑完全不需要修改，和使用requests、numpy这类第三方包的体验完全一致。

轻量备选方案：配置PYTHONPATH环境变量 #

如果不想做包配置，可以直接把WORK目录的绝对路径加入系统PYTHONPATH环境变量，Python启动时会自动将该路径下的合法包加入搜索范围，同样不需要在脚本内写路径处理代码：

• Windows系统：在系统环境变量设置中新增PYTHONPATH项，值填入WORK目录的绝对路径
• Mac/Linux系统：在~/.bashrc或~/.zshrc（根据你使用的shell选择）中新增一行配置：

export PYTHONPATH="/你的WORK目录绝对路径:$PYTHONPATH"

配置完成后所有脚本都可以直接导入工具包，缺点是换设备、换环境时需要重新配置环境变量，共享项目时需要额外告知协作者配置路径，通用性弱于可编辑安装方案。

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