From 1ed857d9093481387720ac1dc4041a64a2c9c593 Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 20:20:48 +0100
Subject: chore: switch commands.Bot typehints to bot.bot's Bot

---
 bot/exts/evergreen/error_handler.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'bot/exts/evergreen/error_handler.py')

diff --git a/bot/exts/evergreen/error_handler.py b/bot/exts/evergreen/error_handler.py
index 8db49748..053e3866 100644
--- a/bot/exts/evergreen/error_handler.py
+++ b/bot/exts/evergreen/error_handler.py
@@ -7,6 +7,7 @@ from discord import Embed, Message
 from discord.ext import commands
 from sentry_sdk import push_scope
 
+from bot.bot import Bot
 from bot.constants import Channels, Colours, ERROR_REPLIES, NEGATIVE_REPLIES
 from bot.utils.decorators import InChannelCheckFailure, InMonthCheckFailure
 from bot.utils.exceptions import UserNotPlayingError
@@ -17,7 +18,7 @@ log = logging.getLogger(__name__)
 class CommandErrorHandler(commands.Cog):
     """A error handler for the PythonDiscord server."""
 
-    def __init__(self, bot: commands.Bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
 
     @staticmethod
@@ -135,6 +136,6 @@ class CommandErrorHandler(commands.Cog):
             log.exception(f"Unhandled command error: {str(error)}", exc_info=error)
 
 
-def setup(bot: commands.Bot) -> None:
+def setup(bot: Bot) -> None:
     """Error handler Cog load."""
     bot.add_cog(CommandErrorHandler(bot))
-- 
cgit v1.2.3


From 713396a91859d914478e417ee6ab9e0a26ee6cf5 Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 20:56:53 +0100
Subject: chore(evergreen): format each cog load docstring the same way

---
 bot/exts/evergreen/8bitify.py              | 2 +-
 bot/exts/evergreen/battleship.py           | 2 +-
 bot/exts/evergreen/conversationstarters.py | 2 +-
 bot/exts/evergreen/emoji.py                | 2 +-
 bot/exts/evergreen/error_handler.py        | 2 +-
 bot/exts/evergreen/fun.py                  | 2 +-
 bot/exts/evergreen/game.py                 | 2 +-
 bot/exts/evergreen/githubinfo.py           | 2 +-
 bot/exts/evergreen/issues.py               | 2 +-
 bot/exts/evergreen/magic_8ball.py          | 2 +-
 bot/exts/evergreen/movie.py                | 2 +-
 bot/exts/evergreen/ping.py                 | 2 +-
 bot/exts/evergreen/pythonfacts.py          | 2 +-
 bot/exts/evergreen/reddit.py               | 2 +-
 bot/exts/evergreen/space.py                | 2 +-
 bot/exts/evergreen/tic_tac_toe.py          | 2 +-
 bot/exts/evergreen/timed.py                | 2 +-
 bot/exts/evergreen/trivia_quiz.py          | 2 +-
 bot/exts/evergreen/uptime.py               | 2 +-
 bot/exts/evergreen/wikipedia.py            | 2 +-
 bot/exts/evergreen/xkcd.py                 | 2 +-
 21 files changed, 21 insertions(+), 21 deletions(-)

(limited to 'bot/exts/evergreen/error_handler.py')

diff --git a/bot/exts/evergreen/8bitify.py b/bot/exts/evergreen/8bitify.py
index 621aa875..09a3eb5c 100644
--- a/bot/exts/evergreen/8bitify.py
+++ b/bot/exts/evergreen/8bitify.py
@@ -53,5 +53,5 @@ class EightBitify(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Cog the EightBitify load."""
     bot.add_cog(EightBitify(bot))
diff --git a/bot/exts/evergreen/battleship.py b/bot/exts/evergreen/battleship.py
index f255afb9..ca0e3881 100644
--- a/bot/exts/evergreen/battleship.py
+++ b/bot/exts/evergreen/battleship.py
@@ -440,5 +440,5 @@ class Battleship(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Battleship cog"""
     bot.add_cog(Battleship(bot))
diff --git a/bot/exts/evergreen/conversationstarters.py b/bot/exts/evergreen/conversationstarters.py
index aed76bcf..04194c01 100644
--- a/bot/exts/evergreen/conversationstarters.py
+++ b/bot/exts/evergreen/conversationstarters.py
@@ -68,5 +68,5 @@ class ConvoStarters(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Conversation starters Cog load."""
+    """Load the ConvoStarters cog."""
     bot.add_cog(ConvoStarters(bot))
diff --git a/bot/exts/evergreen/emoji.py b/bot/exts/evergreen/emoji.py
index 58d9be03..45b77e16 100644
--- a/bot/exts/evergreen/emoji.py
+++ b/bot/exts/evergreen/emoji.py
@@ -122,5 +122,5 @@ class Emojis(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Add the Emojis cog into the bot."""
+    """Load the Emojis cog."""
     bot.add_cog(Emojis(bot))
diff --git a/bot/exts/evergreen/error_handler.py b/bot/exts/evergreen/error_handler.py
index 053e3866..64460822 100644
--- a/bot/exts/evergreen/error_handler.py
+++ b/bot/exts/evergreen/error_handler.py
@@ -137,5 +137,5 @@ class CommandErrorHandler(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Error handler Cog load."""
+    """Load the ErrorHandler cog."""
     bot.add_cog(CommandErrorHandler(bot))
diff --git a/bot/exts/evergreen/fun.py b/bot/exts/evergreen/fun.py
index cde37895..c7b0d7d9 100644
--- a/bot/exts/evergreen/fun.py
+++ b/bot/exts/evergreen/fun.py
@@ -241,5 +241,5 @@ class Fun(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Fun Cog load."""
+    """Load the Fun cog."""
     bot.add_cog(Fun(bot))
diff --git a/bot/exts/evergreen/game.py b/bot/exts/evergreen/game.py
index 068d3f68..24872e76 100644
--- a/bot/exts/evergreen/game.py
+++ b/bot/exts/evergreen/game.py
@@ -471,7 +471,7 @@ class Games(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Add/Load Games cog."""
+    """Load the Games cog."""
     # Check does IGDB API key exist, if not, log warning and don't load cog
     if not Tokens.igdb_client_id:
         logger.warning("No IGDB client ID. Not loading Games cog.")
diff --git a/bot/exts/evergreen/githubinfo.py b/bot/exts/evergreen/githubinfo.py
index da6eba5c..65fcc7cf 100644
--- a/bot/exts/evergreen/githubinfo.py
+++ b/bot/exts/evergreen/githubinfo.py
@@ -172,5 +172,5 @@ class GithubInfo(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Adding the cog to the bot."""
+    """Load the GithubInfo cog."""
     bot.add_cog(GithubInfo(bot))
diff --git a/bot/exts/evergreen/issues.py b/bot/exts/evergreen/issues.py
index 692e0b43..d7ee99c0 100644
--- a/bot/exts/evergreen/issues.py
+++ b/bot/exts/evergreen/issues.py
@@ -271,5 +271,5 @@ class Issues(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog Retrieves Issues From Github."""
+    """Load the Issues cog."""
     bot.add_cog(Issues(bot))
diff --git a/bot/exts/evergreen/magic_8ball.py b/bot/exts/evergreen/magic_8ball.py
index 2dfe237a..61c68693 100644
--- a/bot/exts/evergreen/magic_8ball.py
+++ b/bot/exts/evergreen/magic_8ball.py
@@ -29,5 +29,5 @@ class Magic8ball(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Magic 8ball Cog load."""
+    """Load the Magic8Ball cog."""
     bot.add_cog(Magic8ball(bot))
diff --git a/bot/exts/evergreen/movie.py b/bot/exts/evergreen/movie.py
index f4356f33..0d535b03 100644
--- a/bot/exts/evergreen/movie.py
+++ b/bot/exts/evergreen/movie.py
@@ -199,5 +199,5 @@ class Movie(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load Movie Cog."""
+    """Load the Movie Cog."""
     bot.add_cog(Movie(bot))
diff --git a/bot/exts/evergreen/ping.py b/bot/exts/evergreen/ping.py
index 1332e3e6..71152d15 100644
--- a/bot/exts/evergreen/ping.py
+++ b/bot/exts/evergreen/ping.py
@@ -24,5 +24,5 @@ class Ping(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Ping cog."""
     bot.add_cog(Ping(bot))
diff --git a/bot/exts/evergreen/pythonfacts.py b/bot/exts/evergreen/pythonfacts.py
index bbc4eb17..1dd9b40d 100644
--- a/bot/exts/evergreen/pythonfacts.py
+++ b/bot/exts/evergreen/pythonfacts.py
@@ -30,5 +30,5 @@ class PythonFacts(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load PythonFacts Cog."""
+    """Load the PythonFacts Cog."""
     bot.add_cog(PythonFacts(bot))
diff --git a/bot/exts/evergreen/reddit.py b/bot/exts/evergreen/reddit.py
index ea77123e..ce22a864 100644
--- a/bot/exts/evergreen/reddit.py
+++ b/bot/exts/evergreen/reddit.py
@@ -125,5 +125,5 @@ class Reddit(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load the Cog."""
+    """Load the Reddit cog."""
     bot.add_cog(Reddit(bot))
diff --git a/bot/exts/evergreen/space.py b/bot/exts/evergreen/space.py
index 323ff659..b3f0016b 100644
--- a/bot/exts/evergreen/space.py
+++ b/bot/exts/evergreen/space.py
@@ -242,7 +242,7 @@ class Space(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load Space Cog."""
+    """Load the Space cog."""
     if not Tokens.nasa:
         logger.warning("Can't find NASA API key. Not loading Space Cog.")
         return
diff --git a/bot/exts/evergreen/tic_tac_toe.py b/bot/exts/evergreen/tic_tac_toe.py
index 6e21528e..15cc1ef3 100644
--- a/bot/exts/evergreen/tic_tac_toe.py
+++ b/bot/exts/evergreen/tic_tac_toe.py
@@ -323,5 +323,5 @@ class TicTacToe(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load TicTacToe Cog."""
+    """Load the TicTacToe cog."""
     bot.add_cog(TicTacToe(bot))
diff --git a/bot/exts/evergreen/timed.py b/bot/exts/evergreen/timed.py
index 35ca807c..42a77346 100644
--- a/bot/exts/evergreen/timed.py
+++ b/bot/exts/evergreen/timed.py
@@ -44,5 +44,5 @@ class TimedCommands(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Timed cog."""
     bot.add_cog(TimedCommands(bot))
diff --git a/bot/exts/evergreen/trivia_quiz.py b/bot/exts/evergreen/trivia_quiz.py
index 080f5b6f..f40375a6 100644
--- a/bot/exts/evergreen/trivia_quiz.py
+++ b/bot/exts/evergreen/trivia_quiz.py
@@ -301,5 +301,5 @@ class TriviaQuiz(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load the cog."""
+    """Load the TriviaQuiz cog."""
     bot.add_cog(TriviaQuiz(bot))
diff --git a/bot/exts/evergreen/uptime.py b/bot/exts/evergreen/uptime.py
index b8813bc7..c22af2c9 100644
--- a/bot/exts/evergreen/uptime.py
+++ b/bot/exts/evergreen/uptime.py
@@ -30,5 +30,5 @@ class Uptime(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Uptime Cog load."""
+    """Load the Uptime cog."""
     bot.add_cog(Uptime(bot))
diff --git a/bot/exts/evergreen/wikipedia.py b/bot/exts/evergreen/wikipedia.py
index 068c4f43..e2172fc3 100644
--- a/bot/exts/evergreen/wikipedia.py
+++ b/bot/exts/evergreen/wikipedia.py
@@ -90,5 +90,5 @@ class WikipediaSearch(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Wikipedia Cog load."""
+    """Load the WikipediaSearch cog."""
     bot.add_cog(WikipediaSearch(bot))
diff --git a/bot/exts/evergreen/xkcd.py b/bot/exts/evergreen/xkcd.py
index 1ff98ca2..ba9e46e0 100644
--- a/bot/exts/evergreen/xkcd.py
+++ b/bot/exts/evergreen/xkcd.py
@@ -87,5 +87,5 @@ class XKCD(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Loading the XKCD cog."""
+    """Load the XKCD cog."""
     bot.add_cog(XKCD(bot))
-- 
cgit v1.2.3


From f919e0cdb9cff71c187f55ea4447ef4934c5b9ab Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 21:17:10 +0100
Subject: chore(evergreen): remove unneeded cog constructors

---
 bot/exts/evergreen/bookmark.py             | 3 ---
 bot/exts/evergreen/conversationstarters.py | 3 ---
 bot/exts/evergreen/emoji.py                | 3 ---
 bot/exts/evergreen/error_handler.py        | 3 ---
 bot/exts/evergreen/magic_8ball.py          | 3 +--
 bot/exts/evergreen/minesweeper.py          | 2 +-
 bot/exts/evergreen/movie.py                | 1 -
 bot/exts/evergreen/pythonfacts.py          | 3 ---
 bot/exts/evergreen/source.py               | 3 ---
 bot/exts/evergreen/space.py                | 1 -
 bot/exts/evergreen/speedrun.py             | 3 ---
 bot/exts/evergreen/tic_tac_toe.py          | 3 +--
 bot/exts/evergreen/uptime.py               | 3 ---
 bot/exts/evergreen/wonder_twins.py         | 4 +---
 14 files changed, 4 insertions(+), 34 deletions(-)

(limited to 'bot/exts/evergreen/error_handler.py')

diff --git a/bot/exts/evergreen/bookmark.py b/bot/exts/evergreen/bookmark.py
index ec25e7a7..6a272784 100644
--- a/bot/exts/evergreen/bookmark.py
+++ b/bot/exts/evergreen/bookmark.py
@@ -14,9 +14,6 @@ log = logging.getLogger(__name__)
 class Bookmark(commands.Cog):
     """Creates personal bookmarks by relaying a message link to the user's DMs."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @commands.command(name="bookmark", aliases=("bm", "pin"))
     async def bookmark(
         self,
diff --git a/bot/exts/evergreen/conversationstarters.py b/bot/exts/evergreen/conversationstarters.py
index 04194c01..54fea0b3 100644
--- a/bot/exts/evergreen/conversationstarters.py
+++ b/bot/exts/evergreen/conversationstarters.py
@@ -35,9 +35,6 @@ TOPICS = {
 class ConvoStarters(commands.Cog):
     """Evergreen conversation topics."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @commands.command()
     @whitelist_override(channels=ALL_ALLOWED_CHANNELS)
     async def topic(self, ctx: commands.Context) -> None:
diff --git a/bot/exts/evergreen/emoji.py b/bot/exts/evergreen/emoji.py
index 7ceb6c8d..8e540712 100644
--- a/bot/exts/evergreen/emoji.py
+++ b/bot/exts/evergreen/emoji.py
@@ -20,9 +20,6 @@ log = logging.getLogger(__name__)
 class Emojis(commands.Cog):
     """A collection of commands related to emojis in the server."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @staticmethod
     def embed_builder(emoji: dict) -> Tuple[Embed, List[str]]:
         """Generates an embed with the emoji names and count."""
diff --git a/bot/exts/evergreen/error_handler.py b/bot/exts/evergreen/error_handler.py
index 64460822..dabd0ab5 100644
--- a/bot/exts/evergreen/error_handler.py
+++ b/bot/exts/evergreen/error_handler.py
@@ -18,9 +18,6 @@ log = logging.getLogger(__name__)
 class CommandErrorHandler(commands.Cog):
     """A error handler for the PythonDiscord server."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @staticmethod
     def revert_cooldown_counter(command: commands.Command, message: Message) -> None:
         """Undoes the last cooldown counter for user-error cases."""
diff --git a/bot/exts/evergreen/magic_8ball.py b/bot/exts/evergreen/magic_8ball.py
index 61c68693..708aa6d2 100644
--- a/bot/exts/evergreen/magic_8ball.py
+++ b/bot/exts/evergreen/magic_8ball.py
@@ -13,8 +13,7 @@ log = logging.getLogger(__name__)
 class Magic8ball(commands.Cog):
     """A Magic 8ball command to respond to a user's question."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
+    def __init__(self, _bot: Bot):
         with open(Path("bot/resources/evergreen/magic8ball.json"), "r", encoding="utf8") as file:
             self.answers = json.load(file)
 
diff --git a/bot/exts/evergreen/minesweeper.py b/bot/exts/evergreen/minesweeper.py
index bba349fa..d0cc28c5 100644
--- a/bot/exts/evergreen/minesweeper.py
+++ b/bot/exts/evergreen/minesweeper.py
@@ -79,7 +79,7 @@ GamesDict = typing.Dict[int, Game]
 class Minesweeper(commands.Cog):
     """Play a game of Minesweeper."""
 
-    def __init__(self, bot: Bot) -> None:
+    def __init__(self, _bot: Bot) -> None:
         self.games: GamesDict = {}  # Store the currently running games
 
     @commands.group(name='minesweeper', aliases=('ms',), invoke_without_command=True)
diff --git a/bot/exts/evergreen/movie.py b/bot/exts/evergreen/movie.py
index 0d535b03..488e5142 100644
--- a/bot/exts/evergreen/movie.py
+++ b/bot/exts/evergreen/movie.py
@@ -51,7 +51,6 @@ class Movie(Cog):
     """Movie Cog contains movies command that grab random movies from TMDB."""
 
     def __init__(self, bot: Bot):
-        self.bot = bot
         self.http_session: ClientSession = bot.http_session
 
     @group(name='movies', aliases=['movie'], invoke_without_command=True)
diff --git a/bot/exts/evergreen/pythonfacts.py b/bot/exts/evergreen/pythonfacts.py
index 1dd9b40d..73234d55 100644
--- a/bot/exts/evergreen/pythonfacts.py
+++ b/bot/exts/evergreen/pythonfacts.py
@@ -15,9 +15,6 @@ COLORS = itertools.cycle([Colours.python_blue, Colours.python_yellow])
 class PythonFacts(commands.Cog):
     """Sends a random fun fact about Python."""
 
-    def __init__(self, bot: Bot) -> None:
-        self.bot = bot
-
     @commands.command(name='pythonfact', aliases=['pyfact'])
     async def get_python_fact(self, ctx: commands.Context) -> None:
         """Sends a Random fun fact about Python."""
diff --git a/bot/exts/evergreen/source.py b/bot/exts/evergreen/source.py
index 3e6031a5..14fd02f3 100644
--- a/bot/exts/evergreen/source.py
+++ b/bot/exts/evergreen/source.py
@@ -32,9 +32,6 @@ class SourceConverter(commands.Converter):
 class BotSource(commands.Cog):
     """Displays information about the bot's source code."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @commands.command(name="source", aliases=("src",))
     async def source_command(self, ctx: commands.Context, *, source_item: SourceConverter = None) -> None:
         """Display information and a GitHub link to the source code of a command, tag, or cog."""
diff --git a/bot/exts/evergreen/space.py b/bot/exts/evergreen/space.py
index b3f0016b..ee9ad38c 100644
--- a/bot/exts/evergreen/space.py
+++ b/bot/exts/evergreen/space.py
@@ -39,7 +39,6 @@ class Space(Cog):
     """Space Cog contains commands, that show images, facts or other information about space."""
 
     def __init__(self, bot: Bot):
-        self.bot = bot
         self.http_session = bot.http_session
 
         self.rovers = {}
diff --git a/bot/exts/evergreen/speedrun.py b/bot/exts/evergreen/speedrun.py
index 27d944ca..bf6f2117 100644
--- a/bot/exts/evergreen/speedrun.py
+++ b/bot/exts/evergreen/speedrun.py
@@ -15,9 +15,6 @@ with Path('bot/resources/evergreen/speedrun_links.json').open(encoding="utf8") a
 class Speedrun(commands.Cog):
     """Commands about the video game speedrunning community."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @commands.command(name="speedrun")
     async def get_speedrun(self, ctx: commands.Context) -> None:
         """Sends a link to a video of a random speedrun."""
diff --git a/bot/exts/evergreen/tic_tac_toe.py b/bot/exts/evergreen/tic_tac_toe.py
index 15cc1ef3..1fef427a 100644
--- a/bot/exts/evergreen/tic_tac_toe.py
+++ b/bot/exts/evergreen/tic_tac_toe.py
@@ -246,8 +246,7 @@ def is_requester_free() -> t.Callable:
 class TicTacToe(Cog):
     """TicTacToe cog contains tic-tac-toe game commands."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
+    def __init__(self, _bot: Bot):
         self.games: t.List[Game] = []
 
     @guild_only()
diff --git a/bot/exts/evergreen/uptime.py b/bot/exts/evergreen/uptime.py
index c22af2c9..d2509e6f 100644
--- a/bot/exts/evergreen/uptime.py
+++ b/bot/exts/evergreen/uptime.py
@@ -13,9 +13,6 @@ log = logging.getLogger(__name__)
 class Uptime(commands.Cog):
     """A cog for posting the bot's uptime."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
     @commands.command(name="uptime")
     async def uptime(self, ctx: commands.Context) -> None:
         """Responds with the uptime of the bot."""
diff --git a/bot/exts/evergreen/wonder_twins.py b/bot/exts/evergreen/wonder_twins.py
index 80b9bb4d..9fa2d7f8 100644
--- a/bot/exts/evergreen/wonder_twins.py
+++ b/bot/exts/evergreen/wonder_twins.py
@@ -10,9 +10,7 @@ from bot.bot import Bot
 class WonderTwins(Cog):
     """Cog for a Wonder Twins inspired command."""
 
-    def __init__(self, bot: Bot):
-        self.bot = bot
-
+    def __init__(self, _bot: Bot):
         with open(Path.cwd() / "bot" / "resources" / "evergreen" / "wonder_twins.yaml", "r", encoding="utf-8") as f:
             info = yaml.load(f, Loader=yaml.FullLoader)
             self.water_types = info["water_types"]
-- 
cgit v1.2.3