big commit - handle most of the modernization and cleanup

Author: AbstractUmbra

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bot.py

@@ -0,0 +1,109 @@
+"""MIT License
+
+Copyright (c) 2021-Present PythonistaGuild
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+import json
+import pathlib
+from collections import deque
+from typing import Any
+
+import aiohttp
+import asyncpg
+import discord
+from discord.ext import commands
+
+from core import CONFIG
+from core.utils.logging import LogHandler
+from modules import EXTENSIONS
+
+
+class Bot(commands.Bot):
+    session: aiohttp.ClientSession
+    pool: asyncpg.Pool[asyncpg.Record]
+    log_handler: LogHandler
+
+    __slots__ = (
+        "session",
+        "pool",
+        "log_handler",
+    )
+
+    def __init__(self):
+        super().__init__(
+            command_prefix=commands.when_mentioned_or(CONFIG["BOT"]["prefix"]),
+            intents=discord.Intents.all(),
+        )
+        self._previous_websocket_events: deque[Any] = deque(maxlen=10)
+
+    async def on_ready(self) -> None:
+        """On Bot ready - cache is built."""
+        assert self.user
+        print(f"Online. Logged in as {self.user.name} || {self.user.id}")
+
+    async def on_socket_response(self, message: Any) -> None:
+        """Quick override to log websocket events."""
+        self._previous_websocket_events.append(message)
+
+    async def setup_hook(self) -> None:
+        self.session = aiohttp.ClientSession()
+
+    async def start(self, token: str, *, reconnect: bool = True) -> None:
+        try:
+            await super().start(token=token, reconnect=reconnect)
+        finally:
+            path = pathlib.Path("logs/prev_events.log")
+            with path.open("w+", encoding="utf-8") as f:
+                for event in self._previous_websocket_events:
+                    try:
+                        last_log = json.dumps(event, ensure_ascii=True, indent=2)
+                    except Exception:
+                        f.write(f"{event}\n")
+                    else:
+                        f.write(f"{last_log}\n")
+
+    async def close(self) -> None:
+        """Closes the Bot. It will also close the internal :class:`aiohttp.ClientSession`."""
+        await self.session.close()
+        await super().close()
+
+
+async def main() -> None:
+    async with Bot() as bot, aiohttp.ClientSession() as session, asyncpg.create_pool(
+        user=CONFIG["DATABASE"]["user"],
+        host=CONFIG["DATABASE"]["host"],
+        database=CONFIG["DATABASE"]["database"],
+        password=CONFIG["DATABASE"]["password"],
+        port=CONFIG["DATABASE"]["port"],
+    ) as pool, LogHandler() as handler:
+        bot.session = session
+        bot.pool = pool
+        bot.log_handler = handler
+
+        await bot.load_extension("jishaku")
+        for extension in EXTENSIONS:
+            await bot.load_extension(extension.name)
+            bot.log_handler.log.info(
+                "Loaded %sextension: %s",
+                "module " if extension.ispkg else "",
+                extension.name,
+            )
+
+        await bot.start(CONFIG["BOT"]["token"])

config.template.toml

@@ -7,8 +7,8 @@ prefix = '>>'
 user = 'pythonista'
 password = 'somepassword'
 host = 'localhost'
-port = '5432'
+port = 5432
 database = 'pythonista'
 
 [API_TOKENS]
-riot = ''
+riot = ''

constants/__init__.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2020 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

constants/constants.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2020 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -22,12 +22,10 @@
 """
 from .meta import CONSTANTS
 
-
-__all__ = ('Roles', 'Colours', 'League')
+__all__ = ("Roles", "Colours", "League")
 
 
 class Roles(CONSTANTS):
-
     # Human
     ADMIN: int = 490952483238313995
     MODERATOR: int = 578255729295884308
@@ -45,37 +43,37 @@ class Roles(CONSTANTS):
 
 
 class Colours(CONSTANTS):
-
     # Branding
     PYTHONISTA_BG: hex = 0x18344D
     PYTHON_YELLOW: hex = 0xFFDE57
     PYTHON_BLUE: hex = 0x4584B6
 
 
 class League(CONSTANTS):
-
     # Endpoints
-    API: str = 'https://{region}.api.riotgames.com/{endpoint}/{query}'
-    SUMMONER_BY_ID: str = 'lol/summoner/v4/summoners'
-    SUMMONER_BY_NAME: str = 'lol/summoner/v4/summoners/by-name'
-    RANKED_BY_SUMMONER_ID: str = 'lol/league/v4/entries/by-summoner'
-    MATCHES_BY_ACCOUNT_ID: str = 'lol/match/v4/matchlists/by-account'
-    MATCH_BY_ID: str = 'lol/match/v4/matches'
+    API: str = "https://{region}.api.riotgames.com/{endpoint}/{query}"
+    SUMMONER_BY_ID: str = "lol/summoner/v4/summoners"
+    SUMMONER_BY_NAME: str = "lol/summoner/v4/summoners/by-name"
+    RANKED_BY_SUMMONER_ID: str = "lol/league/v4/entries/by-summoner"
+    MATCHES_BY_ACCOUNT_ID: str = "lol/match/v4/matchlists/by-account"
+    MATCH_BY_ID: str = "lol/match/v4/matches"
 
     # Assets
-    DD_VERSIONS_URL: str = 'https://ddragon.leagueoflegends.com/api/versions.json'
-    DD_CDN_URL: str = 'https://ddragon.leagueoflegends.com/cdn/dragontail-{version}.tgz'
-    DD_CHAMPIONS_URL: str = 'http://ddragon.leagueoflegends.com/cdn/{version}/data/en_US/champion.json'
+    DD_VERSIONS_URL: str = "https://ddragon.leagueoflegends.com/api/versions.json"
+    DD_CDN_URL: str = "https://ddragon.leagueoflegends.com/cdn/dragontail-{version}.tgz"
+    DD_CHAMPIONS_URL: str = (
+        "http://ddragon.leagueoflegends.com/cdn/{version}/data/en_US/champion.json"
+    )
 
     # Regions
-    BR: str = 'br1'  # Brazil
-    EUNE: str = 'eun1'  # Europe Nordic and East
-    EUW: str = 'euw1'  # Europe West
-    LAN: str = 'la1'  # Latin America North
-    LAS: str = 'la2'  # Latin America South
-    NA: str = 'na1'  # North America
-    OCE: str = 'oc1'  # Oceanic
-    RU: str = 'ru'  # Russia
-    TR: str = 'tr1'  # Turkey
-    JP: str = 'jp1'  # Japan
-    KR: str = 'kr'  # Korea
+    BR: str = "br1"  # Brazil
+    EUNE: str = "eun1"  # Europe Nordic and East
+    EUW: str = "euw1"  # Europe West
+    LAN: str = "la1"  # Latin America North
+    LAS: str = "la2"  # Latin America South
+    NA: str = "na1"  # North America
+    OCE: str = "oc1"  # Oceanic
+    RU: str = "ru"  # Russia
+    TR: str = "tr1"  # Turkey
+    JP: str = "jp1"  # Japan
+    KR: str = "kr"  # Korea

constants/meta.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2020 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -24,9 +24,8 @@
 
 
 class ConstantsMeta(type):
-
     def __new__(mcs, name, bases, attrs):
-        if name == 'CONSTANTS':
+        if name == "CONSTANTS":
             return super().__new__(mcs, name, bases, attrs)
 
         try:
@@ -41,10 +40,10 @@ def __new__(mcs, name, bases, attrs):
         return super().__new__(mcs, name, bases, attrs)
 
     def __setattr__(self, attr, nv):
-        raise RuntimeError(f'Constant <{attr}> cannot be assigned to.')
+        raise RuntimeError(f"Constant <{attr}> cannot be assigned to.")
 
     def __delattr__(self, attr):
-        raise RuntimeError(f'Constant <{attr}> cannot be deleted.')
+        raise RuntimeError(f"Constant <{attr}> cannot be deleted.")
 
 
 class CONSTANTS(metaclass=ConstantsMeta):

core/__init__.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -20,10 +20,9 @@
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 """
-__version__ = '0.0.1a'
+__version__ = "0.0.1a"
 
-from . import utils
-from .bot import Bot
+from . import utils as utils
+from ..bot import Bot as Bot
 from .core import *
-from .database import Database
 from .riot import *

core/bot.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2020 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -33,14 +33,21 @@ def predicate(ctx: core.Context):
         # This should never be a problem, but just in case...
         if not role:
             # TODO: Change this to a custom exception.
-            raise commands.CheckFailure(f'Role with ID <{role_id}> does not exist.')
+            raise commands.CheckFailure(f"Role with ID <{role_id}> does not exist.")
 
         ignored = (constants.Roles.NITRO_BOOSTER, constants.Roles.MUTED)
-        roles = [r for r in ctx.author.roles if r.id not in ignored and ctx.author.top_role >= r]
+        roles = [
+            r
+            for r in ctx.author.roles
+            if r.id not in ignored and ctx.author.top_role >= r
+        ]
 
         if roles:
             return True
 
         # TODO: Change this to a custom exception.
-        raise commands.CheckFailure(f'{ctx.author} is not in or higher than role <{role.name}(ID: {role.id})>.')
+        raise commands.CheckFailure(
+            f"{ctx.author} is not in or higher than role <{role.name}(ID: {role.id})>."
+        )
+
     return commands.check(predicate)

core/checks.py

@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2020 PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -20,20 +20,31 @@
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 """
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 import toml
 from discord.ext import commands
 
+if TYPE_CHECKING:
+    from types.config import Config
 
-__all__ = ('CONFIG', 'Cog', 'Context')
+    from ..bot import Bot
 
+__all__ = (
+    "CONFIG",
+    "Cog",
+    "Context",
+)
 
-CONFIG = toml.load('config.toml')
 
+CONFIG: Config = toml.load("config.toml")  # type: ignore # weird non-assertion
 
-class Cog(commands.Cog):
 
-    HELP_THUMBNAIL: str = 'https://i.imgur.com/J2FKHNW.png'
+class Cog(commands.Cog):
+    HELP_THUMBNAIL: str = "https://i.imgur.com/J2FKHNW.png"
 
 
-class Context(commands.Context):
+class Context(commands.Context[Bot]):
     pass