在 discord.ui.Modal 中传递自定义参数的正确姿势-Python教程-PHP中文网

在 discord.ui.Modal 中传递自定义参数的正确姿势

碧海醫心

发布： 2025-09-25 10:07:20

原创

651人浏览过

在 discord.ui.Modal 中传递自定义参数的正确姿势

本文旨在解决在 discord.ui.Modal 子类中通过 __init__ 方法传递自定义参数时遇到的 AttributeError: 'custom_id' 问题。核心解决方案是在自定义的 __init__ 方法中调用 super().__init__()，以确保父类 discord.ui.Modal 得到正确初始化，从而避免因缺少内部属性而导致的错误，并实现自定义参数的顺利传递。

理解 discord.ui.Modal 与自定义初始化

在使用 discord.py 库构建交互式机器人时，discord.ui.modal 提供了一种创建弹出式表单的便捷方式。当我们需要在模态框提交后处理一些与上下文相关的自定义数据时，自然会想到通过类的 __init__ 方法来传递这些参数。然而，直接在子类中重写 __init__ 而不注意父类的初始化，往往会导致意想不到的问题。

考虑以下场景：我们有一个 Report_SurveyModal_NoRace 类，它继承自 discord.ui.Modal，并且希望在其中引入一个 steward_flag 参数。

import discord

class Report_SurveyModal_NoRace(discord.ui.Modal, title='KRF1 Report'):
    # 文本输入组件
    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)

    # 尝试通过__init__传递自定义参数
    def __init__(self, steward_flag):
        self.steward_flag = steward_flag # 存储自定义参数

    async def on_submit(self, interaction: discord.Interaction):
        # 在提交时使用自定义参数
        runde = ""
        # 假设 report_modal_submit_button 是一个处理函数
        await report_modal_submit_button(interaction, runde, self.was, self.media, self.steward_flag)

# 假设在某个回调函数中调用
async def report_check_for_part_two(interaction: discord.Interaction, steward_flag_value: int):
    modal = Report_SurveyModal_NoRace(steward_flag_value)
    await interaction.response.send_modal(modal)

登录后复制

当尝试运行上述代码并触发模态框时，程序会抛出 AttributeError: 'Report_SurveyModal_NoRace' object has no attribute 'custom_id' 错误。

错误分析：为什么会出现 AttributeError？

这个 AttributeError 的出现，是因为 discord.ui.Modal 在其内部需要一个 custom_id 属性来标识和管理模态框。这个属性以及其他一些必要的内部状态，通常是在 discord.ui.Modal 自身的 __init__ 方法中完成初始化的。

当我们自定义 Report_SurveyModal_NoRace 的 __init__ 方法时，如果没有显式地调用父类 discord.ui.Modal 的 __init__ 方法，那么父类的初始化逻辑就不会被执行。结果是，Report_SurveyModal_NoRace 实例缺少了 discord.ui.Modal 期望存在的 custom_id 等核心属性，从而导致在框架尝试访问这些属性时抛出 AttributeError。

这在面向对象编程的继承机制中是一个常见问题，尤其是在处理框架提供的基类时。子类重写 __init__ 时，必须确保父类的初始化过程也得以执行。

稿定AI

拥有线稿上色优化、图片重绘、人物姿势检测、涂鸦完善等功能

查看详情

解决方案：调用 super().init()

解决此问题的关键在于，在子类的 __init__ 方法中显式地调用父类的 __init__ 方法。Python 提供了 super() 函数来实现这一点。super().__init__() 会调用当前类的直接父类的 __init__ 方法，确保父类的初始化逻辑被正确执行。

修改后的 Report_SurveyModal_NoRace 类应如下所示：

import discord

class Report_SurveyModal_NoRace(discord.ui.Modal, title='KRF1 Report'):
    # 文本输入组件
    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)

    def __init__(self, steward_flag: int):
        # 1. 首先调用父类的__init__方法，确保discord.ui.Modal被正确初始化
        super().__init__()
        # 2. 然后再处理子类特有的初始化逻辑，存储自定义参数
        self.steward_flag = steward_flag

    async def on_submit(self, interaction: discord.Interaction):
        # 在提交时使用自定义参数
        runde = ""
        # 假设 report_modal_submit_button 是一个处理函数
        await report_modal_submit_button(interaction, runde, self.was, self.media, self.steward_flag)

# 实际应用示例 (假设在一个 cog 或 bot 文件中)
# from discord.ext import commands

# class ServiceCenter(commands.Cog):
#     def __init__(self, bot):
#         self.bot = bot

#     @commands.command()
#     async def open_report(self, ctx: commands.Context, flag_value: int):
#         # 创建模态框实例，并传递自定义参数
#         modal = Report_SurveyModal_NoRace(flag_value)
#         # 发送模态框给用户
#         await ctx.send_modal(modal)

# 假设 report_modal_submit_button 函数定义如下
async def report_modal_submit_button(interaction: discord.Interaction, runde: str, was_input: discord.ui.TextInput, media_input: discord.ui.TextInput, steward_flag: int):
    """
    模拟模态框提交后的处理函数。
    """
    print(f"模态框提交成功！")
    print(f"发生了什么: {was_input.value}")
    print(f"媒体链接: {media_input.value if media_input.value else '无'}")
    print(f"Steward Flag: {steward_flag}")
    await interaction.response.send_message(f"报告已提交，Steward Flag 为 {steward_flag}。", ephemeral=True)

# 示例：如何在交互中发送这个模态框
async def example_send_modal_interaction(interaction: discord.Interaction, steward_flag_value: int):
    """
    在某个交互（如按钮点击）的回调中发送模态框。
    """
    modal = Report_SurveyModal_NoRace(steward_flag_value)
    await interaction.response.send_modal(modal)

# 注意：在实际的discord.py应用中，你需要一个bot实例来注册和运行这些组件。
# 上述代码片段旨在演示Modal的定义和使用方式。

登录后复制

在上述修正后的代码中，super().__init__() 的调用确保了 discord.ui.Modal 及其所有必要的内部属性（包括 custom_id）都被正确地初始化。之后，我们再安全地将自定义参数 steward_flag 赋值给实例变量 self.steward_flag。这样，在 on_submit 方法中，self.steward_flag 就可以被正确访问和使用了。

最佳实践与注意事项

继承初始化顺序： 无论何时，当你在一个子类中重写了 __init__ 方法，并且该子类继承自一个需要自身初始化逻辑的父类时，几乎总是需要调用 super().__init__()。这是确保继承链中所有父类都能正确设置其状态的关键。
参数传递： 如果父类的 __init__ 方法也接受参数，你需要将这些参数传递给 super().__init__(*args, **kwargs)。在 discord.ui.Modal 的情况下，它接受一个可选的 title 参数，我们通常在类定义时通过 discord.ui.Modal, title='KRF1 Report' 这样的方式传递，而不是在 __init__ 中。
调试技巧： 当遇到 AttributeError 时，首先检查是否正确调用了父类的 __init__ 方法。这通常是这类问题的常见原因。
框架文档： 查阅所用框架（如 discord.py 或 pycord）的官方文档，了解其基类对 __init__ 方法的期望和推荐用法，这能有效避免许多常见错误。

通过遵循这些最佳实践，可以确保在扩展 discord.py UI 组件时，能够正确地集成自定义逻辑，同时保持框架组件的正常功能。

以上就是在 discord.ui.Modal 中传递自定义参数的正确姿势的详细内容，更多请关注php中文网其它相关文章！