避免导入的`sys.path.append(..)`

问题描述

这不是我第一次对imports在Python中畏首畏尾了。但我想这是一个有趣的用例，所以我想在这里询问它，以便更好地了解它。我的项目结构如下：

sample_project
   - src
        - __init__.py
        - module1
           - __init__.py
           -  utils.py
        - module2
           - __init__.py 
           - models.py
        - app.py

module1从module2导入方法，app从所有其他导入方法。此外，当您运行app时，它需要在src文件夹之外创建一个名为logs的文件夹。现在有多种方法可以运行这款应用程序：

1. 从src文件夹flask run app
2. 从src文件夹flask run src.app

为了确保我不会因为应用程序启动的顶层模块的更改而得到import errors，我这样做：

import sys
sys.path.append("..")

有没有更好的解决方案来解决这个问题？

---

解决方案

导入问题的典型解决方案是不将sys.Path(或间接PYTHONPATH)黑客添加到可能用作顶层脚本的任何文件(包括单元测试)，因为这使得您的代码库难以更改和维护。假设您必须重新组织项目结构或重命名文件夹。

相反，这就是editable installs的目的。它们可以通过两种方式实现：

1. pip安装--可编辑<path>(需要基本的setup.py)
2. Conda开发<path>(需要conda-build包)

无论采用哪种方式，都会将符号链接添加到您的站点包文件夹中，并使您的本地项目表现为已完全安装，同时您可以继续编辑。

始终记住：让事情易于更改