如何实现Python模块兼顾外部引用与独立运行的正确导入？

项目结构 #

workspace/
   module_1/
      main.py
   module_2/
      content.py
      standalone.py

现有代码 #

module_1/main.py #

from module_2.content import Foo

Foo.bar()

module_2/content.py #

class Foo:
    def bar():
        pass

module_2/standalone.py #

from content import Foo

Foo.bar()

问题描述 #

当前存在导入矛盾：

• 若在module_2/standalone.py中用from content import Foo，运行module_1/main.py时会因找不到content模块报错
• 若改成from module_2.content import Foo，直接运行standalone.py时又会因找不到module_2模块报错

需求是让module_2既能作为模块被外部项目引用，又能让内部的standalone.py独立运行。

解决方案 #

方案1：动态调整导入逻辑 #

在standalone.py中通过判断运行场景，切换导入方式，兼容两种运行情况：

try:
    # 作为模块被导入时，用相对导入
    from .content import Foo
except ImportError:
    # 直接运行脚本时，用本地导入
    from content import Foo

Foo.bar()

方案2：手动添加项目根目录到Python路径 #

通过代码把workspace目录添加到sys.path，让Python能识别顶层模块：

import sys
import os

# 获取workspace的绝对路径：当前脚本目录的上级目录
workspace_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
if workspace_path not in sys.path:
    sys.path.append(workspace_path)

# 统一用绝对导入
from module_2.content import Foo
Foo.bar()

这种方式不需要修改导入习惯，无论直接运行还是被外部导入都能正常工作。

方案3：规范包结构（官方推荐） #

把module_2变成标准Python包，通过模块方式运行脚本：

1. 在module_2目录下创建空文件__init__.py，结构变为：

workspace/
   module_1/
      main.py
   module_2/
      __init__.py
      content.py
      standalone.py

2. 修改standalone.py为统一的绝对导入：

from module_2.content import Foo

Foo.bar()

3. 运行standalone.py时，在workspace目录下执行：

python -m module_2.standalone

这种方式符合Python包的规范，是长期维护大型项目的最优选择。

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