如何永久添加Python站点目录并自动读取项目内.pth文件？

首先直接说结论：Python没有官方提供的所谓“主.pth文件”可以直接指定项目根目录，让其下的project.pth自动被读取，但我们有几个灵活的替代方案，既能保留你project.pth里的相对路径，又不用每次启动解释器手动执行site.addsitedir()。

先帮你理清楚为什么之前的尝试没生效：

• 设置PYTHONPATH只会把项目目录加入sys.path，但不会自动读取该目录下的.pth文件——只有site.addsitedir()方法会在添加目录到sys.path的同时，扫描并加载目录下的.pth文件。
• 在site-packages里创建指向项目根目录的.pth文件，同样只是把项目目录加到sys.path，不会触发读取项目目录内的.pth文件的逻辑。

接下来是具体的可行方案：

方案1：利用用户级site-packages的.pth文件执行代码 #

Python的用户级site-packages目录（只对你当前用户生效，不会影响全局Python环境）支持在.pth文件中执行简单的Python代码。步骤如下：

1. 先获取你的用户site-packages路径，在终端执行：

   python -m site --user-site
   

2. 在这个目录下创建一个新的.pth文件，比如load_my_project.pth，里面写入：

   import os, site
   # 用环境变量指定项目根目录，避免硬编码绝对路径
   project_root = os.environ.get("MY_PROJECT_HOME")
   if project_root:
       site.addsitedir(project_root)
   

3. 然后在你的系统环境变量中设置MY_PROJECT_HOME为你的项目根目录（比如Linux下在~/.bashrc里加export MY_PROJECT_HOME="/path/to/your/project"，Windows下在系统属性里添加环境变量）。

这样每次启动Python解释器时，会自动执行这个.pth里的代码，加载项目根目录并读取其中的project.pth，完全不用手动操作。

方案2：用PYTHONSTARTUP自动执行初始化脚本 #

Python启动时会检查PYTHONSTARTUP环境变量，如果指向一个脚本文件，就会自动执行它。你可以这样设置：

1. 创建一个启动脚本，比如~/.python_startup.py，内容如下：

   import os, site
   project_root = os.environ.get("MY_PROJECT_HOME")
   if project_root:
       site.addsitedir(project_root)
   

2. 设置环境变量PYTHONSTARTUP指向这个脚本文件（比如Linux下export PYTHONSTARTUP="~/.python_startup.py"，Windows同理）。

这个方案和方案1效果类似，区别在于脚本是独立的，不是放在site-packages目录里，管理起来更灵活。

方案3：全局site自定义脚本（不推荐个人项目） #

如果你需要全局生效（所有用户启动Python都加载这个项目），可以修改Python的sitecustomize.py文件：

1. 找到Python的全局site-packages目录（可以用python -c "import site; print(site.getsitepackages())"查看）。
2. 在该目录下创建或修改sitecustomize.py，添加和上面一样的代码：

   import os, site
   project_root = os.environ.get("MY_PROJECT_HOME")
   if project_root:
       site.addsitedir(project_root)
   

不过这个方案会影响全局Python环境，个人项目更推荐前两个用户级的方案。

这些方案都能让你保留project.pth里的相对路径，同时实现自动加载的需求，不用每次手动执行命令或者修改绝对路径。

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