Discord.py 按钮交互中的参数错误及正确处理策略-Python教程-PHP中文网

Discord.py 按钮交互中的参数错误及正确处理策略

本文旨在解决discord.py中按钮交互时常见的“interaction error”，该错误通常由按钮回调函数签名不正确导致。我们将深入分析错误原因，提供正确的按钮回调函数定义方式，并介绍如何在按钮回调中安全有效地获取和使用命令发起时传递的额外数据，避免直接将额外参数加入回调签名，同时给出完整的示例代码和最佳实践。

Discord.py 按钮交互概述

Discord.py 2.0+ 版本引入了强大的UI组件支持，包括按钮（Buttons），极大地增强了机器人与用户交互的能力。按钮允许用户通过点击界面上的元素来触发特定操作，而无需输入命令，从而提升用户体验。

一个典型的按钮交互流程如下：

机器人发送一个包含按钮的消息。
用户点击按钮。
Discord向机器人发送一个交互事件（Interaction）。
机器人根据预定义的按钮回调函数处理该交互。

常见按钮交互错误分析

在实现按钮功能时，开发者常会遇到“interaction error”，这通常是由于按钮回调函数的签名（参数列表）不符合Discord.py的预期造成的。

考虑以下一个模拟求婚系统的示例代码，其中按钮回调函数试图直接接收一个 user: discord.Member 参数：

import discord
from discord.ext import commands

# 假设client已初始化
# client = commands.Bot(command_prefix='!', intents=discord.Intents.all())

class MarryButtons(discord.ui.View):
    def __init__(self):
        super().__init__()

    @discord.ui.button(label="Yes", style=discord.ButtonStyle.success)
    async def agree_btn(self, interaction: discord.Interaction, button: discord.ui.Button, user: discord.Member):
        # 错误示例：尝试直接在回调中接收 user 参数
        embed_agree = discord.Embed(title=f'{user.mention} answered YES', description=f'{user.mention} now married to {interaction.user.mention}')
        await interaction.response.send_message(embed=embed_agree)

    @discord.ui.button(label="No", style=discord.ButtonStyle.danger)
    async def disagree_btn(self, interaction: discord.Interaction, button: discord.ui.Button, user: discord.Member):
        # 错误示例：尝试直接在回调中接收 user 参数
        embed_disagree = discord.Embed(title=f'{user.mention} answered NO', description=f'{user.mention} declined propose from {interaction.user.mention}')
        await interaction.response.send_message(embed=embed_disagree)

    @discord.ui.button(label="?", style=discord.ButtonStyle.gray)
    async def emoji_btn(self, interaction: discord.Interaction, button: discord.ui.Button, user: discord.Member):
        # 错误示例：尝试直接在回调中接收 user 参数
        embed_emoji = discord.Embed(title=f'{user.mention} canceled propose', description=f'Nothing changed')
        await interaction.response.send_message(embed=embed_emoji)

# 假设这是一个斜杠命令
# @client.tree.command(name='marry', description="Suggest to marry")
# async def marry(interaction: discord.Interaction, user: discord.Member):
#     if interaction.user == user:
#         await interaction.response.send_message(content=f"{interaction.user.mention} you can`t marry yourself :(")
#         return
#     else:
#         embed_marry = discord.Embed(title='WOW.....', description=f'{interaction.user.mention} suggest a marry to {user.mention}', color=0x774dea)
#         await interaction.response.send_message(embed=embed_marry, view=MarryButtons())

登录后复制

当用户点击上述代码中的按钮时，Discord会返回一个“interaction error”。这是因为 discord.ui.button 装饰器期望其装饰的异步方法具有固定的签名：async def callback(self, interaction: discord.Interaction, button: discord.ui.Button):。任何额外的参数，如示例中的 user: discord.Member，都会导致Discord.py无法正确调用该方法，从而触发交互错误。

核心原因： 按钮回调函数是Discord.py框架内部调用的，它只负责传递 self (视图实例)、interaction (交互对象) 和 button (被点击的按钮对象) 这三个参数。开发者不能随意添加额外的参数到函数签名中。

正确处理按钮交互回调

要解决上述问题，只需移除按钮回调函数中不符合预期的额外参数。正确的按钮回调函数签名应只包含 self、interaction 和 button。

绘蛙AI修图

绘蛙平台AI修图工具，支持手脚修复、商品重绘、AI扩图、AI换色

279

查看详情

import discord
from discord.ext import commands

class MarryButtonsCorrect(discord.ui.View):
    def __init__(self):
        super().__init__()

    @discord.ui.button(label="Yes", style=discord.ButtonStyle.success)
    async def agree_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 正确示例：只接收 self, interaction, button
        # await interaction.response.send_message(content="你点击了Yes！") # 此时无法直接获取到 target_user
        pass

    @discord.ui.button(label="No", style=discord.ButtonStyle.danger)
    async def disagree_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 正确示例：只接收 self, interaction, button
        # await interaction.response.send_message(content="你点击了No！")
        pass

    @discord.ui.button(label="?", style=discord.ButtonStyle.gray)
    async def emoji_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 正确示例：只接收 self, interaction, button
        # await interaction.response.send_message(content="你点击了？")
        pass

登录后复制

虽然这样解决了交互错误，但新的问题是，如何在按钮回调中获取到 marry 命令中传递的 user (被求婚者) 信息呢？interaction 对象只提供了点击按钮的用户 (interaction.user)，而没有命令发起时指定的 user。

在按钮回调中获取额外数据

为了在按钮回调中访问命令发起时传递的额外数据（如 marry 命令中的 target_user），我们需要将这些数据存储在 discord.ui.View 实例中，并在初始化时传递。

方法一：通过 View 的初始化传递数据（推荐）

这是最常见且推荐的方法。通过在 View 类的 __init__ 方法中接收并存储所需数据，按钮回调函数就可以通过 self 访问这些数据。

修改 MarryButtons 类的 __init__ 方法，使其接收命令发起者和被求婚者作为参数。
在 __init__ 中将这些参数存储为实例变量。
在按钮回调函数中通过 self.变量名访问这些数据。
在斜杠命令中创建 MarryButtons 实例时，传入相应的数据。

import discord
from discord.ext import commands

# 假设client已初始化
# client = commands.Bot(command_prefix='!', intents=discord.Intents.all())

class MarryButtonsWithData(discord.ui.View):
    def __init__(self, proposer: discord.Member, target_user: discord.Member):
        super().__init__(timeout=180) # 设置超时时间，例如180秒
        self.proposer = proposer
        self.target_user = target_user

    @discord.ui.button(label="Yes", style=discord.ButtonStyle.success)
    async def agree_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 确保只有被求婚者才能点击
        if interaction.user != self.target_user:
            await interaction.response.send_message("你不是被求婚者，无法点击此按钮。", ephemeral=True)
            return

        embed_agree = discord.Embed(
            title=f'{self.target_user.mention} 接受了求婚！',
            description=f'{self.target_user.mention} 现在与 {self.proposer.mention} 结婚了！',
            color=discord.Color.green()
        )
        await interaction.response.edit_message(embed=embed_agree, view=None) # 移除按钮
        self.stop() # 停止View，防止其他按钮被点击

    @discord.ui.button(label="No", style=discord.ButtonStyle.danger)
    async def disagree_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 确保只有被求婚者才能点击
        if interaction.user != self.target_user:
            await interaction.response.send_message("你不是被求婚者，无法点击此按钮。", ephemeral=True)
            return

        embed_disagree = discord.Embed(
            title=f'{self.target_user.mention} 拒绝了求婚。',
            description=f'{self.target_user.mention} 拒绝了来自 {self.proposer.mention} 的求婚。',
            color=discord.Color.red()
        )
        await interaction.response.edit_message(embed=embed_disagree, view=None) # 移除按钮
        self.stop() # 停止View

    @discord.ui.button(label="?", style=discord.ButtonStyle.gray)
    async def emoji_btn(self, interaction: discord.Interaction, button: discord.ui.Button):
        # 任何人都可以取消，但通常我们会限制为发起者或被求婚者
        if interaction.user not in [self.proposer, self.target_user]:
            await interaction.response.send_message("你无权取消此求婚。", ephemeral=True)
            return

        embed_emoji = discord.Embed(
            title=f'{interaction.user.mention} 取消了求婚。',
            description=f'求婚请求已被取消，一切如初。',
            color=discord.Color.light_gray()
        )
        await interaction.response.edit_message(embed=embed_emoji, view=None) # 移除按钮
        self.stop() # 停止View

# 完整示例：斜杠命令与按钮交互
# 注意：此处的client和tree需要根据你的实际机器人初始化方式进行配置
# client = commands.Bot(command_prefix='!', intents=discord.Intents.all())
# tree = discord.app_commands.CommandTree(client)

# @tree.command(name='marry', description="向某人求婚")
# async def marry(interaction: discord.Interaction, user: discord.Member):
#     if interaction.user == user:
#         await interaction.response.send_message(content=f"{interaction.user.mention} 你不能向自己求婚 :(", ephemeral=True)
#         return
#     
#     embed_marry = discord.Embed(
#         title='天呐！求婚啦！',
#         description=f'{interaction.user.mention} 向 {user.mention} 求婚了！',
#         color=0x774dea
#     )
#     # 创建View实例时传入发起者和被求婚者
#     await interaction.response.send_message(embed=embed_marry, view=MarryButtonsWithData(interaction.user, user))

# # 在机器人启动时同步斜杠命令
# @client.event
# async def on_ready():
#     print(f'Logged in as {client.user}')
#     # await tree.sync() # 仅在需要时同步命令
#     print('Commands synced.')

登录后复制

方法二：使用持久化数据存储（适用于复杂场景）

对于更复杂的场景，例如需要跨多个交互甚至跨机器人重启来维护状态，或者当 View 实例被销毁后仍需访问数据时，可以考虑使用数据库（如SQLite, PostgreSQL, MongoDB）或JSON文件进行数据持久化。

在命令中生成一个唯一的交互ID（例如，使用 uuid 库）。
将相关数据（如发起者ID、被求婚者ID、状态等）与此ID一同存储到数据库或JSON文件中。
将此唯一ID作为 custom_id 传递给按钮，或作为 View 的初始化参数。
在按钮回调中，通过 interaction.data['custom_id'] 或 self.unique_id 获取该ID。
使用该ID从持久化存储中检索所需数据。

这种方法增加了复杂性，但提供了极高的灵活性和持久性。

注意事项与最佳实践

交互令牌有效期： Discord交互令牌通常只有几秒的有效期。所有对 interaction.response 的操作必须在短时间内完成，否则会报“Unknown Interaction”错误。如果需要执行耗时操作，应先使用 defer() 方法延迟响应。
并发处理： 避免在 View 中使用全局变量来存储特定于交互的数据，因为这会导致多个用户同时使用时数据混淆。始终将交互相关数据作为 View 实例的属性进行存储。
超时机制： 为 discord.ui.View 设置一个 timeout 参数（例如 super().__init__(timeout=180)），以在一定时间后自动禁用按钮并清理资源。当 View 超时时，会触发 on_timeout 方法。
移除按钮： 在用户完成交互（例如点击“Yes”或“No”）后，通常应通过 await interaction.response.edit_message(view=None) 移除消息中的按钮，防止用户重复点击或产生歧义。
权限检查： 在按钮回调中，务必检查 interaction.user 是否有权限执行该操作，以防止非目标用户干扰交互。
错误处理： 使用 try-except 块来捕获可能发生的异常，例如数据库操作失败或网络问题，提高程序的健壮性。

总结

解决 Discord.py 按钮交互中的“interaction error”关键在于理解并遵守按钮回调函数的固定签名：async def callback(self, interaction: discord.Interaction, button: discord.ui.Button):。当需要在回调中访问命令发起时传递的额外数据时，应将这些数据通过 View 的 __init__ 方法传递并存储为实例属性。对于更复杂的持久化需求，可以考虑结合数据库等存储方案。遵循这些最佳实践，可以构建出健壮、用户友好的 Discord 机器人交互界面。

以上就是Discord.py 按钮交互中的参数错误及正确处理策略的详细内容，更多请关注php中文网其它相关文章！