sub_command decorator is not properly preserving the instance (i.e., self) when it's being called | disnake | Page 1

jovial pumice Jul 7, 2023, 4:30 PM

#

@commands.slash_command(dm_permission=False, admin_permission=True)
    async def source(self, inter):
        await inter.response.defer(ephemeral=True)
        if not inter.author.guild_permissions.administrator:
            return await inter.followup.send('You must be an administrator to use this command.', ephemeral=True)
        guild = await self.guilds_db.find_one({'_id': str(inter.guild.id)})
        if not guild:
            return await inter.followup.send('You must `/configure` your server first.', ephemeral=True)
        inter.guild_object = guild
        print("source", self) #working

    @source.sub_command_group()
    async def channel(self, inter):
        print("channel", self) #working
        pass

    @channel.sub_command()
    async def list(self, inter):
        """
        List all source channels.
        Parameters
        ----------
        inter: necessary for bot commands
        """
        print("list", self) #None
        guild = inter.guild_object
        index_embed = disnake.Embed(
            title='**Source Channels**', description="", color=self.color)
        channels = []
        for channel_id in guild['channels']:
            channel = self.bot.get_channel(int(channel_id))
            if channel:
                channels.append(channel.mention)
        if len(channels) > 0:
            index_embed.description = "\n".join(channels)
        else:
            index_embed.description = "None."
        await inter.followup.send(embed=index_embed)

silk juniper Jul 7, 2023, 4:39 PM

#

admin_permission is not a valid kwarg for slash command.

#

Use commands.has_permissions(administrator=True)

#

Also, source is a parent command. It is called every single time. So, typically you do not want to have any responses here.

#

self is the cog instance. Not sure what you're actually trying to do here.

dusty elk Jul 7, 2023, 4:50 PM

#

also, can't reproduce it - what version are you using?

#

simplified, but works fine on my end:

    @commands.slash_command()
    async def source(self, inter):
        print("source", self)

    @source.sub_command_group()
    async def channel(self, inter):
        print("channel", self)

    @channel.sub_command()
    async def list(self, inter):
        print("list", self)

2023-07-07 18:49:57,358: [DEBUG] (MainThread) disnake.client: Dispatching event slash_command
source <test_bot.cogs.misc.Misc object at 0x7f9c927089d0>
channel <test_bot.cogs.misc.Misc object at 0x7f9c927089d0>
list <test_bot.cogs.misc.Misc object at 0x7f9c927089d0>

jovial pumice Jul 7, 2023, 7:44 PM

#

dusty elk simplified, but works fine on my end: ```py @commands.slash_command() as...

without the logic, this part works on my end as well. my goal is to have a high level check for anyone running /source related commands. would it be preferable to have checks within the sub_command instead?

#

cc: @silk juniper

#

hm i think the issue is the name being list()

silk juniper Jul 7, 2023, 7:51 PM

#

You could move the checks to a cog_slash_command_check and cog_slash_command_error handler

#

But yeah, you shouldn't use reserved python keywords for naming objects.

jovial pumice Jul 7, 2023, 7:59 PM

#

Yup, changed list() to show and it works now

#

thank you

dusty elk Jul 7, 2023, 8:02 PM

#

hmm, not quite sure why that did it, but if it works it works tHONK

#

in any case, you can use @channel.sub_command(name="list") to keep it as "list" on Discord and name your method whatever you want c:

jovial pumice Jul 7, 2023, 8:19 PM

#

nevermind, show is still messing it up

#

    @commands.slash_command(dm_permission=False)
    @commands.default_member_permissions(administrator=True)
    async def source(self, inter):
        pass

    @source.sub_command_group()
    async def channel(self, inter):
        print("channel", self)
        pass

    @channel.sub_command()
    async def show(self, inter):
        """
        Show all source channels.
        """
        print("show", self)
        await inter.response.defer(ephemeral=True)
        guild = await self.guilds_db.find_one({'_id': str(inter.guild.id)})
        if not guild:
            return await inter.followup.send('You must `/configure` your server first.', ephemeral=True)
        index_embed = disnake.Embed(
            title='**Source Channels**', description="", color=self.color)
        channels = []
        for channel_id in guild['channels']:
            channel = self.bot.get_channel(int(channel_id))
            if channel:
                channels.append(channel.mention)
        if len(channels) > 0:
            index_embed.description = "\n".join(channels)
        else:
            index_embed.description = "None."
        await inter.followup.send(embed=index_embed)

jovial pumice Jul 7, 2023, 8:19 PM

#

dusty elk hmm, not quite sure why that did it, but if it works it works <:tHONK:6982062331...

worked for a little broke again

#

only way I'm getting around is:

source()
inter.self = self

show()
self = inter.self

silk juniper Jul 7, 2023, 8:23 PM

#

I still have no idea what it is you're trying to do.

jovial pumice Jul 7, 2023, 8:26 PM

#

silk juniper I still have no idea what it is you're trying to do.

just adding and displaying items to and from database

#

guilds_db is the database

#

i could send the entire file if you'd like

silk juniper Jul 7, 2023, 8:30 PM

#

I get that, but I don't understand the involvement of self

#

thew inter.self part is what is confusing me.

jovial pumice Jul 7, 2023, 8:32 PM

#

class Core(commands.Cog):
    def __init__(self, bot) -> None:
        self.bot = bot
        self.color = 0xEBE1DB
        self.guilds_db = MongoDB('Clarify', 'guilds')

#

this is my class @silk juniper

silk juniper Jul 7, 2023, 8:32 PM

#

I see.

jovial pumice Jul 7, 2023, 8:32 PM

#

I need to access self.guilds_db and self.bot

silk juniper Jul 7, 2023, 8:32 PM

#

Right.

jovial pumice Jul 7, 2023, 8:33 PM

#

#

I did, but its None

silk juniper Jul 7, 2023, 8:33 PM

#

That's just odd.

jovial pumice Jul 7, 2023, 8:34 PM

#

Yeah and for some reason, the other command group, url, works

#

silk juniper Jul 7, 2023, 8:39 PM

#

Yeah, this is an odd one.

#

It worked when you simplified the commands, though?

jovial pumice Jul 7, 2023, 8:39 PM

#

and i'm printing self before everything else so even if there's an error, i should be notified

jovial pumice Jul 7, 2023, 8:40 PM

#

silk juniper It worked when you simplified the commands, though?

let me check again

#

    @commands.slash_command(dm_permission=False)
    @commands.default_member_permissions(administrator=True)
    async def source(self, inter):
        print("source", self)
        inter.self = self
        pass

    @source.sub_command_group()
    async def channel(self, inter):
        print("channel", self)
        pass

    @channel.sub_command()
    async def show(self, inter):
        """
        Show all source channels.
        """
        print("show", self)
        # self = inter.self
        # await inter.response.defer(ephemeral=True)
        # guild = await self.guilds_db.find_one({'_id': str(inter.guild.id)})
        # if not guild:
        #     return await inter.followup.send('You must `/configure` your server first.', ephemeral=True)
        # index_embed = disnake.Embed(
        #     title='**Source Channels**', description="", color=self.color)
        # channels = []
        # for channel_id in guild['channels']:
        #     channel = self.bot.get_channel(int(channel_id))
        #     if channel:
        #         channels.append(channel.mention)
        # if len(channels) > 0:
        #     index_embed.description = "\n".join(channels)
        # else:
        #     index_embed.description = "None."
        # await inter.followup.send(embed=index_embed)

still printing None

silk juniper Jul 7, 2023, 8:43 PM

#

Yeah, that is super weird.

source <__main__.Cog object at 0x000002B8DB6BED90>
channel <__main__.Cog object at 0x000002B8DB6BED90>
show <__main__.Cog object at 0x000002B8DB6BED90>

#

What disnake version?

#

I think that was asked already, though

jovial pumice Jul 7, 2023, 8:43 PM

#

@commands.slash_command(dm_permission=False)
    @commands.default_member_permissions(administrator=True)
    async def source(self, inter):
        print("source", self)
        inter.self = self
        pass

    @source.sub_command_group()
    async def channel(self, inter):
        print("channel", self)
        pass

    @channel.sub_command()
    async def test(self, inter):
        print("test", self)
        pass

    @channel.sub_command()
    async def show(self, inter):
        """
        Show all source channels.
        """
        print("show", self)
        # self = inter.self
        # await inter.response.defer(ephemeral=True)
        # guild = await self.guilds_db.find_one({'_id': str(inter.guild.id)})
        # if not guild:
        #     return await inter.followup.send('You must `/configure` your server first.', ephemeral=True)
        # index_embed = disnake.Embed(
        #     title='**Source Channels**', description="", color=self.color)
        # channels = []
        # for channel_id in guild['channels']:
        #     channel = self.bot.get_channel(int(channel_id))
        #     if channel:
        #         channels.append(channel.mention)
        # if len(channels) > 0:
        #     index_embed.description = "\n".join(channels)
        # else:
        #     index_embed.description = "None."
        # await inter.followup.send(embed=index_embed)

adding new subcommand, test, works

#

disnake==2.9.0

#

changed the name= parameter and it fixed it, will keep testing and let you know if it breaks

silk juniper Jul 7, 2023, 9:14 PM

#

It almost seems like it's a sync issue. You make a change, the command resyncs and it works, until something breaks it.

#

Because it worked temporarily after the last change which would have forced a resync.

coarse dirge Jul 8, 2023, 1:33 AM

#

It looks to me like they had something in the class namespace of the same name as the function

#

If you remember, methods are wrapped in descriptors, and descriptors outside classes receive None as the instance, which is then passed as self to the function

coarse dirge Jul 8, 2023, 1:36 AM

#

coarse dirge It looks to me like they had something in the class namespace of the same name a...

Which results in disnake holding a reference to the function but the class itself doesn't since it's overwritten

final ore Jul 8, 2023, 12:01 PM

#

coarse dirge It looks to me like they had something in the class namespace of the same name a...

I think this is the issue, having multiple methods with same name, which is why changing function name and adding the name parameter worked

#sub_command decorator is not properly preserving the instance (i.e., self) when it's being called