如何解决Python中Bot与Events类的循环导入问题？

问题场景 #

我在bot.py中定义了Bot类：

import events

class Bot:
    def __init__(self, token, v):
        self.token = token
        self.v = v
        self.events = events.Events(self)

同时events.py文件内容如下：

import bot

class NewMessageEvent:
    def __init__(self, bot: bot.Bot):
        self.bot = bot
        self.someVar = "someVar"
        self.someVar2 = "someVar2"
        self.sender_id = "some_id"
        self.event_id = "some_id2"
        self.handlers = []
    
    def subscribe(self, handler):
        self.handlers.append(handler)

    def execute(self):
        for func in self.handlers:
            func(self)
    

class Events:
    def __init__(self, bot: bot.Bot):
        self.MESSAGE_NEW = NewMessageEvent(bot)
        #self.SMTH_ANOTHER = SomeAnotherEvent(bot)

使用代码的方式：

import bot
import events

mybot = bot.Bot("token", "api version")

def send_pic(event: events.NewMessageEvent):
    requests.get("link", headers = {"token": event.bot.token, "reply_to": event.sender_id})

mybot.events.MESSAGE_NEW.subscribe(send_pic)

这里出现了循环导入问题：Bot类依赖Events类，而Events类的类型提示又需要导入Bot类。下面是几种可行的解决方法：

方法1：字符串形式的类型提示（推荐） #

Python 3.7及以上支持用字符串指定类型提示，无需在文件顶部导入依赖类，从根源避免循环导入。如果是Python 3.7-3.9版本，需要先导入from __future__ import annotations启用该特性；3.10+版本无需额外导入。

修改events.py：

# Python 3.7-3.9需添加此行，3.10+可省略
from __future__ import annotations

# 移除顶部的import bot

class NewMessageEvent:
    # 用字符串"bot.Bot"代替直接引用bot.Bot
    def __init__(self, bot: "bot.Bot"):
        self.bot = bot
        self.someVar = "someVar"
        self.someVar2 = "someVar2"
        self.sender_id = "some_id"
        self.event_id = "some_id2"
        self.handlers = []
    
    def subscribe(self, handler):
        self.handlers.append(handler)

    def execute(self):
        for func in self.handlers:
            func(self)
    

class Events:
    # 同样使用字符串类型提示
    def __init__(self, bot: "bot.Bot"):
        self.MESSAGE_NEW = NewMessageEvent(bot)
        #self.SMTH_ANOTHER = SomeAnotherEvent(bot)

这样events.py不再需要在顶部导入bot，运行时和类型检查工具（如mypy）都能正常识别类型。

方法2：延迟导入 #

把导入语句放到需要使用的函数/方法内部，而非文件顶部，避免模块加载阶段触发循环导入。

修改events.py：

# 移除顶部的import bot

class NewMessageEvent:
    def __init__(self, bot):
        # 在方法内部才导入Bot类
        from bot import Bot
        # 可选：添加断言做类型检查
        assert isinstance(bot, Bot)
        self.bot = bot
        self.someVar = "someVar"
        self.someVar2 = "someVar2"
        self.sender_id = "some_id"
        self.event_id = "some_id2"
        self.handlers = []
    
    def subscribe(self, handler):
        self.handlers.append(handler)

    def execute(self):
        for func in self.handlers:
            func(self)
    

class Events:
    def __init__(self, bot):
        from bot import Bot
        assert isinstance(bot, Bot)
        self.MESSAGE_NEW = NewMessageEvent(bot)
        #self.SMTH_ANOTHER = SomeAnotherEvent(bot)

这种方法牺牲了部分类型提示的便利性，但能快速解决循环导入问题，适合对类型检查要求不高的场景。

方法3：拆分公共类型到独立文件 #

如果项目结构复杂，可将Bot类的类型定义拆分到单独文件（比如types.py），让两个模块都依赖这个公共文件，避免互相导入。

1. 新建types.py：

# 定义Bot基类，或直接将完整Bot类移到这里
class Bot:
    def __init__(self, token, v):
        self.token = token
        self.v = v

2. 修改bot.py：

import events
from types import Bot

class Bot(Bot):
    def __init__(self, token, v):
        super().__init__(token, v)
        self.events = events.Events(self)

3. 修改events.py：

from types import Bot

class NewMessageEvent:
    def __init__(self, bot: Bot):
        self.bot = bot
        self.someVar = "someVar"
        self.someVar2 = "someVar2"
        self.sender_id = "some_id"
        self.event_id = "some_id2"
        self.handlers = []
    
    # 其他方法保持不变

class Events:
    def __init__(self, bot: Bot):
        self.MESSAGE_NEW = NewMessageEvent(bot)
        #self.SMTH_ANOTHER = SomeAnotherEvent(bot)

这种方法适合大型项目，能更好地解耦模块，但需要调整现有代码结构。

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