python包导入搜索路径

前言

在Python中，import操作应该算是最为频繁和常见的，但同时也应该是最核心需要搞清楚其工作原理的地方，比如，python是如何找到我希望导入的包的位置的，如果搞清楚了这个问题，那我们后续有自定义的包，就可以放到电脑的任意路径下，然后修改下import的搜索路径信息，就可以找到我们自定义的包了，本文主要就是解决上面的疑问。

一、模块导入时路径搜索机制

1.1 包导入搜索机制

python的import操作，其本质类似于我们日常在电脑上搜索指定文件名的文件，只不过，python一般不会像我们那样，在本地磁盘全盘进行搜索，而是有其自己的控制机制，可以控制搜索的范围和顺序，这样可以保证效率，同时也可以做到一定程度的隔离，比如python创建虚拟的运行环境，就是基于这个原理，不同虚拟运行环境，python安装路径、import搜索路径都是单独隔离的，而常用的虚拟环境维护和创建工具，其核心也是通过修改python默认安装路径、版本、包搜索路径等信息达到目的的。

一般情况下，import时，包搜索顺序和范围如下：

1. 首先搜索运行命令当前文件夹，或者系统当前工作文件夹（可通过命令修改cwd）
2. 再搜索环境变量PYTHONPATH内的文件路径
3. 最后搜索python安装路径内的sitepackages文件夹（一般通过pip安装的包，均会默认放到这个文件夹下，当然，也可简单的将自己的包放到这个文件夹下，这样也无需改变搜索路径）

1.2 修改搜索路径

核心思路，即修改1.1中提到的三个搜索节点的值，即可改变 包导入时的搜索范围

1.2.1 通过修改sys.path变量

sys.path变量，管理的是Python包搜索路径内所有文件夹路径（即当前文件夹、PYTHONPATH环境变量内的路径、python默认安装路径），该变量是个列表，可以通过sys.path.append或者sys.path.insert等方法，将自己希望导入时被搜索的路径添加到该列表变量内即可。

不过该方法只会在运行时生效，一旦退出，便失效。

1.2.2 通过修改PYTHONPATH环境变量

PYTHONPATH环境变量，是管理python包导入时的搜索路径的变量，故可以通过向该环境变量内添加路径的方式来修改搜索路径，且该方法因为是修改了环境变量，故也是永久的，且影响也是全局的。

针对Mac电脑，修改该环境变量的方法如下：

1. 打开~/.bashrc文件，如果没有，则通过touch命令创建
2. 在文件内写上 export PYTHONPATH=your own dir :$PYTHONPATH，比如你希望将~/test路径添加至该环境变量，则为  export PYTHONPATH=~/test :$PYTHONPATH
3. 在命令行执行 source ~/.bashrc（主要是让系统重新加载运行该文件，以使此次修改生效）

1.2.3 通过添加**.pth文件

以上两个办法，或者是临时修改，或者就是全局修改影响面太大，第三种方式可谓兼具前两种方法的特点。

可以在指定Python安装目录下的site-packages目录文件夹内，添加一个**.pth文件，在该文件内逐行添加自己希望被搜索的路径即可。

附：临时添加python搜索包路径的方法

方法1：（先进入python）

import sys
sys.path.append(‘路径')

（这种方式仅对当前python有效）

方法2：

export PYTHONPATH=路径

(这种方式对所有的python有效)

总结