mirror
/
Rapptz.discord.py
mirror of https://github.com/Rapptz/discord.py
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

[commands] Fix type hints for checks, hooks, and error handlers

pull/7885/head
Rapptz 3 years ago
parent
737ff5beaf
commit
b476757720
2 changed files with 12 additions and 14 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 11
      discord/ext/commands/_types.py
  2. 15
      discord/ext/commands/core.py

11
discord/ext/commands/_types.py
View File

@ -23,7 +23,7 @@ DEALINGS IN THE SOFTWARE.
""" """
from typing import Any, Awaitable, Callable, Coroutine, TYPE_CHECKING, TypeVar, Union, Tuple from typing import Any, Awaitable, Callable, Coroutine, TYPE_CHECKING, TypeVar, Union, Tuple, Optional
T = TypeVar('T') T = TypeVar('T')
@ -48,14 +48,13 @@ CoroFunc = Callable[..., Coro[Any]]
MaybeCoro = Union[T, Coro[T]] MaybeCoro = Union[T, Coro[T]]
MaybeAwaitable = Union[T, Awaitable[T]] MaybeAwaitable = Union[T, Awaitable[T]]
Check = Union[Callable[["Cog", "ContextT"], MaybeCoro[bool]], Callable[["ContextT"], MaybeCoro[bool]]] CogT = TypeVar('CogT', bound='Optional[Cog]')
Hook = Union[Callable[["Cog", "ContextT"], Coro[Any]], Callable[["ContextT"], Coro[Any]]] Check = Callable[["ContextT"], MaybeCoro[bool]]
Error = Union[Callable[["Cog", "ContextT", "CommandError"], Coro[Any]], Callable[["ContextT", "CommandError"], Coro[Any]]] Hook = Union[Callable[["CogT", "ContextT"], Coro[Any]], Callable[["ContextT"], Coro[Any]]]
Error = Union[Callable[["CogT", "ContextT", "CommandError"], Coro[Any]], Callable[["ContextT", "CommandError"], Coro[Any]]]
ContextT = TypeVar('ContextT', bound='Context[Any]') ContextT = TypeVar('ContextT', bound='Context[Any]')
BotT = TypeVar('BotT', bound=_Bot, covariant=True) BotT = TypeVar('BotT', bound=_Bot, covariant=True)
ErrorT = TypeVar('ErrorT', bound='Error[Context[Any]]')
HookT = TypeVar('HookT', bound='Hook[Context[Any]]')
# This is merely a tag type to avoid circular import issues. # This is merely a tag type to avoid circular import issues.

15
discord/ext/commands/core.py
View File

@ -47,7 +47,7 @@ from typing import (
import discord import discord
from ._types import _BaseCommand from ._types import _BaseCommand, CogT
from .cog import Cog from .cog import Cog
from .context import Context from .context import Context
from .converter import Greedy, run_converters from .converter import Greedy, run_converters
@ -60,7 +60,7 @@ if TYPE_CHECKING:
from discord.message import Message from discord.message import Message
from ._types import BotT, Check, ContextT, Coro, CoroFunc, Error, ErrorT, Hook, HookT from ._types import BotT, Check, ContextT, Coro, CoroFunc, Error, Hook
__all__ = ( __all__ = (
@ -93,7 +93,6 @@ __all__ = (
MISSING: Any = discord.utils.MISSING MISSING: Any = discord.utils.MISSING
T = TypeVar('T') T = TypeVar('T')
CogT = TypeVar('CogT', bound='Optional[Cog]')
CommandT = TypeVar('CommandT', bound='Command') CommandT = TypeVar('CommandT', bound='Command')
# CHT = TypeVar('CHT', bound='Check') # CHT = TypeVar('CHT', bound='Check')
GroupT = TypeVar('GroupT', bound='Group') GroupT = TypeVar('GroupT', bound='Group')
@ -956,7 +955,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
if call_hooks: if call_hooks:
await self.call_after_hooks(ctx) await self.call_after_hooks(ctx)
def error(self, coro: ErrorT, /) -> ErrorT: def error(self, coro: Error[CogT, ContextT], /) -> Error[CogT, ContextT]:
"""A decorator that registers a coroutine as a local error handler. """A decorator that registers a coroutine as a local error handler.
A local error handler is an :func:`.on_command_error` event limited to A local error handler is an :func:`.on_command_error` event limited to
@ -991,7 +990,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
""" """
return hasattr(self, 'on_error') return hasattr(self, 'on_error')
def before_invoke(self, coro: HookT, /) -> HookT: def before_invoke(self, coro: Hook[CogT, ContextT], /) -> Hook[CogT, ContextT]:
"""A decorator that registers a coroutine as a pre-invoke hook. """A decorator that registers a coroutine as a pre-invoke hook.
A pre-invoke hook is called directly before the command is A pre-invoke hook is called directly before the command is
@ -1022,7 +1021,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
self._before_invoke = coro self._before_invoke = coro
return coro return coro
def after_invoke(self, coro: HookT, /) -> HookT: def after_invoke(self, coro: Hook[CogT, ContextT], /) -> Hook[CogT, ContextT]:
"""A decorator that registers a coroutine as a post-invoke hook. """A decorator that registers a coroutine as a post-invoke hook.
A post-invoke hook is called directly after the command is A post-invoke hook is called directly after the command is
@ -2385,7 +2384,7 @@ def max_concurrency(number: int, per: BucketType = BucketType.default, *, wait:
return decorator # type: ignore return decorator # type: ignore
def before_invoke(coro: Hook[ContextT], /) -> Callable[[T], T]: def before_invoke(coro: Hook[CogT, ContextT], /) -> Callable[[T], T]:
"""A decorator that registers a coroutine as a pre-invoke hook. """A decorator that registers a coroutine as a pre-invoke hook.
This allows you to refer to one before invoke hook for several commands that This allows you to refer to one before invoke hook for several commands that
@ -2437,7 +2436,7 @@ def before_invoke(coro: Hook[ContextT], /) -> Callable[[T], T]:
return decorator # type: ignore return decorator # type: ignore
def after_invoke(coro: Hook[ContextT], /) -> Callable[[T], T]: def after_invoke(coro: Hook[CogT, ContextT], /) -> Callable[[T], T]:
"""A decorator that registers a coroutine as a post-invoke hook. """A decorator that registers a coroutine as a post-invoke hook.
This allows you to refer to one after invoke hook for several commands that This allows you to refer to one after invoke hook for several commands that

Write Preview
Loading…
Cancel
Save