Browse Source

Fix type annotations to adhere to latest pyright release

pull/10109/head
Josh 3 years ago
committed by dolfies
parent
commit
52a5f10307
  1. 2
      .github/workflows/lint.yml
  2. 8
      discord/errors.py
  3. 2
      discord/ext/commands/_types.py
  4. 3
      discord/ext/commands/bot.py
  5. 8
      discord/ext/commands/context.py
  6. 5
      discord/ext/commands/converter.py
  7. 24
      discord/ext/commands/core.py
  8. 5
      discord/ext/commands/help.py
  9. 4
      discord/scheduled_event.py
  10. 8
      discord/utils.py
  11. 4
      discord/welcome_screen.py

2
.github/workflows/lint.yml

@ -33,7 +33,7 @@ jobs:
- name: Run Pyright - name: Run Pyright
uses: jakebailey/pyright-action@v1 uses: jakebailey/pyright-action@v1
with: with:
version: '1.1.242' version: '1.1.253'
warnings: false warnings: false
no-comments: ${{ matrix.python-version != '3.x' }} no-comments: ${{ matrix.python-version != '3.x' }}

8
discord/errors.py

@ -29,13 +29,9 @@ from .utils import _get_as_snowflake
if TYPE_CHECKING: if TYPE_CHECKING:
from aiohttp import ClientResponse, ClientWebSocketResponse from aiohttp import ClientResponse, ClientWebSocketResponse
from requests import Response
try: _ResponseType = Union[ClientResponse, Response]
from requests import Response
_ResponseType = Union[ClientResponse, Response]
except ModuleNotFoundError:
_ResponseType = ClientResponse
__all__ = ( __all__ = (
'DiscordException', 'DiscordException',

2
discord/ext/commands/_types.py

@ -61,7 +61,7 @@ BotT = TypeVar('BotT', bound=_Bot, covariant=True)
ContextT_co = TypeVar('ContextT_co', bound='Context[Any]', covariant=True) ContextT_co = TypeVar('ContextT_co', bound='Context[Any]', covariant=True)
class Check(Protocol[ContextT_co]): class Check(Protocol[ContextT_co]): # type: ignore # TypeVar is expected to be invariant
predicate: Callable[[ContextT_co], Coroutine[Any, Any, bool]] predicate: Callable[[ContextT_co], Coroutine[Any, Any, bool]]

3
discord/ext/commands/bot.py

@ -379,8 +379,7 @@ class BotBase(GroupMixin[None]):
if len(data) == 0: if len(data) == 0:
return True return True
# type-checker doesn't distinguish between functions and methods return await discord.utils.async_all(f(ctx) for f in data)
return await discord.utils.async_all(f(ctx) for f in data) # type: ignore
async def is_owner(self, user: User, /) -> bool: async def is_owner(self, user: User, /) -> bool:
"""|coro| """|coro|

8
discord/ext/commands/context.py

@ -34,7 +34,7 @@ from discord.message import Message
from ._types import BotT from ._types import BotT
if TYPE_CHECKING: if TYPE_CHECKING:
from typing_extensions import ParamSpec from typing_extensions import ParamSpec, TypeGuard
from discord.abc import MessageableChannel from discord.abc import MessageableChannel
from discord.commands import MessageCommand from discord.commands import MessageCommand
@ -65,6 +65,10 @@ else:
P = TypeVar('P') P = TypeVar('P')
def is_cog(obj: Any) -> TypeGuard[Cog]:
return hasattr(obj, '__cog_commands__')
class Context(discord.abc.Messageable, Generic[BotT]): class Context(discord.abc.Messageable, Generic[BotT]):
r"""Represents the context in which a command is being invoked under. r"""Represents the context in which a command is being invoked under.
@ -393,7 +397,7 @@ class Context(discord.abc.Messageable, Generic[BotT]):
await cmd.prepare_help_command(self, entity.qualified_name) await cmd.prepare_help_command(self, entity.qualified_name)
try: try:
if hasattr(entity, '__cog_commands__'): if is_cog(entity):
injected = wrap_callback(cmd.send_cog_help) injected = wrap_callback(cmd.send_cog_help)
return await injected(entity) return await injected(entity)
elif isinstance(entity, Group): elif isinstance(entity, Group):

5
discord/ext/commands/converter.py

@ -234,6 +234,7 @@ class MemberConverter(IDConverter[discord.Member]):
guild = ctx.guild guild = ctx.guild
result = None result = None
user_id = None user_id = None
if match is None: if match is None:
# not a mention... # not a mention...
if guild: if guild:
@ -247,7 +248,7 @@ class MemberConverter(IDConverter[discord.Member]):
else: else:
result = _get_from_guilds(bot, 'get_member', user_id) result = _get_from_guilds(bot, 'get_member', user_id)
if result is None: if not isinstance(result, discord.Member):
if guild is None: if guild is None:
raise MemberNotFound(argument) raise MemberNotFound(argument)
@ -1172,7 +1173,7 @@ async def _actual_conversion(ctx: Context[BotT], converter: Any, argument: str,
except CommandError: except CommandError:
raise raise
except Exception as exc: except Exception as exc:
raise ConversionError(converter, exc) from exc raise ConversionError(converter, exc) from exc # type: ignore
try: try:
return converter(argument) return converter(argument)

24
discord/ext/commands/core.py

@ -351,8 +351,8 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
def __init__( def __init__(
self, self,
func: Union[ func: Union[
Callable[Concatenate[CogT, ContextT, P], Coro[T]], Callable[Concatenate[CogT, Context[Any], P], Coro[T]],
Callable[Concatenate[ContextT, P], Coro[T]], Callable[Concatenate[Context[Any], P], Coro[T]],
], ],
/, /,
**kwargs: Any, **kwargs: Any,
@ -396,7 +396,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
except AttributeError: except AttributeError:
checks = kwargs.get('checks', []) checks = kwargs.get('checks', [])
self.checks: List[UserCheck[ContextT]] = checks self.checks: List[UserCheck[Context[Any]]] = checks
try: try:
cooldown = func.__commands_cooldown__ cooldown = func.__commands_cooldown__
@ -468,7 +468,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
self.params: Dict[str, Parameter] = get_signature_parameters(function, globalns) self.params: Dict[str, Parameter] = get_signature_parameters(function, globalns)
def add_check(self, func: UserCheck[ContextT], /) -> None: def add_check(self, func: UserCheck[Context[Any]], /) -> None:
"""Adds a check to the command. """Adds a check to the command.
This is the non-decorator interface to :func:`.check`. This is the non-decorator interface to :func:`.check`.
@ -487,7 +487,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
self.checks.append(func) self.checks.append(func)
def remove_check(self, func: UserCheck[ContextT], /) -> None: def remove_check(self, func: UserCheck[Context[Any]], /) -> None:
"""Removes a check from the command. """Removes a check from the command.
This function is idempotent and will not raise an exception This function is idempotent and will not raise an exception
@ -1236,7 +1236,7 @@ class Command(_BaseCommand, Generic[CogT, P, T]):
# since we have no checks, then we just return True. # since we have no checks, then we just return True.
return True return True
return await discord.utils.async_all(predicate(ctx) for predicate in predicates) # type: ignore return await discord.utils.async_all(predicate(ctx) for predicate in predicates)
finally: finally:
ctx.command = original ctx.command = original
@ -1435,7 +1435,7 @@ class GroupMixin(Generic[CogT]):
def command( def command(
self: GroupMixin[CogT], self: GroupMixin[CogT],
name: str = ..., name: str = ...,
cls: Type[CommandT] = ..., cls: Type[CommandT] = ..., # type: ignore # previous overload handles case where cls is not set
*args: Any, *args: Any,
**kwargs: Any, **kwargs: Any,
) -> Callable[ ) -> Callable[
@ -1495,7 +1495,7 @@ class GroupMixin(Generic[CogT]):
def group( def group(
self: GroupMixin[CogT], self: GroupMixin[CogT],
name: str = ..., name: str = ...,
cls: Type[GroupT] = ..., cls: Type[GroupT] = ..., # type: ignore # previous overload handles case where cls is not set
*args: Any, *args: Any,
**kwargs: Any, **kwargs: Any,
) -> Callable[ ) -> Callable[
@ -1687,7 +1687,7 @@ def command(
@overload @overload
def command( def command(
name: str = ..., name: str = ...,
cls: Type[CommandT] = ..., cls: Type[CommandT] = ..., # type: ignore # previous overload handles case where cls is not set
**attrs: Any, **attrs: Any,
) -> Callable[ ) -> Callable[
[ [
@ -1757,7 +1757,7 @@ def group(
@overload @overload
def group( def group(
name: str = ..., name: str = ...,
cls: Type[GroupT] = ..., cls: Type[GroupT] = ..., # type: ignore # previous overload handles case where cls is not set
**attrs: Any, **attrs: Any,
) -> Callable[ ) -> Callable[
[ [
@ -1865,9 +1865,9 @@ def check(predicate: UserCheck[ContextT], /) -> Check[ContextT]:
The predicate to check if the command should be invoked. The predicate to check if the command should be invoked.
""" """
def decorator(func: Union[Command, CoroFunc]) -> Union[Command, CoroFunc]: def decorator(func: Union[Command[Any, ..., Any], CoroFunc]) -> Union[Command[Any, ..., Any], CoroFunc]:
if isinstance(func, Command): if isinstance(func, Command):
func.checks.append(predicate) func.checks.append(predicate) # type: ignore
else: else:
if not hasattr(func, '__commands_checks__'): if not hasattr(func, '__commands_checks__'):
func.__commands_checks__ = [] func.__commands_checks__ = []

5
discord/ext/commands/help.py

@ -62,7 +62,6 @@ if TYPE_CHECKING:
from ._types import ( from ._types import (
UserCheck, UserCheck,
ContextT,
BotT, BotT,
_Bot, _Bot,
) )
@ -377,7 +376,7 @@ class HelpCommand:
bot.remove_command(self._command_impl.name) bot.remove_command(self._command_impl.name)
self._command_impl._eject_cog() self._command_impl._eject_cog()
def add_check(self, func: UserCheck[ContextT], /) -> None: def add_check(self, func: UserCheck[Context[Any]], /) -> None:
""" """
Adds a check to the help command. Adds a check to the help command.
@ -395,7 +394,7 @@ class HelpCommand:
self._command_impl.add_check(func) self._command_impl.add_check(func)
def remove_check(self, func: UserCheck[ContextT], /) -> None: def remove_check(self, func: UserCheck[Context[Any]], /) -> None:
""" """
Removes a check from the help command. Removes a check from the help command.

4
discord/scheduled_event.py

@ -35,7 +35,7 @@ from .utils import parse_time, _get_as_snowflake, _bytes_to_base64_data, MISSING
if TYPE_CHECKING: if TYPE_CHECKING:
from .types.scheduled_event import ( from .types.scheduled_event import (
GuildScheduledEvent as GuildScheduledEventPayload, GuildScheduledEvent as BaseGuildScheduledEventPayload,
GuildScheduledEventWithUserCount as GuildScheduledEventWithUserCountPayload, GuildScheduledEventWithUserCount as GuildScheduledEventWithUserCountPayload,
EntityMetadata, EntityMetadata,
) )
@ -46,7 +46,7 @@ if TYPE_CHECKING:
from .state import ConnectionState from .state import ConnectionState
from .user import User from .user import User
GuildScheduledEventPayload = Union[GuildScheduledEventPayload, GuildScheduledEventWithUserCountPayload] GuildScheduledEventPayload = Union[BaseGuildScheduledEventPayload, GuildScheduledEventWithUserCountPayload]
# fmt: off # fmt: off
__all__ = ( __all__ = (

8
discord/utils.py

@ -142,7 +142,7 @@ if TYPE_CHECKING:
from aiohttp import ClientSession from aiohttp import ClientSession
from functools import cached_property as cached_property from functools import cached_property as cached_property
from typing_extensions import ParamSpec, Self from typing_extensions import ParamSpec, Self, TypeGuard
from .permissions import Permissions from .permissions import Permissions
from .abc import Messageable, Snowflake from .abc import Messageable, Snowflake
@ -709,7 +709,11 @@ async def maybe_coroutine(f: MaybeAwaitableFunc[P, T], *args: P.args, **kwargs:
return value # type: ignore return value # type: ignore
async def async_all(gen: Iterable[Awaitable[T]], *, check: Callable[[T], bool] = _isawaitable) -> bool: async def async_all(
gen: Iterable[Union[T, Awaitable[T]]],
*,
check: Callable[[Union[T, Awaitable[T]]], TypeGuard[Awaitable[T]]] = _isawaitable,
) -> bool:
for elem in gen: for elem in gen:
if check(elem): if check(elem):
elem = await elem elem = await elem

4
discord/welcome_screen.py

@ -126,8 +126,8 @@ class WelcomeScreen:
state = self.guild._state state = self.guild._state
channels = data.get('welcome_channels', []) channels = data.get('welcome_channels', [])
self.welcome_channels = [WelcomeChannel._from_dict(data=channel, state=state) for channel in channels] self.welcome_channels: List[WelcomeChannel] = [WelcomeChannel._from_dict(data=channel, state=state) for channel in channels]
self.description = data.get('description', '') self.description: str = data.get('description', '')
def __repr__(self) -> str: def __repr__(self) -> str:
return f'<WelcomeScreen enabled={self.enabled} description={self.description} welcome_channels={self.welcome_channels!r}>' return f'<WelcomeScreen enabled={self.enabled} description={self.description} welcome_channels={self.welcome_channels!r}>'

Loading…
Cancel
Save