Python2.7插件升级至Python3.10相对导入报错的解决方案咨询

核心原因 #

插件被软件独立加载时，每个插件模块会被当作顶层模块处理，而非ProjectDir.PluginX这种包结构的一部分，此时使用from ..Common...的相对导入会超出顶层包范围，触发ImportError。

可行解决办法 #

1. 动态将ProjectDir加入Python路径 #

在每个插件的__init__.py开头添加以下代码，手动把项目根目录加入sys.path，之后就能用绝对导入引用Common模块：

import sys
import os

# 获取插件目录的父目录（即ProjectDir的绝对路径）
project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
if project_root not in sys.path:
    sys.path.append(project_root)

# 直接使用绝对导入
from Common.CommonFunctions import Example1

这个方案无需修改项目结构，也不用复制Common目录，适合现有插件的快速适配。

2. 将Common目录转为可安装包 #

如果项目长期维护，可给Common目录添加setup.py（或pyproject.toml），将其作为独立包安装到Python环境：

# Common目录下的setup.py示例
from setuptools import setup, find_packages

setup(
    name="common-functions",
    version="0.1",
    packages=find_packages(),
)

然后在ProjectDir下执行pip install -e .（可编辑模式），之后所有插件都能直接from Common.CommonFunctions import Example1，无需处理路径问题。

3. 利用软件的插件加载配置 #

部分支持插件的软件会提供插件路径配置项，可在软件设置中添加ProjectDir到插件搜索路径，或让软件加载插件前自动将ProjectDir加入sys.path。这种方式无需修改代码，优先查看软件文档确认是否支持。

内容的提问来源于stack exchange，提问作者Travis Pettry