mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-04-21 08:17:47 +00:00
f4c5d37c8f
This is an attempt to fix the MRO issues present in the current implementation. The previous implementation of using both Cog and app_commands.Group in the inheritance chain caused issues with things such as walk_commands due to it potentially shadowing the app_commands version of the call. In this particular case it's better to use composition instead of inheritance to avoid these bugs entirely. Especially as more things are added that could conflict with each other.
357 lines
14 KiB
Python
357 lines
14 KiB
Python
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-present Rapptz
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a
|
|
copy of this software and associated documentation files (the "Software"),
|
|
to deal in the Software without restriction, including without limitation
|
|
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
and/or sell copies of the Software, and to permit persons to whom the
|
|
Software is furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
DEALINGS IN THE SOFTWARE.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from discord import app_commands
|
|
import discord
|
|
from discord.ext import commands
|
|
|
|
|
|
def test_group_with_commands():
|
|
my_group = app_commands.Group(name='mygroup', description='My group')
|
|
|
|
@my_group.command()
|
|
async def my_command(interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
assert my_command.binding is None
|
|
assert my_command.parent is my_group
|
|
assert my_group.commands[0] is my_command
|
|
|
|
|
|
def test_group_subclass_with_commands():
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
my_group = MyGroup()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not my_group
|
|
assert my_group.my_command is not MyGroup.my_command
|
|
assert my_group.my_command.parent is my_group
|
|
|
|
|
|
def test_group_subclass_with_group():
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
sub_group = app_commands.Group(name='mysubgroup', description='My sub-group')
|
|
|
|
@sub_group.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
my_group = MyGroup()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not my_group
|
|
assert MyGroup.sub_group.parent is None
|
|
assert MyGroup.my_command.parent is MyGroup.sub_group
|
|
assert my_group.sub_group is not MyGroup.sub_group
|
|
assert my_group.my_command is not MyGroup.my_command
|
|
assert my_group.sub_group.parent is my_group
|
|
assert my_group.my_command.parent is my_group.sub_group
|
|
assert my_group.my_command.binding is my_group
|
|
|
|
|
|
def test_group_subclass_with_group_subclass():
|
|
class MySubGroup(app_commands.Group, name='mysubgroup'):
|
|
@app_commands.command()
|
|
async def my_sub_group_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
sub_group = MySubGroup()
|
|
|
|
@app_commands.command()
|
|
async def my_group_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
my_group = MyGroup()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not my_group
|
|
assert MySubGroup.__discord_app_commands_group_children__[0].parent is not my_group.sub_group
|
|
assert my_group.sub_group is not MyGroup.sub_group
|
|
assert my_group.my_group_command is not MyGroup.my_group_command
|
|
assert my_group.sub_group.my_sub_group_command is not MySubGroup.my_sub_group_command
|
|
assert my_group.sub_group.parent is my_group
|
|
assert my_group.my_group_command.parent is my_group
|
|
assert my_group.my_group_command.binding is my_group
|
|
assert my_group.sub_group.my_sub_group_command.parent is my_group.sub_group
|
|
assert not hasattr(my_group, 'my_sub_group_command')
|
|
assert my_group.sub_group.my_sub_group_command.binding is my_group.sub_group
|
|
|
|
|
|
def test_cog_with_commands():
|
|
class MyCog(commands.Cog):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert cog.my_command.parent is None
|
|
assert cog.my_command.binding is cog
|
|
|
|
|
|
def test_cog_with_group_with_commands():
|
|
class MyCog(commands.Cog):
|
|
my_group = app_commands.Group(name='mygroup', description='My group')
|
|
|
|
@my_group.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert cog.my_group is not MyCog.my_group
|
|
assert cog.my_command is not MyCog.my_command
|
|
assert cog.my_group.parent is None
|
|
assert cog.my_command.parent is cog.my_group
|
|
assert cog.my_command.binding is cog
|
|
|
|
|
|
def test_cog_with_nested_group_with_commands():
|
|
class MyCog(commands.Cog):
|
|
first = app_commands.Group(name='test', description='Test 1')
|
|
second = app_commands.Group(name='test2', parent=first, description='Test 2')
|
|
|
|
@first.command(name='cmd')
|
|
async def test_cmd(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
@second.command(name='cmd2')
|
|
async def test2_cmd(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
|
|
assert len(MyCog.__cog_app_commands__) == 1
|
|
assert cog.first.parent is None
|
|
assert cog.first is not MyCog.first
|
|
assert cog.second is not MyCog.second
|
|
assert cog.second.parent is cog.first
|
|
assert cog.test_cmd.parent is cog.first
|
|
assert cog.test2_cmd.parent is cog.second
|
|
assert cog.test_cmd.binding is cog
|
|
assert cog.test2_cmd.binding is cog
|
|
|
|
|
|
def test_cog_with_group_subclass_with_commands():
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyCog(commands.Cog):
|
|
my_group = MyGroup()
|
|
|
|
@my_group.command()
|
|
async def my_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not cog.my_group
|
|
assert cog.my_group is not MyCog.my_group
|
|
assert cog.my_group.my_command is not MyGroup.my_command
|
|
assert cog.my_cog_command is not MyCog.my_cog_command
|
|
assert not hasattr(cog.my_group, 'my_cog_command')
|
|
assert cog.my_group.parent is None
|
|
assert cog.my_group.my_command.parent is cog.my_group
|
|
assert cog.my_group.my_command.binding is cog.my_group
|
|
assert cog.my_cog_command.parent is cog.my_group
|
|
assert cog.my_cog_command.binding is cog
|
|
|
|
|
|
def test_cog_with_group_subclass_with_group():
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
sub_group = app_commands.Group(name='mysubgroup', description='My sub-group')
|
|
|
|
@sub_group.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyCog(commands.Cog):
|
|
my_group = MyGroup()
|
|
|
|
@my_group.command()
|
|
async def my_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not cog.my_group
|
|
assert cog.my_group is not MyCog.my_group
|
|
assert cog.my_group.sub_group is not MyGroup.sub_group
|
|
assert cog.my_group.my_command is not MyGroup.my_command
|
|
assert cog.my_cog_command is not MyCog.my_cog_command
|
|
assert not hasattr(cog.my_group, 'my_cog_command')
|
|
assert not hasattr(cog, 'sub_group')
|
|
assert not hasattr(cog, 'my_command')
|
|
assert cog.my_group.parent is None
|
|
assert cog.my_group.sub_group.parent is cog.my_group
|
|
assert cog.my_group.my_command.parent is cog.my_group.sub_group
|
|
assert cog.my_group.my_command.binding is cog.my_group
|
|
assert cog.my_cog_command.parent is cog.my_group
|
|
assert cog.my_cog_command.binding is cog
|
|
|
|
|
|
def test_cog_with_group_subclass_with_group_subclass():
|
|
class MySubGroup(app_commands.Group, name='mysubgroup'):
|
|
@app_commands.command()
|
|
async def my_sub_group_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
sub_group = MySubGroup()
|
|
|
|
@app_commands.command()
|
|
async def my_group_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyCog(commands.Cog):
|
|
my_group = MyGroup()
|
|
|
|
@my_group.command()
|
|
async def my_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
@my_group.sub_group.command()
|
|
async def my_sub_group_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not cog.my_group
|
|
assert MySubGroup.__discord_app_commands_group_children__[0].parent is not cog.my_group.sub_group
|
|
assert cog.my_group is not MyCog.my_group
|
|
assert cog.my_group.my_group_command is not MyCog.my_group.my_group_command
|
|
assert cog.my_group.sub_group is not MyGroup.sub_group
|
|
assert cog.my_cog_command is not MyCog.my_cog_command
|
|
assert not hasattr(cog.my_group, 'my_cog_command')
|
|
assert not hasattr(cog, 'sub_group')
|
|
assert not hasattr(cog, 'my_group_command')
|
|
assert not hasattr(cog, 'my_sub_group_command')
|
|
assert not hasattr(cog.my_group, 'my_sub_group_command')
|
|
assert cog.my_group.sub_group.my_sub_group_command is not MyGroup.sub_group.my_sub_group_command
|
|
assert cog.my_group.sub_group.my_sub_group_command is not MySubGroup.my_sub_group_command
|
|
assert cog.my_group.sub_group.parent is cog.my_group
|
|
assert cog.my_group.my_group_command.parent is cog.my_group
|
|
assert cog.my_group.my_group_command.binding is cog.my_group
|
|
assert cog.my_group.sub_group.my_sub_group_command.parent is cog.my_group.sub_group
|
|
assert cog.my_group.sub_group.my_sub_group_command.binding is cog.my_group.sub_group
|
|
assert cog.my_cog_command.parent is cog.my_group
|
|
assert cog.my_cog_command.binding is cog
|
|
assert cog.my_sub_group_cog_command.parent is cog.my_group.sub_group
|
|
assert cog.my_sub_group_cog_command.binding is cog
|
|
|
|
|
|
def test_cog_group_with_commands():
|
|
class MyCog(commands.GroupCog):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog.__cog_app_commands_group__
|
|
assert cog.my_command is not MyCog.my_command
|
|
assert cog.__cog_app_commands_group__ is not None
|
|
assert cog.__cog_app_commands_group__.parent is None
|
|
assert cog.my_command.parent is cog.__cog_app_commands_group__
|
|
|
|
|
|
def test_cog_group_with_group():
|
|
class MyCog(commands.GroupCog):
|
|
sub_group = app_commands.Group(name='mysubgroup', description='My sub-group')
|
|
|
|
@sub_group.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog.__cog_app_commands_group__
|
|
assert cog.sub_group is not MyCog.sub_group
|
|
assert cog.my_command is not MyCog.my_command
|
|
assert cog.__cog_app_commands_group__ is not None
|
|
assert cog.__cog_app_commands_group__.parent is None
|
|
assert cog.sub_group.parent is cog.__cog_app_commands_group__
|
|
assert cog.my_command.parent is cog.sub_group
|
|
|
|
|
|
def test_cog_group_with_subclass_group():
|
|
class MyGroup(app_commands.Group, name='mygroup'):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MyCog(commands.GroupCog):
|
|
sub_group = MyGroup()
|
|
|
|
@sub_group.command()
|
|
async def my_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog.__cog_app_commands_group__
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not cog.sub_group
|
|
assert cog.sub_group is not MyCog.sub_group
|
|
assert cog.sub_group.my_command is not MyGroup.my_command
|
|
assert cog.my_cog_command is not MyCog.my_cog_command
|
|
assert not hasattr(cog.sub_group, 'my_cog_command')
|
|
assert cog.__cog_app_commands_group__ is not None
|
|
assert cog.__cog_app_commands_group__.parent is None
|
|
assert cog.sub_group.parent is cog.__cog_app_commands_group__
|
|
assert cog.sub_group.my_command.parent is cog.sub_group
|
|
assert cog.my_cog_command.parent is cog.sub_group
|
|
assert cog.my_cog_command.binding is cog
|
|
|
|
|
|
def test_cog_group_with_subclassed_subclass_group():
|
|
class MyGroup(app_commands.Group):
|
|
@app_commands.command()
|
|
async def my_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
class MySubclassedGroup(MyGroup, name='mygroup'):
|
|
...
|
|
|
|
class MyCog(commands.GroupCog):
|
|
sub_group = MySubclassedGroup()
|
|
|
|
@sub_group.command()
|
|
async def my_cog_command(self, interaction: discord.Interaction) -> None:
|
|
...
|
|
|
|
cog = MyCog()
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog
|
|
assert MyCog.__cog_app_commands__[0].parent is not cog.__cog_app_commands_group__
|
|
assert MyGroup.__discord_app_commands_group_children__[0].parent is not cog.sub_group
|
|
assert MySubclassedGroup.__discord_app_commands_group_children__[0].parent is not cog.sub_group
|
|
assert cog.sub_group is not MyCog.sub_group
|
|
assert cog.sub_group.my_command is not MyGroup.my_command
|
|
assert cog.sub_group.my_command is not MySubclassedGroup.my_command
|
|
assert cog.my_cog_command is not MyCog.my_cog_command
|
|
assert not hasattr(cog.sub_group, 'my_cog_command')
|
|
assert cog.__cog_app_commands_group__ is not None
|
|
assert cog.__cog_app_commands_group__.parent is None
|
|
assert cog.sub_group.parent is cog.__cog_app_commands_group__
|
|
assert cog.sub_group.my_command.parent is cog.sub_group
|
|
assert cog.my_cog_command.parent is cog.sub_group
|
|
assert cog.my_cog_command.binding is cog
|