ModuleNotFoundError: No module named 'xxx'可能的解決方案大全


"ModuleNotFoundError: No module named 'xxx'"這個報錯是個非常常見的報錯,幾乎每個python程序員都遇到過,導致這個報錯的原因也非常多,下面是我曾經遇到過的原因和解決方案
  1. module包沒安裝
  2. 忘了import
  3. 沒有__init__.py文件
  4. package包的版本不對
  5. 自定義的包名與安裝的包名相同,導致import包的時候導錯了包
  6. 沒設置PYTHONPATH或者
  7. 自建的module包所在路徑不在PYTHONPATH下
  8. 不恰當的使用了相對導入
下面是每種情況分別的解決方案:

1、module包沒安裝

使用場景:pip安裝的第三方的包找不到
這個原因比較常見,解決辦法就是pip install相應的包即可。如果不確定是否安裝了這個包,使用下面的命令查找報警的那個包名,如果有輸出結果,說明存在這個包,否則說明不存在這個包。
pip list | grep xxx #把xxx替換成你的包名即可
如果在pip install的過程中提示包找不到,沒有這個版本的包,可能是需要加上內置源,比如想要下載公司內部的包,那肯定需要加上公司的內置源才能找到相應的包。內置源的的使用方式加上-i參數即可。
pip install xxx -i https://xxx.xx.org/simple
# 比如下面是清華的源
# https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple/

2、忘了import

使用場景:pip安裝的第三方的包找不到、自建的module包找不到
module安裝了但是沒有import,這個原因也經常碰到,比如使用了datetime對象, 但是沒有導入datetime包。 解決方案同樣非常簡單,import 相應的包即可。比如下面的案例:
import os
import sys
import time
import datetime
這種情況最容易出現在從別處copy了一段了代碼,但是沒有把所有用到的module導入進來。

3、沒有__init__.py文件

使用場景:自建的module包找不到
因為python在解釋包的時候會給本文件夾也就是本module下的所有文件建立一個索引放在當前路徑下的__init__.py文件中,如果沒有module的文件索引,我們即使import了指定的包,解釋器還是找不到這個module下的文件的,因而我們一般會在每個文件夾下建一個空的__init__.py文件。如果一個文件夾下沒有__init__.py文件,不會被當做一個module。
解決方案:如果這個包是你自己寫的,不妨檢查一下待導入的包的根目錄是否存在一個__init__.py文件,沒有的話建一個空的__init__.py文件即可 (注意:不光要檢查待導入的包根目錄是否存在__init__.py文件,還需要檢查當前程序所在文件夾是否存在這個文件)。如果這個包是pip install來的,那基本上可以忽略這種可能了,繼續嘗試下面的原因吧。
對於缺少__init__.py文件這種情況,還有一種報錯形式是: ImportError: attempted relative import with no known parent package

4、安裝的第三方module包的版本不對

使用場景:pip安裝的第三方的包找不到
當看到這里,說明你已經檢查並確定了module已經被安裝了,import語句也有,__init__.py文件同樣滿足。這個時候或許可以懷疑一下是否是第三方包的版本與當前所用python版本不兼容。
解決方案是需要先卸載原來pip 安裝的包,然后安裝一個指定版本的包。比如python3不兼容 2.0版本及以上的DBUitls包,需要安裝1.x的版本才行。
pip uninstall DBUtils
pip install DBUtils==1.3
可能有同學會問怎么確定這個module是否跟當前的python版本兼容呢?這個很遺憾的告訴你,我也不知道,但是可以嘗試把’找不到xxx包' 的報警提示直接復制到搜索引擎中搜索結果,如果是因為不兼容的原因很容易就能找到對應的說明博客,博客中一定會說明需要安裝哪個版本的包比較合適,按照博客說明來操做即可。如果找了一圈都沒發現關於不兼容的說法,放棄吧,說明你的問題應該不是這個情況。打起精神,繼續嘗試下一種解決方案吧。

5、自建的包名與第三方安裝的包名相同,導致import包的時候導錯了包

使用場景:pip安裝的第三方的包找不到、自建的module包找不到
這種情況不經常發生,但是一旦發生,非常難找到原因。我曾經就自己在當前項目下創建了名為kafka的module文件夾(包含__init__.py文件的文件夾被稱為module文件夾),而我又使用pip命令安裝了一個kafka包,我在程序中使用import kafka命令導包的時候其實我是想導入pip下來的第三方包的,但是因為python包管理機制和包查找優先級,會優先從當前路徑下找指定的包,如果當前文件夾下存在指定的包,則不會去PYATHONPATH或者其他路徑下找包。
解決方式是給自己的文件夾換個名字,使得與第三方包名不沖突。

6、沒設置PYTHONPATH環境變量

使用場景:pip安裝的第三方的包找不到
有同學可能會說為什么有同學也沒設置這個環境變量,為啥他就能順利執行,我就不行,這里我只能說每個人的電腦的開發環境不一樣,開發環境這種東西永遠帶有點玄學的意味。
解決方案:
再次執行安裝intall這個包的命令,這時它不會再次安裝,而是會提示xxx包在xx路徑已經滿足,而之所以找不到,是因為沒有把這個路徑添加到PYTHONPATH這一環境變量中。這里以DBUtils包為例:
% pip install DBUtils==1.3
Requirement already satisfied: DBUtils==1.3 in ./venv/lib/python3.9/site-packages (1.3)
復制上面的路徑,然后在terminal終端執行下面這條命令,把加粗標記的路徑改成你剛才復制的路徑就好。這條命令即可將剛才的包路徑添加到環境變量中。
export PYTHONPATH=./venv/lib/python3.9/site-packages:$PYTHONPATH
無論是否在虛擬環境中,這樣的解決方式都可以生效。
再次執行程序,應該不會報包找不到的問題了。
如果仍然不行,那么指定pip -V命令,查看輸出結果中的"/pip"之前路徑是否和剛才加入環境變量的路徑一樣,如果不一樣,把這個路徑也加入到環境變量中。
% pip -V
pip 21.1.3 from /Users/lch/python_project/learn_python/venv/lib/python3.9/site-packages/pip (python 3.9)
其實我的pip -V輸出的路徑和剛才的路徑是一樣的,但是為了演示不一樣的情況,這里假設這個路徑和剛才添加的路徑不一樣,這里再添加一遍到環境變量。
export PYTHONPATH= /Users/lch/python_project/learn_python/venv/lib/python3.9/site-packages:$PYTHONPATH
提示:直接在終端運行export關鍵字來添加環境變量的方式可以讓變量立即生效,不需要source某個文件,但是這個方式只適用於當前終端,一旦當前終端關閉或在另一個終端中,則失效。如果想要長久生效,參考“ Linux和Mac環境變量設置”將路徑添加到環境變量文件中。

7、自建的module包所在路徑不在PYTHONPATH下

適用場景:自建的包找不到
在IDE中執行python程序,編譯器會自動把當前項目的根目錄加入到包查找路徑中,可以理解為加到PYTHONPATH下,所以直接執行是沒有問題的。但是在cmd或者terminal控制台中直接使用python相關命令來執行程序,不會自動將當前項目加入到PYTHONPATH環境變量下,如果涉及到import其他文件夾下的變量就會報類似ImportError: No module named xxx這樣的錯誤。
解決方法是使用sys.append()命令把報警包的所在文件夾路徑加入到PYTHONPATH。下面是一個🌰:
比如你的項目下叫做learn_python, 下面是你的項目根目錄下的文件結構。
├──README.md
├──__init__.py
├──conf
│ ├── __init__.py
│ ├── offline_conf.py # 本地運行配置文件
│ └── online_conf.py # 線上運行配置文件
└──server # 啟動服務文件夾
├── __init__.py
└── launch.py
你在運行launch.py時報警conf這個module找不到,這個時候就應該通過sys.append()命令把conf所在文件夾的路徑(注意是conf所在文件夾的路徑,不是conf的路徑),也就是 learn_python的根路徑添加到PYTHONPATH中,下面是實現方案的代碼。
import sys
import logging
import os
# 把當前文件所在文件夾的父文件夾路徑加入到PYTHONPATH
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from conf.online_conf import *
os.path.abspath(__file__)獲取到的是launch.py的絕對路徑;os.path.dirname(os.path.abspath(__file__))獲取到的是launch.py所在文件夾的也就是server的根路徑
os.path.dirname(os.path.dirname(os.path.abspath(__file__)))獲取到的是server所在文件夾也就是learn_python的根路徑。
至此就獲取到了learn_pyhton的根路徑,使用sys.append()命令把路徑添加到環境變量中即可。

8、不恰當的使用了相對導入

python相對導入常見問題和解決方案

忠告

當你排查完了以上所有情況,發現自己都不符合,而且在網上找了很多文章也沒找到解決方案,這個時候別獨自掙扎了,因為你很可能是犯了一個很低級小眾的錯誤,繼續獨自排查很難找到問題所在。最好讓身邊的同學幫你看一下,所謂當局者迷,旁觀者清,可能你看了很長時間卻沒關注到一些比較基礎且常見的設置,這時同事或者同學往往能很快看出你的問題所在。比如你可能一直以為你用的python3, 而實際上用的是python2等等。
 

歡迎關注公眾號 TestDevelop , 我在這里分享各種測試開發技術知識、溝通技巧、職場感言。歡迎后續與我共同成長。  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM