一文搞懂Python中的import与目录层级

在Python开发中，合理地组织代码和正确地使用import语句是构建可维护、可扩展项目的关键。

在具体介绍之前，我们先理解两个概念：

包(package)和模块(module)

模块(module) 可以理解为一个.py扩展名的 python程序文件。

包(package) 就是包含一个或多个.py 程序的目录。

绝对导入与相对导入

绝对导入：从项目的根目录（或包含__init__.py的目录）开始，逐级指明模块或包的位置。

相对导入：使用点（.）表示当前包和父包，从而导入同级包或子包中的模块。相对导入仅在包内部有效，且当直接运行模块文件时可能会失败（因为此时没有包的概念）。

对于__init__.py文件,Python 3.3+版本以后,具有隐式命名空间包,可以不创建这个文件。当然为了使程序能够兼容Python 3.3和以前的环境，可以建一个空的__init__.py文件。

举例说明，假设我的程序目录结构如下：

my_project/  
│  
├── main.py       # 项目的入口文件  
├── package1/     # 第一个包  
│   ├── __init__.py  
│   ├── moduleA.py  
│   └── submodule/  
│       ├── __init__.py  
│       └── moduleB.py  
└── package2/     # 第二个包  
    ├── __init__.py  
    └── moduleC.py

在实际项目开发中，建议使用项目入口文件来包含模块，而不是在模块中去调用另一个模块。

上面目录结构中，my_project 是我的项目根目录，下面有两个包package1和package2

在main.py中调用moduleB：

from package1.submodule import moduleB  

在main.py中调用moduleA的方法funcA：

#直接导入整个模块
from package1  import moduleA  
# 使用时需要加前缀
moduleA.funcA()

或者

#从模块中导入特定内容
from package1.moduleA  import funcA
# 这时可以直接使用funcA
funcA()

上面例子都是在main.py中调用package1和package2中的模块

实际项目中入口程序可能在另外的目录，比如在my_project下面的app目录。

my_project/  
│  
├── main.py       # 项目的入口文件  
├── app/     #应用程序目录
│   ├── app.py  # 应用程序的主文件
├── package1/     # 第一个包  
│   ├── __init__.py  
│   ├── moduleA.py  
│   └── submodule/  
│       ├── __init__.py  
│       └── moduleB.py  
└── package2/     # 第二个包  
    ├── __init__.py  
    └── moduleC.py

这时候如果在app/app.py中调用moduleB.py或moduleC.py 情况就不一样了。

from package1.submodule import moduleB  

如果像上面这样使用，首先要需要确保项目目录my_project在Python环境变量PYTHONPATH中，Python解释器能够找到你的项目目录。

如果你是在pycharm等IDE中开发，项目根目录是my_project，因为IDE已经帮你正确设置了项目的工作目录，直接在app.py中运行应该不会有问题。但如果你是从终端，比如CMD下运行app.py，那么很可能会提示ModuleNotFoundError.

解决办法1，使用-m选项，运行命令为：

python -m my_project.app.app

另外一个办法就是使用sys.path.append

在app.py程序开头添加下面代码

import sys; 
sys.path.append('../'); 

这样就可以使程序在脱离IDE的情况下也能正常运行。