Pycord discord.ui.Modal：安全传递自定义参数的教程

理解 discord.ui.Modal 的初始化机制

在使用 pycord 库开发 discord 机器人时，discord.ui.modal 提供了一种强大的方式来收集用户的多行输入。当我们需要在模态框提交时处理一些与模态框本身无关，但与触发模态框的上下文相关的动态数据时，就需要向 modal 类传递自定义参数。

discord.ui.Modal 本身是一个复杂的类，它继承自 discord.ui.View 或其他基类，并负责内部的许多初始化工作，例如设置 custom_id 等关键属性，这些属性对于 Discord API 识别和处理模态框至关重要。这些内部初始化通常在 Modal 类的 __init__ 方法中完成。

问题：直接覆盖 __init__ 导致的 AttributeError

当开发者尝试向自定义的 Modal 类（例如 Report_SurveyModal_NoRace）传递自定义参数时，常见的做法是像普通 Python 类一样，直接覆盖 __init__ 方法：

import discord

class Report_SurveyModal_NoRace(discord.ui.Modal, title='KRF1 Report'):
    def __init__(self, steward_flag: int):
        # 尝试直接设置自定义参数
        self.steward_flag = steward_flag

    was = discord.ui.TextInput(label='Describe what happened', style=discord.TextStyle.paragraph, max_length=1000)
    media = discord.ui.TextInput(label='Media', style=discord.TextStyle.paragraph, max_length=500, placeholder="blabalblablab", required=False)

    async def on_submit(self, interaction: discord.Interaction):
        # ... 使用 self.steward_flag ...
        print(f"Steward Flag: {self.steward_flag}")
        await interaction.response.send_message("Report submitted!", ephemeral=True)

# 假设在某个回调函数中触发模态框
async def some_callback(interaction: discord.Interaction, flag_value: int):
    modal = Report_SurveyModal_NoRace(flag_value)
    await interaction.response.send_modal(modal)

然而，这种做法会导致一个 AttributeError：

AttributeError: 'Report_SurveyModal_NoRace' object has no attribute 'custom_id'

这个错误的原因在于，当您在子类中定义了自己的 __init__ 方法时，Python 默认不会自动调用父类（discord.ui.Modal）的 __init__ 方法。这意味着 discord.ui.Modal 内部负责设置 custom_id 等关键属性的逻辑没有被执行。因此，当 discord.ui.Modal 尝试将自身转换为字典以发送给 Discord API 时，它找不到预期的 custom_id 属性，从而抛出 AttributeError。

解决方案：使用 super().__init__()

要正确地向 discord.ui.Modal 子类传递自定义参数，同时又确保父类的初始化逻辑得以执行，必须在子类的 __init__ 方法中显式调用 super().__init__()。

super().__init__() 的作用是调用当前类的父类（或更准确地说，是 MRO（方法解析顺序）中的下一个类）的 __init__ 方法。通过这样做，我们可以确保 discord.ui.Modal 类的所有必要初始化步骤都被执行，包括设置 custom_id 等内部属性，同时我们也可以在 super().__init__() 调用之后安全地添加我们自己的自定义参数初始化逻辑。

杰易OA办公自动化系统6.0

基于Intranet/Internet 的Web下的办公自动化系统，采用了当今最先进的PHP技术，是综合大量用户的需求,经过充分的用户论证的基础上开发出来的，独特的即时信息、短信、电子邮件系统、完善的工作流、数据库安全备份等功能使得信息在企业内部传递效率极大提高，信息传递过程中耗费降到最低。办公人员得以从繁杂的日常办公事务处理中解放出来，参与更多的富于思考性和创造性的工作。系统力求突出体系结构简明

下载

以下是修正后的代码示例：

import discord

class Report_SurveyModal_NoRace(discord.ui.Modal, title='KRF1 Report'):
    def __init__(self, steward_flag: int):
        # 重点：首先调用父类的 __init__ 方法
        super().__init__(title='KRF1 Report') # 如果父类__init__接受参数，需要传递

        # 然后再初始化自己的自定义参数
        self.steward_flag = steward_flag

    # 模态框的输入组件
    was = discord.ui.TextInput(label='Describe what happened', style=discord.TextStyle.paragraph, max_length=1000)
    media = discord.ui.TextInput(label='Media', style=discord.TextStyle.paragraph, max_length=500, placeholder="blabalblablab", required=False)

    async def on_submit(self, interaction: discord.Interaction):
        """
        当用户提交模态框时触发的回调函数。
        """
        # 在这里可以使用 self.steward_flag
        print(f"Steward Flag received: {self.steward_flag}")
        print(f"Description: {self.was.value}")
        print(f"Media: {self.media.value}")

        # 示例：根据 steward_flag 执行不同的逻辑
        if self.steward_flag == 1:
            await interaction.response.send_message("Report submitted with steward flag active!", ephemeral=True)
        else:
            await interaction.response.send_message("Report submitted.", ephemeral=True)

# 示例：如何在实际应用中创建并发送这个模态框
async def show_report_modal(interaction: discord.Interaction, is_steward: bool):
    """
    一个示例函数，用于根据条件显示带有自定义参数的模态框。
    """
    flag_value = 1 if is_steward else 0
    modal = Report_SurveyModal_NoRace(steward_flag=flag_value)
    await interaction.response.send_modal(modal)

# 假设在一个命令或组件回调中调用
# @bot.command()
# async def report(ctx):
#     # 假设这里有一个逻辑判断用户是否为管理员/steward
#     is_steward_user = True # 或 False
#     await show_report_modal(ctx.interaction, is_steward_user)

关于 super().__init__(title='KRF1 Report') 的说明：

在 discord.ui.Modal 的情况下，title 参数通常是在类定义时直接传递给 discord.ui.Modal 基类的，例如 class MyModal(discord.ui.Modal, title='My Title'):。如果 discord.ui.Modal 的 __init__ 方法也接受 title 参数，并且你希望在运行时动态设置它，那么你可能需要在 super().__init__(title=...) 中传递它。但在大多数情况下，如果 title 已在类定义中指定，super().__init__() 不带参数就足够了。然而，为了确保与基类的兼容性，如果基类的 __init__ 确实需要某些参数，最好将其传递进去。在 Pycord 的 Modal 实现中，title 是通过元类处理的，因此在 super().__init__() 中通常不需要传递 title。最安全的做法是查阅 Pycord 的官方文档。通常情况下，不带参数的 super().__init__() 即可。

注意事项与最佳实践

1. 始终调用 super().__init__()： 当你继承一个库提供的类，并且需要在子类中定义自己的 __init__ 方法时，几乎总是需要调用 super().__init__() 来确保父类的正确初始化。这是面向对象编程中继承的一个基本原则。
2. 参数顺序： 最好在调用 super().__init__() 之后再初始化自定义参数。这确保了父类在子类进行任何特定操作之前已处于有效状态。
3. 理解继承链： 对于多重继承，super() 会根据 MRO（Method Resolution Order）来决定调用哪个父类的方法。虽然对于 discord.ui.Modal 这种单基类（或主要基类）继承场景通常不是问题，但在更复杂的继承结构中，理解 MRO 很重要。
4. 查阅文档： 在使用任何库的组件时，查阅其官方文档是最佳实践。文档会详细说明类构造函数的预期行为和参数。

总结

通过正确地在自定义 discord.ui.Modal 类的 __init__ 方法中调用 super().__init__()，开发者可以安全地向模态框传递自定义参数，同时避免因父类初始化不完整而导致的 AttributeError。这一方法不仅解决了特定的技术问题，也体现了 Python 中面向对象编程和继承机制的核心原则。掌握这一技巧，将使您能够更灵活、更强大地构建基于 Pycord 的 Discord 机器人交互界面。