ImportError: No module named ..

2023年3月9日 198次阅读

在 PyCharm 里正常运行的程序在CLI命令界面中运行失败，抛出 ImportError: No module named .. 错误。

原因是 PyCharm 会将当前工程根目录追加到 PYTHONPATH 变量，进而通过 sys.path 变量引导系统搜索当前目录下的模块，而系统CLI使用命令 python 执行脚本时，并没有自动追加工程根目录，导致导入包搜索失败。

解决方法从这里找到了：
https://stackoverflow.com/questions/37536832/python-run-importerrorno-module-named

复述一下解决思路，主要是通过本地安装，将项目（软链接）安装至系统 python 第三方模块目录下，从而根本上解决搜索路径问题。

假设项目目录如下：

ProjectName/
├── setup.py
├── project_name/
  ├── __init__.py
  ├── program.py
  ├── module_a.py
  └── module_b.py

首先需要为项目建立一个 setup.py 脚本，用于引导安装过程，指定程序入口等，内容格式大概如下：

from setuptools import setup, find_packages
setup(
    name=PROJECT_NAME,    # 填入合适的名字，下同
    version=VERSION,
    author=AUTHOR,
    package=find_packages(),
    install_requires=['docopt'],    # 这里填入该项目依赖的所有第三方模块
    entry_points={
        'console_scripts': [
            'command_name = project_name.program:main'    # 这里的各个字段需要改为当前项目匹配名字
          # command_name 指定一个启动当前程序的命令名
          # 该命令触发当前项目根目录下 project_name 目录中名为 program 模块内的 main 函数
        ]
    }
)

然后在项目根目录下执行 pip install -e . 命令（推荐在 virtualenv 环境下操作），该项目即以 egg-link 形式创建到 python 目录中，并保持与当前项目代码同步更新。

现在开始可以通过之前设定的 command_name 调用程序。

除了上述方法以外，也可以通过在项目根目录下建立一个临时入口脚本，调用真正需要执行的次级包脚本、函数，通过 CLI 调用项目根目录下的该临时入口脚本不会产生 ImportError 问题。

最后也可以尝试修改系统变量方式解决（未验证）。

点赞