【Python程序开发系列】程序运行出现No module named 'xxx'解决方案

off999 2024-12-31 13:45 43 浏览 0 评论

这是Python程序开发系列原创文章，我的第196篇原创文章。

一、引言

"ModuleNotFoundError: No module named 'xxx'"这个报错是个非常常见的报错，几乎每个python程序员都遇到过，导致这个报错的原因也非常多，解决这个问题之前需要明确这个module是第三方的还是自建的，针对不同的情况采取不同的解决办法。

二、'×××'是第三方module包

2.1 问题

这种情况说明你的python环境确实没有这个包，这时候你需要去确认一下这个包在不在你当前的Python环境或者anaconda环境下，如果没有，你就去通过命令或者其他方式去在环境下安装这个包。这种情况需要注意第三方库的名称和版本。

2.2 解决方案

1、查看这个模块包是否存在

pip list或conda list

2、安装模块

法1：pip install xxxx 或conda install xxxx
法2：pip install xxx.whl (提前下载whl文件到本地)
法3：python setup.py install (提前下载压缩文件到本地解压后看到setup文件再使用)

如果在pip install过程中提示包找不到或者没有这个版本的包，可能是需要加上内置源，比如想要下载公式内部的包，肯定需要加上公司的内置源才能找到。使用方式是加上-i参数即可：

pip install -i https://xxx.xx.org/sample

三、'×××'是自建的module包

3.1 问题

这种情况一般会在命令行运行时出现，在IDE中执行python程序，编译器会自动把当前项目的根目录加入到包查找路径中，可以理解为加到PYTHONPATH下，所以直接执行是没有问题的。但是在cmd或者terminal控制台中直接使用python相关命令来执行程序，不会自动将当前项目加入到PYTHONPATH环境变量下，如果涉及到import其他文件夹下的模块就会报类似ImportError: No module named xxx这样的错误。

3.2 解决方案

为python解释器指定搜索路径,即项目的路径添加到环境变量里。首先看一下sys.path，sys.path是一个Python内置模块sys中的变量，它是一个包含模块搜索路径的列表。当你导入一个模块时，Python会按照sys.path列表中的路径顺序来搜索并加载模块。（这里以我的upstream-observer项目为例）

方法一：在要运行的.py文件开头加这两句

import sys
sys.path.append('/home/wenqiang/proj/upstream-observer')

方法二：在运行环境的python解释器的site_pakages文件夹下添加.pth 文件，如：

1.进入python安装路径的site-packages下。即：
cd /home/wenqiang/anaconda3/envs/upobser/lib/python3.9/site-packages
2.创建一个后缀为.pth的文件：
touch code_path.pth    
3.编辑该pth文件：
vim code_path.pth
4.将你要导入的包的绝对路径写入到xxx.pth文件中。（注意：一定要是绝对路径，并且要导入的包需要有__init__.py文件）
/home/wenqiang/proj/upstream-observer

方法三：直接添加环境变量

  # 添加环境变量
  export PYTHONPATH=$PYTHONPATH:/home/wenqiang/proj/upstream-observer

四、小结

一般提示ModuleNotFoundError: No module named 'xxxxxxx'得到时候就要考虑两个问题，如何'xxxxxxx'是第三方的安装包，那通过pip install xxxxxxx，即可解决；如果是自定义的包，那么就要考虑是路径的问题，尤其是在命令行终端的时候，针对这种情况文章给出了三种解决方法。可能还有小伙伴遇到过，在PyCharm中执行的时候也会出现ModuleNotFoundError: No module named 'xxxxxxx'，而且'xxxxxxx'也是自定义的包，此时可以将项目路径设置为根目录即可解决，具体操作为：在项目的根目录上右键 --> Mark Directory as --> Sources Root。