`interaction_check` and friends aren't typed as `Coroutine[Any, Any, bool]`

[longnguyen2004]

Summary

The function interaction_check and other related functions in Cog aren't typed as Coroutine[Any, Any, bool], preventing them from being async functions

Reproduction Steps

See example code

Minimal Reproducible Code

class Admin(commands.GroupCog):
    # this errors
    async def interaction_check(self, interaction: Interaction) -> bool:
        return True

Expected Results

No type error occurs

Actual Results

Type error occurs: Class member `Admin.interaction_check` overrides parent class `GroupCog` in an inconsistent manner

Intents

discord.Intents.default()

System Information

• Python v3.13.1-final
• discord.py v2.6.4-final
• aiohttp v3.13.1
• system info: Windows 11 10.0.26100

Checklist

• I have searched the open issues for duplicates.
• I have shown the entire traceback, if possible.
• I have removed my token from display, if visible.

Additional Context

No response

[Rapptz]

As far as I know it's not possible to type the optionality of coroutines in inherited methods like this, so I suggest turning off the incompatible override lint since it'll be wrong with discord.py more often than not unfortunately.

[longnguyen2004]

I saw a MaybeAwaitable[T] defined here, would using that work in this case?

def interaction_check(self, interaction) -> MaybeAwaitable[bool]

[Rapptz]

Not for methods

[mikeshardmind]

This one's actually possible to have Pyright check accurately, but the way to do it is obtuse, and it's unclear if this is even intended or "accidentally working", as this isn't covered by the specification. mypy and pyright do both accept it.

Code sample in pyright playground

from collections.abc import Callable, Coroutine
from typing import ClassVar, Self


class Interaction:
    ...


class Base:

    interaction_check: ClassVar[Callable[[Self, Interaction], bool | Coroutine[None, None, bool]]]

    def __interaction_check(self, i: Interaction, /) -> bool:
        ...

    interaction_check = __interaction_check


class A(Base):

    def interaction_check(self, i: Interaction, /) -> bool:
        ...


class B(Base):

    async def interaction_check(self, i: Interaction, /) -> bool:
        ...

[longnguyen2004]

I still don't see why specifying the return type as bool | Awaitable[bool] wouldn't work, but maybe I'm missing something else
pyright, mypy, pyrefly

[mikeshardmind]

Well, that's interesting. Last time that came up, typecheckers weren't accepting that form of it. Not sure if it will cause any other problems off the top of my head.

[Rapptz]

We're pretty much at the random whims of the type checker authors whether things work or not. There's a reason why this stuff is pinned locally, because every week something would break due to how a lot of the stuff we do has no actual consistent behaviour. This one is a good example of something that used to expressively fail but now no longer does. We also have examples of things that used to work and were supported and then on the whims of the author no longer do (e.g. try/except with TypedDict).

Anyway I'll reopen this and tackle it but I would not be surprised if this breaks again in the future