python 中的模块、包以及搜索路径的问题

我就是我 2022-09-10 13:12 241阅读 0赞

### python 中的模块、包以及搜索路径的问题 ###

### 1. 模块（module） ###

### 1.1 什么是模块？ ###

一个 .py 文件就是一个模块。

### 1.2 模块搜索路径 ###

当你导入一个模块，Python 解析器对模块位置的搜索顺序是：

*  1、当前目录（入口的目录，比如 python main.py 是指 main.py 所在的目录）
 *  2、如果不在当前目录，Python 则搜索在 shell 变量 PYTHONPATH 下的每个目录。
 *  3、如果都找不到，Python 会察看默认路径。UNIX下，默认路径一般为 /usr/local/lib/python/。

模块搜索路径存储在 system 模块的 sys.path 变量中。变量里包含当前目录，PYTHONPATH和由安装过程决定的默认目录。

### 1.3 增加搜索路径 ###

既然模块搜索路径存储在 system 模块的 sys.path 变量中，只要向里面添加路径就可以增加搜索路径。

比如对于下面这个 project， main.py 中需要引入 package\_1 的时候，明显是找不到的，因为 package\_1 不在 API 目录下。

此时可以在 main.py 中 添加如下代码，增加搜索路径，就可以找到 package\_1。

sys.path.append('..')
    from package_1.module_1 import function1

### 1.4 python -m ###

1.3 中提到的增加搜索路径的方式是显式的增加，还有一种方式是通过 python -m 的方式。这里就需要明白 python -m 和 python 命令的区别了。具体的区别很多，可以参考 [Python 中 -m 的典型用法、原理解析与发展演变][Python _ -m]。这里仅仅关注两个命令对 sys.path 的影响。

*  在 project\_dir 目录下执行 python package\_1/module\_1.py。module\_1.py 中打印 sys.path 的值。

sys.path: '/xxx/project_dir/package_1', ...

*  python -m package\_1.module\_1，打印的结果如下：

sys.path: '/xxx/project_dir', ...

可以很明显的发现 sys.path 的值是不一样的， python -m 添加到 sys.path 的是执行命令的目录，而不是 module 的目录。通过这一点，就可以直接通过如下命令执行 main.py， 而不用在 main.py 中增加路径到 sys,path 中。

python -m API.main

## 2. 包(package) ##

### 2.1 什么是包？ ###

一个包含 \_\_init\_\_.py 的文件夹就是一个包，其中 \_\_init\_\_.py 文件可以为空。下面 package\_1 就是一个包。

main.py
    package_1
    |-- __init__.py
    |-- module_1.py
    |-- module_2.py

### 2.2 \_\_init\_\_.py 的作用？ ###

在导入包的过程中 \_\_init\_\_.py 中的代码会被执行，然后才会把包导入。因此**可以通过 \_\_init\_\_.py 简化包的导入**。还是看下面这个例子。