python修改包導入時搜索路徑的方法

Posted on by

前言

在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有效)

總結

到此這篇關於python修改包導入時搜索路徑的文章就介紹到這瞭,更多相關python包導入搜索路徑內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：