mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-04 08:56:19 +00:00
Code Issues Projects Releases Wiki Activity

[commands] Rework Cog + Group inheritance to requite GroupCog

Browse Source 
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.
This commit is contained in:
Rapptz
2022-05-01 13:39:44 -04:00
parent fedfe5bec2
commit f4c5d37c8f
4 changed files with 152 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
tests/test_app_commands_group.py
View File

@ -260,20 +260,22 @@ def test_cog_with_group_subclass_with_group_subclass():
def test_cog_group_with_commands():
class MyCog(commands.Cog, app_commands.Group):
class MyCog(commands.GroupCog):
@app_commands.command()
async def my_command(self, interaction: discord.Interaction) -> None:
...
cog = MyCog()
assert MyCog.__discord_app_commands_group_children__[0].parent is not cog
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.parent is None
assert cog.my_command.parent is cog
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.Cog, app_commands.Group):
class MyCog(commands.GroupCog):
sub_group = app_commands.Group(name='mysubgroup', description='My sub-group')
@sub_group.command()
@ -281,11 +283,13 @@ def test_cog_group_with_group():
...
cog = MyCog()
assert MyCog.__discord_app_commands_group_children__[0].parent is not cog
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.parent is None
assert cog.sub_group.parent is cog
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
@ -295,7 +299,7 @@ def test_cog_group_with_subclass_group():
async def my_command(self, interaction: discord.Interaction) -> None:
...
class MyCog(commands.Cog, app_commands.Group):
class MyCog(commands.GroupCog):
sub_group = MyGroup()
@sub_group.command()
@ -303,14 +307,16 @@ def test_cog_group_with_subclass_group():
...
cog = MyCog()
assert MyCog.__discord_app_commands_group_children__[0].parent is not cog
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.parent is None
assert cog.sub_group.parent is cog
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
@ -325,7 +331,7 @@ def test_cog_group_with_subclassed_subclass_group():
class MySubclassedGroup(MyGroup, name='mygroup'):
...
class MyCog(commands.Cog, app_commands.Group):
class MyCog(commands.GroupCog):
sub_group = MySubclassedGroup()
@sub_group.command()
@ -333,7 +339,8 @@ def test_cog_group_with_subclassed_subclass_group():
...
cog = MyCog()
assert MyCog.__discord_app_commands_group_children__[0].parent is not cog
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
@ -341,8 +348,9 @@ def test_cog_group_with_subclassed_subclass_group():
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.parent is None
assert cog.sub_group.parent is cog
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