From 2e1c573b9f1a3076666177e145123b298130c0c9 Mon Sep 17 00:00:00 2001 From: Sengolda Date: Thu, 14 Oct 2021 02:12:59 +0530 Subject: [PATCH 01/13] Type-Hinted logging.getLogger --- discord/client.py | 2 +- discord/http.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/discord/client.py b/discord/client.py index 3d0216d8..696affa2 100644 --- a/discord/client.py +++ b/discord/client.py @@ -87,7 +87,7 @@ __all__ = ("Client",) Coro = TypeVar("Coro", bound=Callable[..., Coroutine[Any, Any, Any]]) -_log = logging.getLogger(__name__) +_log: logging.Logger = logging.getLogger(__name__) def _cancel_tasks(loop: asyncio.AbstractEventLoop) -> None: diff --git a/discord/http.py b/discord/http.py index 3fef633c..25e8a421 100644 --- a/discord/http.py +++ b/discord/http.py @@ -61,7 +61,7 @@ from .gateway import DiscordClientWebSocketResponse from . import __version__, utils from .utils import MISSING -_log = logging.getLogger(__name__) +_log: logging.Logger = logging.getLogger(__name__) if TYPE_CHECKING: from .file import File -- 2.47.2 From bcedffc4bc6f03767ea6be4a3a3bf35af885d5fc Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:12:00 +0530 Subject: [PATCH 02/13] type hint set_permissions --- discord/abc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/abc.py b/discord/abc.py index 196043e3..f897d0c8 100644 --- a/discord/abc.py +++ b/discord/abc.py @@ -703,7 +703,7 @@ class GuildChannel: ) -> None: ... - async def set_permissions(self, target, *, overwrite=_undefined, reason=None, **permissions): + async def set_permissions(self, target: Union[Member, User], *, overwrite: PermissionOverwrite, reason: Optional[str] = None, **permissions: bool): r"""|coro| Sets the channel specific permission overwrites for a target in the -- 2.47.2 From ad038d8979f866d413c8289409e70e08de905b19 Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:13:44 +0530 Subject: [PATCH 03/13] Format with black --- discord/abc.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/discord/abc.py b/discord/abc.py index f897d0c8..f2450c31 100644 --- a/discord/abc.py +++ b/discord/abc.py @@ -703,7 +703,14 @@ class GuildChannel: ) -> None: ... - async def set_permissions(self, target: Union[Member, User], *, overwrite: PermissionOverwrite, reason: Optional[str] = None, **permissions: bool): + async def set_permissions( + self, + target: Union[Member, User], + *, + overwrite: PermissionOverwrite, + reason: Optional[str] = None, + **permissions: bool, + ): r"""|coro| Sets the channel specific permission overwrites for a target in the -- 2.47.2 From aacfe10e21bb54cc6b8c832a056711aeaa02495e Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:22:54 +0530 Subject: [PATCH 04/13] typed __main__ and acitivity --- discord/__main__.py | 39 ++++++++++++++++++++------------------- discord/activity.py | 4 ++-- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/discord/__main__.py b/discord/__main__.py index 6e93c09b..93cce563 100644 --- a/discord/__main__.py +++ b/discord/__main__.py @@ -25,6 +25,7 @@ DEALINGS IN THE SOFTWARE. import argparse import sys from pathlib import Path +from typing import List import discord import pkg_resources @@ -32,14 +33,14 @@ import aiohttp import platform -def show_version(): - entries = [] +def show_version() -> None: + entries: List[str] = [] entries.append("- Python v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(sys.version_info)) - version_info = discord.version_info + version_info: discord.version_info = discord.version_info entries.append("- discord.py v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(version_info)) if version_info.releaselevel != "final": - pkg = pkg_resources.get_distribution("discord.py") + pkg: pkg_resources.Distribution = pkg_resources.get_distribution("discord.py") if pkg: entries.append(f" - discord.py pkg_resources: v{pkg.version}") @@ -49,12 +50,12 @@ def show_version(): print("\n".join(entries)) -def core(parser, args): +def core(parser, args) -> None: if args.version: show_version() -_bot_template = """#!/usr/bin/env python3 +_bot_template: str = """#!/usr/bin/env python3 from discord.ext import commands import discord @@ -80,7 +81,7 @@ bot = Bot() bot.run(config.token) """ -_gitignore_template = """# Byte-compiled / optimized / DLL files +_gitignore_template: str = """# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class @@ -123,7 +124,7 @@ def setup(bot): bot.add_cog({name}(bot)) ''' -_cog_extras = """ +_cog_extras: str = """ def cog_unload(self): # clean up logic goes here pass @@ -158,7 +159,7 @@ _cog_extras = """ # certain file names and directory names are forbidden # see: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx # although some of this doesn't apply to Linux, we might as well be consistent -_base_table = { +_base_table: Dict[str, str] = { "<": "-", ">": "-", ":": "-", @@ -176,7 +177,7 @@ _base_table.update((chr(i), None) for i in range(32)) _translation_table = str.maketrans(_base_table) -def to_path(parser, name, *, replace_spaces=False): +def to_path(parser: argparse.ArgumentParser, name: str, *, replace_spaces: bool =False) -> Path: if isinstance(name, Path): return name @@ -208,13 +209,13 @@ def to_path(parser, name, *, replace_spaces=False): if len(name) <= 4 and name.upper() in forbidden: parser.error("invalid directory name given, use a different one") - name = name.translate(_translation_table) + name: str = name.translate(_translation_table) if replace_spaces: name = name.replace(" ", "-") return Path(name) -def newbot(parser, args): +def newbot(parser: argparse.ArgumentParser, args) -> None: new_directory = to_path(parser, args.directory) / to_path(parser, args.name) # as a note exist_ok for Path is a 3.5+ only feature @@ -241,7 +242,7 @@ def newbot(parser, args): try: with open(str(new_directory / "bot.py"), "w", encoding="utf-8") as fp: - base = "Bot" if not args.sharded else "AutoShardedBot" + base: str = "Bot" if not args.sharded else "AutoShardedBot" fp.write(_bot_template.format(base=base, prefix=args.prefix)) except OSError as exc: parser.error(f"could not create bot file ({exc})") @@ -256,7 +257,7 @@ def newbot(parser, args): print("successfully made bot at", new_directory) -def newcog(parser, args): +def newcog(parser, args) -> None: cog_dir = to_path(parser, args.directory) try: cog_dir.mkdir(exist_ok=True) @@ -290,7 +291,7 @@ def newcog(parser, args): print("successfully made cog at", directory) -def add_newbot_args(subparser): +def add_newbot_args(subparser) -> None: parser = subparser.add_parser("newbot", help="creates a command bot project quickly") parser.set_defaults(func=newbot) @@ -301,7 +302,7 @@ def add_newbot_args(subparser): parser.add_argument("--no-git", help="do not create a .gitignore file", action="store_true", dest="no_git") -def add_newcog_args(subparser): +def add_newcog_args(subparser) -> None: parser = subparser.add_parser("newcog", help="creates a new cog template quickly") parser.set_defaults(func=newcog) @@ -315,8 +316,8 @@ def add_newcog_args(subparser): parser.add_argument("--full", help="add all special methods as well", action="store_true") -def parse_args(): - parser = argparse.ArgumentParser(prog="discord", description="Tools for helping with discord.py") +def parse_args() -> None: + parser: argparse.ArgumentParser = argparse.ArgumentParser(prog="discord", description="Tools for helping with discord.py") parser.add_argument("-v", "--version", action="store_true", help="shows the library version") parser.set_defaults(func=core) @@ -326,7 +327,7 @@ def parse_args(): return parser, parser.parse_args() -def main(): +def main() -> None: parser, args = parse_args() args.func(parser, args) diff --git a/discord/activity.py b/discord/activity.py index 7294dbd9..0d21a027 100644 --- a/discord/activity.py +++ b/discord/activity.py @@ -121,7 +121,7 @@ class BaseActivity: __slots__ = ("_created_at",) - def __init__(self, **kwargs): + def __init__(self, **kwargs: Any) -> None: self._created_at: Optional[float] = kwargs.pop("created_at", None) @property @@ -499,7 +499,7 @@ class Streaming(BaseActivity): return f"" @property - def twitch_name(self): + def twitch_name(self) -> Optional[str]: """Optional[:class:`str`]: If provided, the twitch name of the user streaming. This corresponds to the ``large_image`` key of the :attr:`Streaming.assets` -- 2.47.2 From 1359714c3c300d52c67263fac2ba0722b1aea975 Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:23:27 +0530 Subject: [PATCH 05/13] Format with black --- discord/__main__.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/discord/__main__.py b/discord/__main__.py index 93cce563..4e1e3f50 100644 --- a/discord/__main__.py +++ b/discord/__main__.py @@ -177,7 +177,7 @@ _base_table.update((chr(i), None) for i in range(32)) _translation_table = str.maketrans(_base_table) -def to_path(parser: argparse.ArgumentParser, name: str, *, replace_spaces: bool =False) -> Path: +def to_path(parser: argparse.ArgumentParser, name: str, *, replace_spaces: bool = False) -> Path: if isinstance(name, Path): return name @@ -317,7 +317,9 @@ def add_newcog_args(subparser) -> None: def parse_args() -> None: - parser: argparse.ArgumentParser = argparse.ArgumentParser(prog="discord", description="Tools for helping with discord.py") + parser: argparse.ArgumentParser = argparse.ArgumentParser( + prog="discord", description="Tools for helping with discord.py" + ) parser.add_argument("-v", "--version", action="store_true", help="shows the library version") parser.set_defaults(func=core) -- 2.47.2 From 322230ec8a2cb9a9ac73499f1d01aed2ef8ff862 Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:24:48 +0530 Subject: [PATCH 06/13] forgot an import --- discord/__main__.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/discord/__main__.py b/discord/__main__.py index 4e1e3f50..f69b21d7 100644 --- a/discord/__main__.py +++ b/discord/__main__.py @@ -23,14 +23,15 @@ DEALINGS IN THE SOFTWARE. """ import argparse +import platform import sys from pathlib import Path -from typing import List +from typing import Dict, List + +import aiohttp +import pkg_resources import discord -import pkg_resources -import aiohttp -import platform def show_version() -> None: -- 2.47.2 From 7541ef06eb39a0defc496cf1be3059a51b560232 Mon Sep 17 00:00:00 2001 From: Sengolda Date: Mon, 18 Oct 2021 12:26:19 +0530 Subject: [PATCH 07/13] Type-hint _cog_template --- discord/__main__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/__main__.py b/discord/__main__.py index f69b21d7..f18c0090 100644 --- a/discord/__main__.py +++ b/discord/__main__.py @@ -112,7 +112,7 @@ var/ config.py """ -_cog_template = '''from discord.ext import commands +_cog_template: str = '''from discord.ext import commands import discord class {name}(commands.Cog{attrs}): -- 2.47.2 From 11087a0a9db49a5ec4d6a12d710a1102391628e3 Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Mon, 18 Oct 2021 20:26:31 +0530 Subject: [PATCH 08/13] Fixed. --- discord/abc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/abc.py b/discord/abc.py index f2450c31..cf7a40cd 100644 --- a/discord/abc.py +++ b/discord/abc.py @@ -707,7 +707,7 @@ class GuildChannel: self, target: Union[Member, User], *, - overwrite: PermissionOverwrite, + overwrite: PermissionOverwrite = _undefined, reason: Optional[str] = None, **permissions: bool, ): -- 2.47.2 From c2184fe244c014c0d5c582dc7ab8dd59474e19c1 Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Thu, 28 Oct 2021 01:15:33 +0530 Subject: [PATCH 09/13] Typed async_all --- discord/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/utils.py b/discord/utils.py index 7908b5ec..649e1c90 100644 --- a/discord/utils.py +++ b/discord/utils.py @@ -515,7 +515,7 @@ async def maybe_coroutine(f, *args, **kwargs): return value -async def async_all(gen, *, check=_isawaitable): +async def async_all(gen, *, check=_isawaitable) -> bool: for elem in gen: if check(elem): elem = await elem -- 2.47.2 From cbc0e92e5d6384b05475f1d59f91d8e8cd1bbec7 Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Thu, 28 Oct 2021 01:17:47 +0530 Subject: [PATCH 10/13] Typed maybe_coroutine --- discord/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/utils.py b/discord/utils.py index 649e1c90..c1face0c 100644 --- a/discord/utils.py +++ b/discord/utils.py @@ -507,7 +507,7 @@ def _parse_ratelimit_header(request: Any, *, use_clock: bool = False) -> float: return float(reset_after) -async def maybe_coroutine(f, *args, **kwargs): +async def maybe_coroutine(f: Callable[..., Any], *args: Any, **kwargs: Any) -> Callable[..., Any]: value = f(*args, **kwargs) if _isawaitable(value): return await value -- 2.47.2 From 19c4a7ebdf8101b9778f9d0a064203acfa447d2e Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Thu, 28 Oct 2021 01:19:03 +0530 Subject: [PATCH 11/13] Typed classproperty.fget --- discord/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/utils.py b/discord/utils.py index c1face0c..a62e5418 100644 --- a/discord/utils.py +++ b/discord/utils.py @@ -170,7 +170,7 @@ class CachedSlotProperty(Generic[T, T_co]): class classproperty(Generic[T_co]): def __init__(self, fget: Callable[[Any], T_co]) -> None: - self.fget = fget + self.fget: Callable[[Any], T_co] = fget def __get__(self, instance: Optional[Any], owner: Type[Any]) -> T_co: return self.fget(owner) -- 2.47.2 From de34073b344793e8d78d7119029c0b714fa95400 Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Thu, 28 Oct 2021 01:22:11 +0530 Subject: [PATCH 12/13] typed SequenceProxy.index --- discord/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/utils.py b/discord/utils.py index a62e5418..df72d60c 100644 --- a/discord/utils.py +++ b/discord/utils.py @@ -207,7 +207,7 @@ class SequenceProxy(Generic[T_co], collections.abc.Sequence): def __reversed__(self) -> Iterator[T_co]: return reversed(self.__proxied) - def index(self, value: Any, *args, **kwargs) -> int: + def index(self, value: Any, *args: Any, **kwargs: Any) -> int: return self.__proxied.index(value, *args, **kwargs) def count(self, value: Any) -> int: -- 2.47.2 From e721b0f84e5639d6d2c107fb218a7a43a8bf6563 Mon Sep 17 00:00:00 2001 From: Sengolda <79252176+Sengolda@users.noreply.github.com> Date: Thu, 28 Oct 2021 01:29:51 +0530 Subject: [PATCH 13/13] Typed `value` variable in maybe_coroutine --- discord/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/discord/utils.py b/discord/utils.py index df72d60c..309be56e 100644 --- a/discord/utils.py +++ b/discord/utils.py @@ -508,7 +508,7 @@ def _parse_ratelimit_header(request: Any, *, use_clock: bool = False) -> float: async def maybe_coroutine(f: Callable[..., Any], *args: Any, **kwargs: Any) -> Callable[..., Any]: - value = f(*args, **kwargs) + value: Any = f(*args, **kwargs) if _isawaitable(value): return await value else: -- 2.47.2