diff options
| author | 2021-06-07 17:16:15 +0800 | |
|---|---|---|
| committer | 2021-06-07 17:16:15 +0800 | |
| commit | e73fb4a2ced2fd264ec65a828c114cbbeda26d7a (patch) | |
| tree | c468b60cbd00b8f6b00043635dc2d4393a001c4b /bot/exts/evergreen | |
| parent | (tic-tac-toe): Use embeds for showing previous game boards (diff) | |
| parent | Merge pull request #758 from OculusMode/master (diff) | |
Merge branch 'main' into fix/ttt
Diffstat (limited to 'bot/exts/evergreen')
38 files changed, 1193 insertions, 813 deletions
| diff --git a/bot/exts/evergreen/avatar_modification/_effects.py b/bot/exts/evergreen/avatar_modification/_effects.py index d2370b4b..b53b26f3 100644 --- a/bot/exts/evergreen/avatar_modification/_effects.py +++ b/bot/exts/evergreen/avatar_modification/_effects.py @@ -14,7 +14,7 @@ class PfpEffects:      """      Implements various image modifying effects, for the PfpModify cog. -    All of these fuctions are slow, and blocking, so they should be ran in executors. +    All of these functions are slow, and blocking, so they should be ran in executors.      """      @staticmethod @@ -102,7 +102,7 @@ class PfpEffects:          Applies the easter effect to the given image.          This is done by getting the closest "easter" colour to each pixel and changing the colour -        to the half-way RGBvalue. +        to the half-way RGB value.          We also then add an overlay image on top in middle right, a chocolate bunny by default.          """ @@ -251,7 +251,7 @@ class PfpEffects:          total_width = multiplier * single_wdith          total_height = multiplier * single_height -        new_image = Image.new('RGBA', (total_width, total_height), (250, 250, 250)) +        new_image = Image.new("RGBA", (total_width, total_height), (250, 250, 250))          width_multiplier = 0          height = 0 @@ -273,15 +273,15 @@ class PfpEffects:      @staticmethod      def mosaic_effect(img_bytes: bytes, squares: int, file_name: str) -> discord.File: -        """Seperate function run from an executor which turns an image into a mosaic.""" +        """Separate function run from an executor which turns an image into a mosaic."""          avatar = Image.open(BytesIO(img_bytes)) -        avatar = avatar.convert('RGBA').resize((1024, 1024)) +        avatar = avatar.convert("RGBA").resize((1024, 1024))          img_squares = PfpEffects.split_image(avatar, squares)          new_img = PfpEffects.join_images(img_squares)          bufferedio = BytesIO() -        new_img.save(bufferedio, format='PNG') +        new_img.save(bufferedio, format="PNG")          bufferedio.seek(0)          return discord.File(bufferedio, filename=file_name) diff --git a/bot/exts/evergreen/avatar_modification/avatar_modify.py b/bot/exts/evergreen/avatar_modification/avatar_modify.py index 693d15c7..17f34ed4 100644 --- a/bot/exts/evergreen/avatar_modification/avatar_modify.py +++ b/bot/exts/evergreen/avatar_modification/avatar_modify.py @@ -6,12 +6,13 @@ import string  import typing as t  import unicodedata  from concurrent.futures import ThreadPoolExecutor +from pathlib import Path  import discord  from aiohttp import client_exceptions  from discord.ext import commands -from discord.ext.commands.errors import BadArgument +from bot.bot import Bot  from bot.constants import Colours, Emojis  from bot.exts.evergreen.avatar_modification._effects import PfpEffects  from bot.utils.extensions import invoke_help_command @@ -27,13 +28,12 @@ MAX_SQUARES = 10_000  T = t.TypeVar("T") -with open("bot/resources/pride/gender_options.json") as f: -    GENDER_OPTIONS = json.load(f) +GENDER_OPTIONS = json.loads(Path("bot/resources/pride/gender_options.json").read_text("utf8"))  async def in_executor(func: t.Callable[..., T], *args) -> T:      """ -    Runs the given synchronus function `func` in an executor. +    Runs the given synchronous function `func` in an executor.      This is useful for running slow, blocking code within async      functions, so that they don't block the bot. @@ -63,7 +63,7 @@ def file_safe_name(effect: str, display_name: str) -> str:  class AvatarModify(commands.Cog):      """Various commands for users to apply affects to their own avatars.""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self, bot: Bot) -> None:          self.bot = bot      async def _fetch_user(self, user_id: int) -> t.Optional[discord.User]: @@ -71,7 +71,7 @@ class AvatarModify(commands.Cog):          Fetches a user and handles errors.          This helper function is required as the member cache doesn't always have the most up to date -        profile picture. This can lead to errors if the image is delted from the Discord CDN. +        profile picture. This can lead to errors if the image is deleted from the Discord CDN.          fetch_member can't be used due to the avatar url being part of the user object, and          some weird caching that D.py does          """ @@ -260,9 +260,9 @@ class AvatarModify(commands.Cog):                          return                      image_bytes = await response.read()              except client_exceptions.ClientConnectorError: -                raise BadArgument("Cannot connect to provided URL!") +                raise commands.BadArgument("Cannot connect to provided URL!")              except client_exceptions.InvalidURL: -                raise BadArgument("Invalid URL!") +                raise commands.BadArgument("Invalid URL!")              await self.send_pride_image(ctx, image_bytes, pixels, flag, option) @@ -365,6 +365,6 @@ class AvatarModify(commands.Cog):              await ctx.send(file=file, embed=embed) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the AvatarModify cog."""      bot.add_cog(AvatarModify(bot)) diff --git a/bot/exts/evergreen/battleship.py b/bot/exts/evergreen/battleship.py index 1681434f..c2f2079c 100644 --- a/bot/exts/evergreen/battleship.py +++ b/bot/exts/evergreen/battleship.py @@ -9,6 +9,7 @@ from functools import partial  import discord  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Colours  log = logging.getLogger(__name__) @@ -30,8 +31,8 @@ EmojiSet = typing.Dict[typing.Tuple[bool, bool], str]  class Player:      """Each player in the game - their messages for the boards and their current grid.""" -    user: discord.Member -    board: discord.Message +    user: typing.Optional[discord.Member] +    board: typing.Optional[discord.Message]      opponent_board: discord.Message      grid: Grid @@ -95,7 +96,7 @@ class Game:      def __init__(          self, -        bot: commands.Bot, +        bot: Bot,          channel: discord.TextChannel,          player1: discord.Member,          player2: discord.Member @@ -237,7 +238,7 @@ class Game:          square = None          turn_message = await self.turn.user.send(              "It's your turn! Type the square you want to fire at. Format it like this: A1\n" -            "Type `surrender` to give up" +            "Type `surrender` to give up."          )          await self.next.user.send("Their turn", delete_after=3.0)          while True: @@ -321,7 +322,7 @@ class Game:  class Battleship(commands.Cog):      """Play the classic game Battleship!""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self, bot: Bot) -> None:          self.bot = bot          self.games: typing.List[Game] = []          self.waiting: typing.List[discord.Member] = [] @@ -378,10 +379,12 @@ class Battleship(commands.Cog):          Make sure you have your DMs open so that the bot can message you.          """          if self.already_playing(ctx.author): -            return await ctx.send("You're already playing a game!") +            await ctx.send("You're already playing a game!") +            return          if ctx.author in self.waiting: -            return await ctx.send("You've already sent out a request for a player 2") +            await ctx.send("You've already sent out a request for a player 2.") +            return          announcement = await ctx.send(              "**Battleship**: A new game is about to start!\n" @@ -401,20 +404,22 @@ class Battleship(commands.Cog):          except asyncio.TimeoutError:              self.waiting.remove(ctx.author)              await announcement.delete() -            return await ctx.send(f"{ctx.author.mention} Seems like there's no one here to play...") +            await ctx.send(f"{ctx.author.mention} Seems like there's no one here to play...") +            return          if str(reaction.emoji) == CROSS_EMOJI:              self.waiting.remove(ctx.author)              await announcement.delete() -            return await ctx.send(f"{ctx.author.mention} Game cancelled.") +            await ctx.send(f"{ctx.author.mention} Game cancelled.") +            return          await announcement.delete()          self.waiting.remove(ctx.author)          if self.already_playing(ctx.author):              return +        game = Game(self.bot, ctx.channel, ctx.author, user) +        self.games.append(game)          try: -            game = Game(self.bot, ctx.channel, ctx.author, user) -            self.games.append(game)              await game.start_game()              self.games.remove(game)          except discord.Forbidden: @@ -425,11 +430,11 @@ class Battleship(commands.Cog):              self.games.remove(game)          except Exception:              # End the game in the event of an unforseen error so the players aren't stuck in a game -            await ctx.send(f"{ctx.author.mention} {user.mention} An error occurred. Game failed") +            await ctx.send(f"{ctx.author.mention} {user.mention} An error occurred. Game failed.")              self.games.remove(game)              raise -    @battleship.command(name="ships", aliases=["boats"]) +    @battleship.command(name="ships", aliases=("boats",))      async def battleship_ships(self, ctx: commands.Context) -> None:          """Lists the ships that are found on the battleship grid."""          embed = discord.Embed(colour=Colours.blue) @@ -438,6 +443,6 @@ class Battleship(commands.Cog):          await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: -    """Cog load.""" +def setup(bot: Bot) -> None: +    """Load the Battleship Cog."""      bot.add_cog(Battleship(bot)) diff --git a/bot/exts/evergreen/bookmark.py b/bot/exts/evergreen/bookmark.py index 7a97a40d..85c9b46f 100644 --- a/bot/exts/evergreen/bookmark.py +++ b/bot/exts/evergreen/bookmark.py @@ -1,6 +1,7 @@  import asyncio  import logging  import random +import typing as t  import discord  from discord.ext import commands @@ -88,15 +89,20 @@ class Bookmark(commands.Cog):      async def bookmark(          self,          ctx: commands.Context, -        target_message: WrappedMessageConverter, +        target_message: t.Optional[WrappedMessageConverter],          *,          title: str = "Bookmark"      ) -> None:          """Send the author a link to `target_message` via DMs.""" +        if not target_message: +            if not ctx.message.reference: +                raise commands.UserInputError("You must either provide a valid message to bookmark, or reply to one.") +            target_message = ctx.message.reference.resolved +          # Prevent users from bookmarking a message in a channel they don't have access to          permissions = ctx.author.permissions_in(target_message.channel)          if not permissions.read_messages: -            log.info(f"{ctx.author} tried to bookmark a message in #{target_message.channel} but has no permissions") +            log.info(f"{ctx.author} tried to bookmark a message in #{target_message.channel} but has no permissions.")              embed = discord.Embed(                  title=random.choice(ERROR_REPLIES),                  color=Colours.soft_red, diff --git a/bot/exts/evergreen/catify.py b/bot/exts/evergreen/catify.py index a175602f..32dfae09 100644 --- a/bot/exts/evergreen/catify.py +++ b/bot/exts/evergreen/catify.py @@ -5,6 +5,7 @@ from typing import Optional  from discord import AllowedMentions, Embed, Forbidden  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Cats, Colours, NEGATIVE_REPLIES  from bot.utils import helpers @@ -12,10 +13,7 @@ from bot.utils import helpers  class Catify(commands.Cog):      """Cog for the catify command.""" -    def __init__(self, bot: commands.Bot): -        self.bot = bot - -    @commands.command(aliases=["ᓚᘏᗢify", "ᓚᘏᗢ"]) +    @commands.command(aliases=("ᓚᘏᗢify", "ᓚᘏᗢ"))      @commands.cooldown(1, 5, commands.BucketType.user)      async def catify(self, ctx: commands.Context, *, text: Optional[str]) -> None:          """ @@ -83,6 +81,6 @@ class Catify(commands.Cog):              ) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Loads the catify cog.""" -    bot.add_cog(Catify(bot)) +    bot.add_cog(Catify()) diff --git a/bot/exts/evergreen/cheatsheet.py b/bot/exts/evergreen/cheatsheet.py index 3fe709d5..ae7793c9 100644 --- a/bot/exts/evergreen/cheatsheet.py +++ b/bot/exts/evergreen/cheatsheet.py @@ -8,6 +8,7 @@ from discord.ext import commands  from discord.ext.commands import BucketType, Context  from bot import constants +from bot.bot import Bot  from bot.constants import Categories, Channels, Colours, ERROR_REPLIES  from bot.utils.decorators import whitelist_override @@ -23,17 +24,17 @@ Unknown cheat sheet. Please try to reformulate your query.  If the problem persists send a message in <#{Channels.dev_contrib}>  """ -URL = 'https://cheat.sh/python/{search}' +URL = "https://cheat.sh/python/{search}"  ESCAPE_TT = str.maketrans({"`": "\\`"})  ANSI_RE = re.compile(r"\x1b\[.*?m")  # We need to pass headers as curl otherwise it would default to aiohttp which would return raw html. -HEADERS = {'User-Agent': 'curl/7.68.0'} +HEADERS = {"User-Agent": "curl/7.68.0"}  class CheatSheet(commands.Cog):      """Commands that sends a result of a cht.sh search in code blocks.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot):          self.bot = bot      @staticmethod @@ -60,14 +61,18 @@ class CheatSheet(commands.Cog):          body_space = min(1986 - len(url), 1000)          if len(body_text) > body_space: -            description = (f"**Result Of cht.sh**\n" -                           f"```python\n{body_text[:body_space]}\n" -                           f"... (truncated - too many lines)```\n" -                           f"Full results: {url} ") +            description = ( +                f"**Result Of cht.sh**\n" +                f"```python\n{body_text[:body_space]}\n" +                f"... (truncated - too many lines)```\n" +                f"Full results: {url} " +            )          else: -            description = (f"**Result Of cht.sh**\n" -                           f"```python\n{body_text}```\n" -                           f"{url}") +            description = ( +                f"**Result Of cht.sh**\n" +                f"```python\n{body_text}```\n" +                f"{url}" +            )          return False, description      @commands.command( @@ -102,6 +107,6 @@ class CheatSheet(commands.Cog):                  await ctx.send(content=description) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the CheatSheet cog."""      bot.add_cog(CheatSheet(bot)) diff --git a/bot/exts/evergreen/connect_four.py b/bot/exts/evergreen/connect_four.py index 7e3ec42b..5c82ffee 100644 --- a/bot/exts/evergreen/connect_four.py +++ b/bot/exts/evergreen/connect_four.py @@ -8,6 +8,7 @@ import emojis  from discord.ext import commands  from discord.ext.commands import guild_only +from bot.bot import Bot  from bot.constants import Emojis  NUMBERS = list(Emojis.number_emojis.values()) @@ -21,13 +22,13 @@ class Game:      """A Connect 4 Game."""      def __init__( -            self, -            bot: commands.Bot, -            channel: discord.TextChannel, -            player1: discord.Member, -            player2: typing.Optional[discord.Member], -            tokens: typing.List[str], -            size: int = 7 +        self, +        bot: Bot, +        channel: discord.TextChannel, +        player1: discord.Member, +        player2: typing.Optional[discord.Member], +        tokens: typing.List[str], +        size: int = 7      ) -> None:          self.bot = bot @@ -54,8 +55,8 @@ class Game:      async def print_grid(self) -> None:          """Formats and outputs the Connect Four grid to the channel."""          title = ( -            f'Connect 4: {self.player1.display_name}' -            f' VS {self.bot.user.display_name if isinstance(self.player2, AI) else self.player2.display_name}' +            f"Connect 4: {self.player1.display_name}" +            f" VS {self.bot.user.display_name if isinstance(self.player2, AI) else self.player2.display_name}"          )          rows = [" ".join(self.tokens[s] for s in row) for row in self.grid] @@ -66,7 +67,7 @@ class Game:          if self.message:              await self.message.edit(embed=embed)          else: -            self.message = await self.channel.send(content='Loading...') +            self.message = await self.channel.send(content="Loading...")              for emoji in self.unicode_numbers:                  await self.message.add_reaction(emoji)              await self.message.add_reaction(CROSS_EMOJI) @@ -180,7 +181,7 @@ class Game:  class AI:      """The Computer Player for Single-Player games.""" -    def __init__(self, bot: commands.Bot, game: Game) -> None: +    def __init__(self, bot: Bot, game: Game) -> None:          self.game = game          self.mention = bot.user.mention @@ -255,7 +256,7 @@ class AI:  class ConnectFour(commands.Cog):      """Connect Four. The Classic Vertical Four-in-a-row Game!""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self, bot: Bot) -> None:          self.bot = bot          self.games: typing.List[Game] = []          self.waiting: typing.List[discord.Member] = [] @@ -276,27 +277,29 @@ class ConnectFour(commands.Cog):              return False          if not self.min_board_size <= board_size <= self.max_board_size: -            await ctx.send(f"{board_size} is not a valid board size. A valid board size is " -                           f"between `{self.min_board_size}` and `{self.max_board_size}`.") +            await ctx.send( +                f"{board_size} is not a valid board size. A valid board size is " +                f"between `{self.min_board_size}` and `{self.max_board_size}`." +            )              return False          return True      def get_player( -            self, -            ctx: commands.Context, -            announcement: discord.Message, -            reaction: discord.Reaction, -            user: discord.Member +        self, +        ctx: commands.Context, +        announcement: discord.Message, +        reaction: discord.Reaction, +        user: discord.Member      ) -> bool:          """Predicate checking the criteria for the announcement message."""          if self.already_playing(ctx.author):  # If they've joined a game since requesting a player 2              return True  # Is dealt with later on          if ( -                user.id not in (ctx.me.id, ctx.author.id) -                and str(reaction.emoji) == Emojis.hand_raised -                and reaction.message.id == announcement.id +            user.id not in (ctx.me.id, ctx.author.id) +            and str(reaction.emoji) == Emojis.hand_raised +            and reaction.message.id == announcement.id          ):              if self.already_playing(user):                  self.bot.loop.create_task(ctx.send(f"{user.mention} You're already playing a game!")) @@ -313,9 +316,9 @@ class ConnectFour(commands.Cog):              return True          if ( -                user.id == ctx.author.id -                and str(reaction.emoji) == CROSS_EMOJI -                and reaction.message.id == announcement.id +            user.id == ctx.author.id +            and str(reaction.emoji) == CROSS_EMOJI +            and reaction.message.id == announcement.id          ):              return True          return False @@ -326,7 +329,7 @@ class ConnectFour(commands.Cog):      @staticmethod      def check_emojis( -            e1: EMOJI_CHECK, e2: EMOJI_CHECK +        e1: EMOJI_CHECK, e2: EMOJI_CHECK      ) -> typing.Tuple[bool, typing.Optional[str]]:          """Validate the emojis, the user put."""          if isinstance(e1, str) and emojis.count(e1) != 1: @@ -336,12 +339,12 @@ class ConnectFour(commands.Cog):          return True, None      async def _play_game( -            self, -            ctx: commands.Context, -            user: typing.Optional[discord.Member], -            board_size: int, -            emoji1: str, -            emoji2: str +        self, +        ctx: commands.Context, +        user: typing.Optional[discord.Member], +        board_size: int, +        emoji1: str, +        emoji2: str      ) -> None:          """Helper for playing a game of connect four."""          self.tokens = [":white_circle:", str(emoji1), str(emoji2)] @@ -354,7 +357,7 @@ class ConnectFour(commands.Cog):              self.games.remove(game)          except Exception:              # End the game in the event of an unforeseen error so the players aren't stuck in a game -            await ctx.send(f"{ctx.author.mention} {user.mention if user else ''} An error occurred. Game failed") +            await ctx.send(f"{ctx.author.mention} {user.mention if user else ''} An error occurred. Game failed.")              if game in self.games:                  self.games.remove(game)              raise @@ -362,15 +365,15 @@ class ConnectFour(commands.Cog):      @guild_only()      @commands.group(          invoke_without_command=True, -        aliases=["4inarow", "connect4", "connectfour", "c4"], +        aliases=("4inarow", "connect4", "connectfour", "c4"),          case_insensitive=True      )      async def connect_four( -            self, -            ctx: commands.Context, -            board_size: int = 7, -            emoji1: EMOJI_CHECK = "\U0001f535", -            emoji2: EMOJI_CHECK = "\U0001f534" +        self, +        ctx: commands.Context, +        board_size: int = 7, +        emoji1: EMOJI_CHECK = "\U0001f535", +        emoji2: EMOJI_CHECK = "\U0001f534"      ) -> None:          """          Play the classic game of Connect Four with someone! @@ -425,13 +428,13 @@ class ConnectFour(commands.Cog):          await self._play_game(ctx, user, board_size, str(emoji1), str(emoji2))      @guild_only() -    @connect_four.command(aliases=["bot", "computer", "cpu"]) +    @connect_four.command(aliases=("bot", "computer", "cpu"))      async def ai( -            self, -            ctx: commands.Context, -            board_size: int = 7, -            emoji1: EMOJI_CHECK = "\U0001f535", -            emoji2: EMOJI_CHECK = "\U0001f534" +        self, +        ctx: commands.Context, +        board_size: int = 7, +        emoji1: EMOJI_CHECK = "\U0001f535", +        emoji2: EMOJI_CHECK = "\U0001f534"      ) -> None:          """Play Connect Four against a computer player."""          check, emoji = self.check_emojis(emoji1, emoji2) @@ -445,6 +448,6 @@ class ConnectFour(commands.Cog):          await self._play_game(ctx, None, board_size, str(emoji1), str(emoji2)) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load ConnectFour Cog."""      bot.add_cog(ConnectFour(bot)) diff --git a/bot/exts/evergreen/conversationstarters.py b/bot/exts/evergreen/conversationstarters.py index e7058961..fdc4467a 100644 --- a/bot/exts/evergreen/conversationstarters.py +++ b/bot/exts/evergreen/conversationstarters.py @@ -4,11 +4,12 @@ import yaml  from discord import Color, Embed  from discord.ext import commands +from bot.bot import Bot  from bot.constants import WHITELISTED_CHANNELS  from bot.utils.decorators import whitelist_override  from bot.utils.randomization import RandomCycle -SUGGESTION_FORM = 'https://forms.gle/zw6kkJqv8U43Nfjg9' +SUGGESTION_FORM = "https://forms.gle/zw6kkJqv8U43Nfjg9"  with Path("bot/resources/evergreen/starter.yaml").open("r", encoding="utf8") as f:      STARTERS = yaml.load(f, Loader=yaml.FullLoader) @@ -24,9 +25,9 @@ with Path("bot/resources/evergreen/py_topics.yaml").open("r", encoding="utf8") a      ALL_ALLOWED_CHANNELS = list(PY_TOPICS.keys()) + list(WHITELISTED_CHANNELS)  # Putting all topics into one dictionary and shuffling lists to reduce same-topic repetitions. -ALL_TOPICS = {'default': STARTERS, **PY_TOPICS} +ALL_TOPICS = {"default": STARTERS, **PY_TOPICS}  TOPICS = { -    channel: RandomCycle(topics or ['No topics found for this channel.']) +    channel: RandomCycle(topics or ["No topics found for this channel."])      for channel, topics in ALL_TOPICS.items()  } @@ -34,9 +35,6 @@ TOPICS = {  class ConvoStarters(commands.Cog):      """Evergreen conversation topics.""" -    def __init__(self, bot: commands.Bot): -        self.bot = bot -      @commands.command()      @whitelist_override(channels=ALL_ALLOWED_CHANNELS)      async def topic(self, ctx: commands.Context) -> None: @@ -48,7 +46,7 @@ class ConvoStarters(commands.Cog):          Otherwise, a random conversation topic will be received by the user.          """          # No matter what, the form will be shown. -        embed = Embed(description=f'Suggest more topics [here]({SUGGESTION_FORM})!', color=Color.blurple()) +        embed = Embed(description=f"Suggest more topics [here]({SUGGESTION_FORM})!", color=Color.blurple())          try:              # Fetching topics. @@ -56,16 +54,16 @@ class ConvoStarters(commands.Cog):          # If the channel isn't Python-related.          except KeyError: -            embed.title = f'**{next(TOPICS["default"])}**' +            embed.title = f"**{next(TOPICS['default'])}**"          # If the channel ID doesn't have any topics.          else: -            embed.title = f'**{next(channel_topics)}**' +            embed.title = f"**{next(channel_topics)}**"          finally:              await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: -    """Conversation starters Cog load.""" -    bot.add_cog(ConvoStarters(bot)) +def setup(bot: Bot) -> None: +    """Load the ConvoStarters cog.""" +    bot.add_cog(ConvoStarters()) diff --git a/bot/exts/evergreen/emoji.py b/bot/exts/evergreen/emoji.py index fa3044e3..11615214 100644 --- a/bot/exts/evergreen/emoji.py +++ b/bot/exts/evergreen/emoji.py @@ -8,6 +8,7 @@ from typing import List, Optional, Tuple  from discord import Color, Embed, Emoji  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Colours, ERROR_REPLIES  from bot.utils.extensions import invoke_help_command  from bot.utils.pagination import LinePaginator @@ -19,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: commands.Bot): -        self.bot = bot -      @staticmethod      def embed_builder(emoji: dict) -> Tuple[Embed, List[str]]:          """Generates an embed with the emoji names and count.""" @@ -48,9 +46,9 @@ class Emojis(commands.Cog):                  else:                      emoji_info = f"There is **{len(category_emojis)}** emoji in the **{category_name}** category."                  if emoji_choice.animated: -                    msg.append(f'<a:{emoji_choice.name}:{emoji_choice.id}> {emoji_info}') +                    msg.append(f"<a:{emoji_choice.name}:{emoji_choice.id}> {emoji_info}")                  else: -                    msg.append(f'<:{emoji_choice.name}:{emoji_choice.id}> {emoji_info}') +                    msg.append(f"<:{emoji_choice.name}:{emoji_choice.id}> {emoji_info}")          return embed, msg      @staticmethod @@ -66,7 +64,7 @@ class Emojis(commands.Cog):          for emoji in emojis:              emoji_dict[emoji.name.split("_")[0]].append(emoji) -        error_comp = ', '.join(emoji_dict) +        error_comp = ", ".join(emoji_dict)          msg.append(f"These are the valid emoji categories:\n```{error_comp}```")          return embed, msg @@ -86,7 +84,7 @@ class Emojis(commands.Cog):          if not ctx.guild.emojis:              await ctx.send("No emojis found.")              return -        log.trace(f"Emoji Category {'' if category_query else 'not '}provided by the user") +        log.trace(f"Emoji Category {'' if category_query else 'not '}provided by the user.")          for emoji in ctx.guild.emojis:              emoji_category = emoji.name.split("_")[0] @@ -120,6 +118,6 @@ class Emojis(commands.Cog):          await ctx.send(embed=emoji_information) -def setup(bot: commands.Bot) -> None: -    """Add the Emojis cog into the bot.""" -    bot.add_cog(Emojis(bot)) +def setup(bot: Bot) -> None: +    """Load the Emojis cog.""" +    bot.add_cog(Emojis()) diff --git a/bot/exts/evergreen/error_handler.py b/bot/exts/evergreen/error_handler.py index 8db49748..5873fb83 100644 --- a/bot/exts/evergreen/error_handler.py +++ b/bot/exts/evergreen/error_handler.py @@ -1,3 +1,4 @@ +import difflib  import logging  import math  import random @@ -7,17 +8,21 @@ from discord import Embed, Message  from discord.ext import commands  from sentry_sdk import push_scope -from bot.constants import Channels, Colours, ERROR_REPLIES, NEGATIVE_REPLIES +from bot.bot import Bot +from bot.constants import Channels, Colours, ERROR_REPLIES, NEGATIVE_REPLIES, RedirectOutput  from bot.utils.decorators import InChannelCheckFailure, InMonthCheckFailure  from bot.utils.exceptions import UserNotPlayingError  log = logging.getLogger(__name__) +QUESTION_MARK_ICON = "https://cdn.discordapp.com/emojis/512367613339369475.png" + +  class CommandErrorHandler(commands.Cog):      """A error handler for the PythonDiscord server.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot) -> None:          self.bot = bot      @staticmethod @@ -41,8 +46,8 @@ class CommandErrorHandler(commands.Cog):      @commands.Cog.listener()      async def on_command_error(self, ctx: commands.Context, error: commands.CommandError) -> None: -        """Activates when a command opens an error.""" -        if getattr(error, 'handled', False): +        """Activates when a command raises an error.""" +        if getattr(error, "handled", False):              logging.debug(f"Command {ctx.command} had its error already handled locally; ignoring.")              return @@ -51,7 +56,7 @@ class CommandErrorHandler(commands.Cog):              parent_command = f"{ctx.command} "              ctx = subctx -        error = getattr(error, 'original', error) +        error = getattr(error, "original", error)          logging.debug(              f"Error Encountered: {type(error).__name__} - {str(error)}, "              f"Command: {ctx.command}, " @@ -60,6 +65,7 @@ class CommandErrorHandler(commands.Cog):          )          if isinstance(error, commands.CommandNotFound): +            await self.send_command_suggestion(ctx, ctx.invoked_with)              return          if isinstance(error, (InChannelCheckFailure, InMonthCheckFailure)): @@ -127,14 +133,40 @@ class CommandErrorHandler(commands.Cog):              scope.set_extra("full_message", ctx.message.content)              if ctx.guild is not None: -                scope.set_extra( -                    "jump_to", -                    f"https://discordapp.com/channels/{ctx.guild.id}/{ctx.channel.id}/{ctx.message.id}" -                ) +                scope.set_extra("jump_to", ctx.message.jump_url)              log.exception(f"Unhandled command error: {str(error)}", exc_info=error) - -def setup(bot: commands.Bot) -> None: -    """Error handler Cog load.""" +    async def send_command_suggestion(self, ctx: commands.Context, command_name: str) -> None: +        """Sends user similar commands if any can be found.""" +        raw_commands = [] +        for cmd in self.bot.walk_commands(): +            if not cmd.hidden: +                raw_commands += (cmd.name, *cmd.aliases) +        if similar_command_data := difflib.get_close_matches(command_name, raw_commands, 1): +            similar_command_name = similar_command_data[0] +            similar_command = self.bot.get_command(similar_command_name) + +            if not similar_command: +                return + +            log_msg = "Cancelling attempt to suggest a command due to failed checks." +            try: +                if not await similar_command.can_run(ctx): +                    log.debug(log_msg) +                    return +            except commands.errors.CommandError as cmd_error: +                log.debug(log_msg) +                await self.on_command_error(ctx, cmd_error) +                return + +            misspelled_content = ctx.message.content +            e = Embed() +            e.set_author(name="Did you mean:", icon_url=QUESTION_MARK_ICON) +            e.description = misspelled_content.replace(command_name, similar_command_name, 1) +            await ctx.send(embed=e, delete_after=RedirectOutput.delete_delay) + + +def setup(bot: Bot) -> None: +    """Load the ErrorHandler cog."""      bot.add_cog(CommandErrorHandler(bot)) diff --git a/bot/exts/evergreen/fun.py b/bot/exts/evergreen/fun.py index 7152d0cb..3b266e1b 100644 --- a/bot/exts/evergreen/fun.py +++ b/bot/exts/evergreen/fun.py @@ -7,9 +7,10 @@ from typing import Callable, Iterable, Tuple, Union  from discord import Embed, Message  from discord.ext import commands -from discord.ext.commands import BadArgument, Bot, Cog, Context, MessageConverter, clean_content +from discord.ext.commands import BadArgument, Cog, Context, MessageConverter, clean_content  from bot import utils +from bot.bot import Bot  from bot.constants import Client, Colours, Emojis  from bot.utils import helpers @@ -55,8 +56,7 @@ class Fun(Cog):      def __init__(self, bot: Bot) -> None:          self.bot = bot -        with Path("bot/resources/evergreen/caesar_info.json").open("r", encoding="UTF-8") as f: -            self._caesar_cipher_embed = json.load(f) +        self._caesar_cipher_embed = json.loads(Path("bot/resources/evergreen/caesar_info.json").read_text("UTF-8"))      @staticmethod      def _get_random_die() -> str: @@ -242,6 +242,6 @@ class Fun(Cog):          return Embed.from_dict(embed_dict) -def setup(bot: commands.Bot) -> None: -    """Fun Cog load.""" +def setup(bot: Bot) -> None: +    """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..32fe9263 100644 --- a/bot/exts/evergreen/game.py +++ b/bot/exts/evergreen/game.py @@ -176,7 +176,7 @@ class Games(Cog):                              "Invalid OAuth credentials. Unloading Games cog. "                              f"OAuth response message: {result['message']}"                          ) -                        self.bot.remove_cog('Games') +                        self.bot.remove_cog("Games")                      return @@ -224,8 +224,8 @@ class Games(Cog):              else:                  self.genres[genre_name] = genre -    @group(name="games", aliases=["game"], invoke_without_command=True) -    async def games(self, ctx: Context, amount: Optional[int] = 5, *, genre: Optional[str] = None) -> None: +    @group(name="games", aliases=("game",), invoke_without_command=True) +    async def games(self, ctx: Context, amount: Optional[int] = 5, *, genre: Optional[str]) -> None:          """          Get random game(s) by genre from IGDB. Use .games genres command to get all available genres. @@ -277,7 +277,7 @@ class Games(Cog):          await ImagePaginator.paginate(pages, ctx, Embed(title=f"Random {genre.title()} Games")) -    @games.command(name="top", aliases=["t"]) +    @games.command(name="top", aliases=("t",))      async def top(self, ctx: Context, amount: int = 10) -> None:          """          Get current Top games in IGDB. @@ -294,19 +294,19 @@ class Games(Cog):          pages = [await self.create_page(game) for game in games]          await ImagePaginator.paginate(pages, ctx, Embed(title=f"Top {amount} Games")) -    @games.command(name="genres", aliases=["genre", "g"]) +    @games.command(name="genres", aliases=("genre", "g"))      async def genres(self, ctx: Context) -> None:          """Get all available genres."""          await ctx.send(f"Currently available genres: {', '.join(f'`{genre}`' for genre in self.genres)}") -    @games.command(name="search", aliases=["s"]) +    @games.command(name="search", aliases=("s",))      async def search(self, ctx: Context, *, search_term: str) -> None:          """Find games by name."""          lines = await self.search_games(search_term)          await LinePaginator.paginate(lines, ctx, Embed(title=f"Game Search Results: {search_term}"), empty=False) -    @games.command(name="company", aliases=["companies"]) +    @games.command(name="company", aliases=("companies",))      async def company(self, ctx: Context, amount: int = 5) -> None:          """          Get random Game Companies companies from IGDB API. @@ -325,7 +325,7 @@ class Games(Cog):          await ImagePaginator.paginate(pages, ctx, Embed(title="Random Game Companies"))      @with_role(*STAFF_ROLES) -    @games.command(name="refresh", aliases=["r"]) +    @games.command(name="refresh", aliases=("r",))      async def refresh_genres_command(self, ctx: Context) -> None:          """Refresh .games command genres."""          try: @@ -335,13 +335,14 @@ class Games(Cog):              return          await ctx.send("Successfully refreshed genres.") -    async def get_games_list(self, -                             amount: int, -                             genre: Optional[str] = None, -                             sort: Optional[str] = None, -                             additional_body: str = "", -                             offset: int = 0 -                             ) -> List[Dict[str, Any]]: +    async def get_games_list( +        self, +        amount: int, +        genre: Optional[str] = None, +        sort: Optional[str] = None, +        additional_body: str = "", +        offset: int = 0 +    ) -> List[Dict[str, Any]]:          """          Get list of games from IGDB API by parameters that is provided. @@ -373,8 +374,10 @@ class Games(Cog):          release_date = dt.utcfromtimestamp(data["first_release_date"]).date() if "first_release_date" in data else "?"          # Create Age Ratings value -        rating = ", ".join(f"{AgeRatingCategories(age['category']).name} {AgeRatings(age['rating']).name}" -                           for age in data["age_ratings"]) if "age_ratings" in data else "?" +        rating = ", ".join( +            f"{AgeRatingCategories(age['category']).name} {AgeRatings(age['rating']).name}" +            for age in data["age_ratings"] +        ) if "age_ratings" in data else "?"          companies = [c["company"]["name"] for c in data["involved_companies"]] if "involved_companies" in data else "?" @@ -471,7 +474,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 c8a6b3f7..27e607e5 100644 --- a/bot/exts/evergreen/githubinfo.py +++ b/bot/exts/evergreen/githubinfo.py @@ -5,8 +5,8 @@ from urllib.parse import quote  import discord  from discord.ext import commands -from discord.ext.commands.cooldowns import BucketType +from bot.bot import Bot  from bot.constants import Colours, NEGATIVE_REPLIES  from bot.exts.utils.extensions import invoke_help_command @@ -18,7 +18,7 @@ GITHUB_API_URL = "https://api.github.com"  class GithubInfo(commands.Cog):      """Fetches info from GitHub.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot):          self.bot = bot      async def fetch_data(self, url: str) -> dict: @@ -26,14 +26,14 @@ class GithubInfo(commands.Cog):          async with self.bot.http_session.get(url) as r:              return await r.json() -    @commands.group(name='github', aliases=('gh', 'git')) -    @commands.cooldown(1, 10, BucketType.user) +    @commands.group(name="github", aliases=("gh", "git")) +    @commands.cooldown(1, 10, commands.BucketType.user)      async def github_group(self, ctx: commands.Context) -> None:          """Commands for finding information related to GitHub."""          if ctx.invoked_subcommand is None:              await invoke_help_command(ctx) -    @github_group.command(name='user', aliases=('userinfo',)) +    @github_group.command(name="user", aliases=("userinfo",))      async def github_user_info(self, ctx: commands.Context, username: str) -> None:          """Fetches a user's GitHub information."""          async with ctx.typing(): @@ -50,31 +50,31 @@ class GithubInfo(commands.Cog):                  await ctx.send(embed=embed)                  return -            org_data = await self.fetch_data(user_data['organizations_url']) +            org_data = await self.fetch_data(user_data["organizations_url"])              orgs = [f"[{org['login']}](https://github.com/{org['login']})" for org in org_data] -            orgs_to_add = ' | '.join(orgs) +            orgs_to_add = " | ".join(orgs) -            gists = user_data['public_gists'] +            gists = user_data["public_gists"]              # Forming blog link -            if user_data['blog'].startswith("http"):  # Blog link is complete -                blog = user_data['blog'] -            elif user_data['blog']:  # Blog exists but the link is not complete +            if user_data["blog"].startswith("http"):  # Blog link is complete +                blog = user_data["blog"] +            elif user_data["blog"]:  # Blog exists but the link is not complete                  blog = f"https://{user_data['blog']}"              else:                  blog = "No website link available"              embed = discord.Embed(                  title=f"`{user_data['login']}`'s GitHub profile info", -                description=f"```{user_data['bio']}```\n" if user_data['bio'] is not None else "", +                description=f"```{user_data['bio']}```\n" if user_data["bio"] else "",                  colour=discord.Colour.blurple(), -                url=user_data['html_url'], -                timestamp=datetime.strptime(user_data['created_at'], "%Y-%m-%dT%H:%M:%SZ") +                url=user_data["html_url"], +                timestamp=datetime.strptime(user_data["created_at"], "%Y-%m-%dT%H:%M:%SZ")              ) -            embed.set_thumbnail(url=user_data['avatar_url']) +            embed.set_thumbnail(url=user_data["avatar_url"])              embed.set_footer(text="Account created at") -            if user_data['type'] == "User": +            if user_data["type"] == "User":                  embed.add_field(                      name="Followers", @@ -90,12 +90,12 @@ class GithubInfo(commands.Cog):                  value=f"[{user_data['public_repos']}]({user_data['html_url']}?tab=repositories)"              ) -            if user_data['type'] == "User": +            if user_data["type"] == "User":                  embed.add_field(name="Gists", value=f"[{gists}](https://gist.github.com/{quote(username, safe='')})")                  embed.add_field(                      name=f"Organization{'s' if len(orgs)!=1 else ''}", -                    value=orgs_to_add if orgs else "No organizations" +                    value=orgs_to_add if orgs else "No organizations."                  )              embed.add_field(name="Website", value=blog) @@ -108,8 +108,8 @@ class GithubInfo(commands.Cog):          The repository should look like `user/reponame` or `user reponame`.          """ -        repo = '/'.join(repo) -        if repo.count('/') != 1: +        repo = "/".join(repo) +        if repo.count("/") != 1:              embed = discord.Embed(                  title=random.choice(NEGATIVE_REPLIES),                  description="The repository should look like `user/reponame` or `user reponame`.", @@ -134,10 +134,10 @@ class GithubInfo(commands.Cog):                  return          embed = discord.Embed( -            title=repo_data['name'], +            title=repo_data["name"],              description=repo_data["description"],              colour=discord.Colour.blurple(), -            url=repo_data['html_url'] +            url=repo_data["html_url"]          )          # If it's a fork, then it will have a parent key @@ -147,7 +147,7 @@ class GithubInfo(commands.Cog):          except KeyError:              log.debug("Repository is not a fork.") -        repo_owner = repo_data['owner'] +        repo_owner = repo_data["owner"]          embed.set_author(              name=repo_owner["login"], @@ -155,8 +155,8 @@ class GithubInfo(commands.Cog):              icon_url=repo_owner["avatar_url"]          ) -        repo_created_at = datetime.strptime(repo_data['created_at'], "%Y-%m-%dT%H:%M:%SZ").strftime("%d/%m/%Y") -        last_pushed = datetime.strptime(repo_data['pushed_at'], "%Y-%m-%dT%H:%M:%SZ").strftime("%d/%m/%Y at %H:%M") +        repo_created_at = datetime.strptime(repo_data["created_at"], "%Y-%m-%dT%H:%M:%SZ").strftime("%d/%m/%Y") +        last_pushed = datetime.strptime(repo_data["pushed_at"], "%Y-%m-%dT%H:%M:%SZ").strftime("%d/%m/%Y at %H:%M")          embed.set_footer(              text=( @@ -170,6 +170,6 @@ class GithubInfo(commands.Cog):          await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: -    """Adding the cog to the bot.""" +def setup(bot: Bot) -> None: +    """Load the GithubInfo cog."""      bot.add_cog(GithubInfo(bot)) diff --git a/bot/exts/evergreen/help.py b/bot/exts/evergreen/help.py index f557e42e..3c9ba4d2 100644 --- a/bot/exts/evergreen/help.py +++ b/bot/exts/evergreen/help.py @@ -2,9 +2,8 @@  import asyncio  import itertools  import logging -from collections import namedtuple  from contextlib import suppress -from typing import Union +from typing import List, NamedTuple, Union  from discord import Colour, Embed, HTTPException, Message, Reaction, User  from discord.ext import commands @@ -22,14 +21,21 @@ from bot.utils.pagination import (  DELETE_EMOJI = Emojis.trashcan  REACTIONS = { -    FIRST_EMOJI: 'first', -    LEFT_EMOJI: 'back', -    RIGHT_EMOJI: 'next', -    LAST_EMOJI: 'end', -    DELETE_EMOJI: 'stop', +    FIRST_EMOJI: "first", +    LEFT_EMOJI: "back", +    RIGHT_EMOJI: "next", +    LAST_EMOJI: "end", +    DELETE_EMOJI: "stop",  } -Cog = namedtuple('Cog', ['name', 'description', 'commands']) + +class Cog(NamedTuple): +    """Show information about a Cog's name, description and commands.""" + +    name: str +    description: str +    commands: List[Command] +  log = logging.getLogger(__name__) @@ -87,7 +93,7 @@ class HelpSession:          # set the query details for the session          if command: -            query_str = ' '.join(command) +            query_str = " ".join(command)              self.query = self._get_query(query_str)              self.description = self.query.description or self.query.help          else: @@ -191,7 +197,7 @@ class HelpSession:          self.reset_timeout()          # Run relevant action method -        action = getattr(self, f'do_{REACTIONS[emoji]}', None) +        action = getattr(self, f"do_{REACTIONS[emoji]}", None)          if action:              await action() @@ -234,11 +240,11 @@ class HelpSession:          if cmd.cog:              try:                  if cmd.cog.category: -                    return f'**{cmd.cog.category}**' +                    return f"**{cmd.cog.category}**"              except AttributeError:                  pass -            return f'**{cmd.cog_name}**' +            return f"**{cmd.cog_name}**"          else:              return "**\u200bNo Category:**" @@ -262,141 +268,143 @@ class HelpSession:                  # if default is not an empty string or None                  if show_default: -                    results.append(f'[{name}={param.default}]') +                    results.append(f"[{name}={param.default}]")                  else: -                    results.append(f'[{name}]') +                    results.append(f"[{name}]")              # if variable length argument              elif param.kind == param.VAR_POSITIONAL: -                results.append(f'[{name}...]') +                results.append(f"[{name}...]")              # if required              else: -                results.append(f'<{name}>') +                results.append(f"<{name}>")          return f"{cmd.name} {' '.join(results)}"      async def build_pages(self) -> None:          """Builds the list of content pages to be paginated through in the help message, as a list of str."""          # Use LinePaginator to restrict embed line height -        paginator = LinePaginator(prefix='', suffix='', max_lines=self._max_lines) - -        prefix = constants.Client.prefix +        paginator = LinePaginator(prefix="", suffix="", max_lines=self._max_lines)          # show signature if query is a command          if isinstance(self.query, commands.Command): -            signature = self._get_command_params(self.query) -            parent = self.query.full_parent_name + ' ' if self.query.parent else '' -            paginator.add_line(f'**```{prefix}{parent}{signature}```**') - -            aliases = [f"`{alias}`" if not parent else f"`{parent} {alias}`" for alias in self.query.aliases] -            aliases += [f"`{alias}`" for alias in getattr(self.query, "root_aliases", ())] -            aliases = ", ".join(sorted(aliases)) -            if aliases: -                paginator.add_line(f'**Can also use:** {aliases}\n') - -            if not await self.query.can_run(self._ctx): -                paginator.add_line('***You cannot run this command.***\n') +            await self._add_command_signature(paginator)          if isinstance(self.query, Cog): -            paginator.add_line(f'**{self.query.name}**') +            paginator.add_line(f"**{self.query.name}**")          if self.description: -            paginator.add_line(f'*{self.description}*') +            paginator.add_line(f"*{self.description}*")          # list all children commands of the queried object          if isinstance(self.query, (commands.GroupMixin, Cog)): +            await self._list_child_commands(paginator) -            # remove hidden commands if session is not wanting hiddens -            if not self._show_hidden: -                filtered = [c for c in self.query.commands if not c.hidden] -            else: -                filtered = self.query.commands - -            # if after filter there are no commands, finish up -            if not filtered: -                self._pages = paginator.pages -                return - -            if isinstance(self.query, Cog): -                grouped = (('**Commands:**', self.query.commands),) - -            elif isinstance(self.query, commands.Command): -                grouped = (('**Subcommands:**', self.query.commands),) - -                # don't show prefix for subcommands -                prefix = '' +        self._pages = paginator.pages -            # otherwise sort and organise all commands into categories -            else: -                cat_sort = sorted(filtered, key=self._category_key) -                grouped = itertools.groupby(cat_sort, key=self._category_key) +    async def _add_command_signature(self, paginator: LinePaginator) -> None: +        prefix = constants.Client.prefix -            for category, cmds in grouped: -                cmds = sorted(cmds, key=lambda c: c.name) +        signature = self._get_command_params(self.query) +        parent = self.query.full_parent_name + " " if self.query.parent else "" +        paginator.add_line(f"**```{prefix}{parent}{signature}```**") +        aliases = [f"`{alias}`" if not parent else f"`{parent} {alias}`" for alias in self.query.aliases] +        aliases += [f"`{alias}`" for alias in getattr(self.query, "root_aliases", ())] +        aliases = ", ".join(sorted(aliases)) +        if aliases: +            paginator.add_line(f"**Can also use:** {aliases}\n") +        if not await self.query.can_run(self._ctx): +            paginator.add_line("***You cannot run this command.***\n") + +    async def _list_child_commands(self, paginator: LinePaginator) -> None: +        # remove hidden commands if session is not wanting hiddens +        if not self._show_hidden: +            filtered = [c for c in self.query.commands if not c.hidden] +        else: +            filtered = self.query.commands -                if len(cmds) == 0: -                    continue +        # if after filter there are no commands, finish up +        if not filtered: +            self._pages = paginator.pages +            return -                cat_cmds = [] +        if isinstance(self.query, Cog): +            grouped = (("**Commands:**", self.query.commands),) -                for command in cmds: +        elif isinstance(self.query, commands.Command): +            grouped = (("**Subcommands:**", self.query.commands),) -                    # skip if hidden and hide if session is set to -                    if command.hidden and not self._show_hidden: -                        continue +        # otherwise sort and organise all commands into categories +        else: +            cat_sort = sorted(filtered, key=self._category_key) +            grouped = itertools.groupby(cat_sort, key=self._category_key) -                    # see if the user can run the command -                    strikeout = '' +        for category, cmds in grouped: +            await self._format_command_category(paginator, category, list(cmds)) -                    # Patch to make the !help command work outside of #bot-commands again -                    # This probably needs a proper rewrite, but this will make it work in -                    # the mean time. -                    try: -                        can_run = await command.can_run(self._ctx) -                    except CheckFailure: -                        can_run = False +    async def _format_command_category(self, paginator: LinePaginator, category: str, cmds: List[Command]) -> None: +        cmds = sorted(cmds, key=lambda c: c.name) +        cat_cmds = [] +        for command in cmds: +            cat_cmds += await self._format_command(command) -                    if not can_run: -                        # skip if we don't show commands they can't run -                        if self._only_can_run: -                            continue -                        strikeout = '~~' +        # state var for if the category should be added next +        print_cat = 1 +        new_page = True -                    signature = self._get_command_params(command) -                    info = f"{strikeout}**`{prefix}{signature}`**{strikeout}" +        for details in cat_cmds: -                    # handle if the command has no docstring -                    if command.short_doc: -                        cat_cmds.append(f'{info}\n*{command.short_doc}*') -                    else: -                        cat_cmds.append(f'{info}\n*No details provided.*') +            # keep details together, paginating early if it won"t fit +            lines_adding = len(details.split("\n")) + print_cat +            if paginator._linecount + lines_adding > self._max_lines: +                paginator._linecount = 0 +                new_page = True +                paginator.close_page() -                # state var for if the category should be added next +                # new page so print category title again                  print_cat = 1 -                new_page = True -                for details in cat_cmds: +            if print_cat: +                if new_page: +                    paginator.add_line("") +                paginator.add_line(category) +                print_cat = 0 + +            paginator.add_line(details) -                    # keep details together, paginating early if it won't fit -                    lines_adding = len(details.split('\n')) + print_cat -                    if paginator._linecount + lines_adding > self._max_lines: -                        paginator._linecount = 0 -                        new_page = True -                        paginator.close_page() +    async def _format_command(self, command: Command) -> List[str]: +        # skip if hidden and hide if session is set to +        if command.hidden and not self._show_hidden: +            return [] -                        # new page so print category title again -                        print_cat = 1 +        # Patch to make the !help command work outside of #bot-commands again +        # This probably needs a proper rewrite, but this will make it work in +        # the mean time. +        try: +            can_run = await command.can_run(self._ctx) +        except CheckFailure: +            can_run = False + +        # see if the user can run the command +        strikeout = "" +        if not can_run: +            # skip if we don't show commands they can't run +            if self._only_can_run: +                return [] +            strikeout = "~~" -                    if print_cat: -                        if new_page: -                            paginator.add_line('') -                        paginator.add_line(category) -                        print_cat = 0 +        if isinstance(self.query, commands.Command): +            prefix = "" +        else: +            prefix = constants.Client.prefix -                    paginator.add_line(details) +        signature = self._get_command_params(command) +        info = f"{strikeout}**`{prefix}{signature}`**{strikeout}" -        self._pages = paginator.pages +        # handle if the command has no docstring +        short_doc = command.short_doc or "No details provided" +        return [f"{info}\n*{short_doc}*"]      def embed_page(self, page_number: int = 0) -> Embed:          """Returns an Embed with the requested page formatted within.""" @@ -412,7 +420,7 @@ class HelpSession:          page_count = len(self._pages)          if page_count > 1: -            embed.set_footer(text=f'Page {self._current_page+1} / {page_count}') +            embed.set_footer(text=f"Page {self._current_page+1} / {page_count}")          return embed @@ -496,7 +504,7 @@ class HelpSession:  class Help(DiscordCog):      """Custom Embed Pagination Help feature.""" -    @commands.command('help') +    @commands.command("help")      async def new_help(self, ctx: Context, *commands) -> None:          """Shows Command Help."""          try: @@ -507,8 +515,8 @@ class Help(DiscordCog):              embed.title = str(error)              if error.possible_matches: -                matches = '\n'.join(error.possible_matches.keys()) -                embed.description = f'**Did you mean:**\n`{matches}`' +                matches = "\n".join(error.possible_matches.keys()) +                embed.description = f"**Did you mean:**\n`{matches}`"              await ctx.send(embed=embed) @@ -519,7 +527,7 @@ def unload(bot: Bot) -> None:      This is run if the cog raises an exception on load, or if the extension is unloaded.      """ -    bot.remove_command('help') +    bot.remove_command("help")      bot.add_command(bot._old_help) @@ -534,8 +542,8 @@ def setup(bot: Bot) -> None:      If an exception is raised during the loading of the cog, `unload` will be called in order to      reinstate the original help command.      """ -    bot._old_help = bot.get_command('help') -    bot.remove_command('help') +    bot._old_help = bot.get_command("help") +    bot.remove_command("help")      try:          bot.add_cog(Help()) diff --git a/bot/exts/evergreen/issues.py b/bot/exts/evergreen/issues.py index a0316080..b67aa4a6 100644 --- a/bot/exts/evergreen/issues.py +++ b/bot/exts/evergreen/issues.py @@ -7,6 +7,7 @@ from dataclasses import dataclass  import discord  from discord.ext import commands +from bot.bot import Bot  from bot.constants import (      Categories,      Channels, @@ -91,7 +92,7 @@ class IssueState:  class Issues(commands.Cog):      """Cog that allows users to retrieve issues from GitHub.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot):          self.bot = bot          self.repos = [] @@ -157,13 +158,13 @@ class Issues(commands.Cog):          issue_url = json_data.get("html_url") -        return IssueState(repository, number, issue_url, json_data.get('title', ''), emoji) +        return IssueState(repository, number, issue_url, json_data.get("title", ""), emoji)      @staticmethod      def format_embed( -            results: t.List[t.Union[IssueState, FetchError]], -            user: str, -            repository: t.Optional[str] = None +        results: t.List[t.Union[IssueState, FetchError]], +        user: str, +        repository: t.Optional[str] = None      ) -> discord.Embed:          """Take a list of IssueState or FetchError and format a Discord embed for them."""          description_list = [] @@ -176,7 +177,7 @@ class Issues(commands.Cog):          resp = discord.Embed(              colour=Colours.bright_green, -            description='\n'.join(description_list) +            description="\n".join(description_list)          )          embed_url = f"https://github.com/{user}/{repository}" if repository else f"https://github.com/{user}" @@ -186,11 +187,11 @@ class Issues(commands.Cog):      @whitelist_override(channels=WHITELISTED_CHANNELS, categories=WHITELISTED_CATEGORIES)      @commands.command(aliases=("pr",))      async def issue( -            self, -            ctx: commands.Context, -            numbers: commands.Greedy[int], -            repository: str = "sir-lancebot", -            user: str = "python-discord" +        self, +        ctx: commands.Context, +        numbers: commands.Greedy[int], +        repository: str = "sir-lancebot", +        user: str = "python-discord"      ) -> None:          """Command to retrieve issue(s) from a GitHub repository."""          # Remove duplicates @@ -269,6 +270,6 @@ class Issues(commands.Cog):          await message.channel.send(embed=resp) -def setup(bot: commands.Bot) -> None: -    """Cog Retrieves Issues From Github.""" +def setup(bot: Bot) -> None: +    """Load the Issues cog."""      bot.add_cog(Issues(bot)) diff --git a/bot/exts/evergreen/latex.py b/bot/exts/evergreen/latex.py index c4a8597c..36c7e0ab 100644 --- a/bot/exts/evergreen/latex.py +++ b/bot/exts/evergreen/latex.py @@ -9,6 +9,8 @@ import discord  import matplotlib.pyplot as plt  from discord.ext import commands +from bot.bot import Bot +  # configure fonts and colors for matplotlib  plt.rcParams.update(      { @@ -89,6 +91,11 @@ class Latex(commands.Cog):              await ctx.send(file=discord.File(image, "latex.png")) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the Latex Cog.""" -    bot.add_cog(Latex(bot)) +    # As we have resource issues on this cog, +    # we have it currently disabled while we fix it. +    import logging +    logging.info("Latex cog is currently disabled. It won't be loaded.") +    return +    bot.add_cog(Latex()) diff --git a/bot/exts/evergreen/magic_8ball.py b/bot/exts/evergreen/magic_8ball.py index f974e487..28ddcea0 100644 --- a/bot/exts/evergreen/magic_8ball.py +++ b/bot/exts/evergreen/magic_8ball.py @@ -5,27 +5,26 @@ from pathlib import Path  from discord.ext import commands +from bot.bot import Bot +  log = logging.getLogger(__name__) +ANSWERS = json.loads(Path("bot/resources/evergreen/magic8ball.json").read_text("utf8")) +  class Magic8ball(commands.Cog):      """A Magic 8ball command to respond to a user's question.""" -    def __init__(self, bot: commands.Bot): -        self.bot = bot -        with open(Path("bot/resources/evergreen/magic8ball.json"), "r", encoding="utf8") as file: -            self.answers = json.load(file) -      @commands.command(name="8ball")      async def output_answer(self, ctx: commands.Context, *, question: str) -> None:          """Return a Magic 8ball answer from answers list."""          if len(question.split()) >= 3: -            answer = random.choice(self.answers) +            answer = random.choice(ANSWERS)              await ctx.send(answer)          else:              await ctx.send("Usage: .8ball <question> (minimum length of 3 eg: `will I win?`)") -def setup(bot: commands.Bot) -> None: -    """Magic 8ball Cog load.""" -    bot.add_cog(Magic8ball(bot)) +def setup(bot: Bot) -> None: +    """Load the Magic8Ball Cog.""" +    bot.add_cog(Magic8ball()) diff --git a/bot/exts/evergreen/minesweeper.py b/bot/exts/evergreen/minesweeper.py index 3031debc..932358f9 100644 --- a/bot/exts/evergreen/minesweeper.py +++ b/bot/exts/evergreen/minesweeper.py @@ -6,7 +6,9 @@ from random import randint, random  import discord  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Client +from bot.utils.converters import CoordinateConverter  from bot.utils.exceptions import UserNotPlayingError  from bot.utils.extensions import invoke_help_command @@ -31,33 +33,6 @@ MESSAGE_MAPPING = {  log = logging.getLogger(__name__) -class CoordinateConverter(commands.Converter): -    """Converter for Coordinates.""" - -    async def convert(self, ctx: commands.Context, coordinate: str) -> typing.Tuple[int, int]: -        """Take in a coordinate string and turn it into an (x, y) tuple.""" -        if not 2 <= len(coordinate) <= 3: -            raise commands.BadArgument('Invalid co-ordinate provided') - -        coordinate = coordinate.lower() -        if coordinate[0].isalpha(): -            digit = coordinate[1:] -            letter = coordinate[0] -        else: -            digit = coordinate[:-1] -            letter = coordinate[-1] - -        if not digit.isdigit(): -            raise commands.BadArgument - -        x = ord(letter) - ord('a') -        y = int(digit) - 1 - -        if (not 0 <= x <= 9) or (not 0 <= y <= 9): -            raise commands.BadArgument -        return x, y - -  GameBoard = typing.List[typing.List[typing.Union[str, int]]] @@ -78,10 +53,10 @@ GamesDict = typing.Dict[int, Game]  class Minesweeper(commands.Cog):      """Play a game of Minesweeper.""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self) -> None:          self.games: GamesDict = {}  # Store the currently running games -    @commands.group(name='minesweeper', aliases=('ms',), invoke_without_command=True) +    @commands.group(name="minesweeper", aliases=("ms",), invoke_without_command=True)      async def minesweeper_group(self, ctx: commands.Context) -> None:          """Commands for Playing Minesweeper."""          await invoke_help_command(ctx) @@ -148,7 +123,7 @@ class Minesweeper(commands.Cog):                  f"Close the game with `{Client.prefix}ms end`\n"              )          except discord.errors.Forbidden: -            log.debug(f"{ctx.author.name} ({ctx.author.id}) has disabled DMs from server members") +            log.debug(f"{ctx.author.name} ({ctx.author.id}) has disabled DMs from server members.")              await ctx.send(f":x: {ctx.author.mention}, please enable DMs to play minesweeper.")              return @@ -158,7 +133,7 @@ class Minesweeper(commands.Cog):          dm_msg = await ctx.author.send(f"Here's your board!\n{self.format_for_discord(revealed_board)}")          if ctx.guild: -            await ctx.send(f"{ctx.author.mention} is playing Minesweeper") +            await ctx.send(f"{ctx.author.mention} is playing Minesweeper.")              chat_msg = await ctx.send(f"Here's their board!\n{self.format_for_discord(revealed_board)}")          else:              chat_msg = None @@ -237,17 +212,17 @@ class Minesweeper(commands.Cog):              return True      async def reveal_one( -            self, -            ctx: commands.Context, -            revealed: GameBoard, -            board: GameBoard, -            x: int, -            y: int +        self, +        ctx: commands.Context, +        revealed: GameBoard, +        board: GameBoard, +        x: int, +        y: int      ) -> bool:          """          Reveal one square. -        return is True if the game ended, breaking the loop in `reveal_command` and deleting the game +        return is True if the game ended, breaking the loop in `reveal_command` and deleting the game.          """          revealed[y][x] = board[y][x]          if board[y][x] == "bomb": @@ -285,13 +260,13 @@ class Minesweeper(commands.Cog):          game = self.games[ctx.author.id]          game.revealed = game.board          await self.update_boards(ctx) -        new_msg = f":no_entry: Game canceled :no_entry:\n{game.dm_msg.content}" +        new_msg = f":no_entry: Game canceled. :no_entry:\n{game.dm_msg.content}"          await game.dm_msg.edit(content=new_msg)          if game.activated_on_server:              await game.chat_msg.edit(content=new_msg)          del self.games[ctx.author.id] -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the Minesweeper cog.""" -    bot.add_cog(Minesweeper(bot)) +    bot.add_cog(Minesweeper()) diff --git a/bot/exts/evergreen/movie.py b/bot/exts/evergreen/movie.py index b3bfe998..10638aea 100644 --- a/bot/exts/evergreen/movie.py +++ b/bot/exts/evergreen/movie.py @@ -6,8 +6,9 @@ from urllib.parse import urlencode  from aiohttp import ClientSession  from discord import Embed -from discord.ext.commands import Bot, Cog, Context, group +from discord.ext.commands import Cog, Context, group +from bot.bot import Bot  from bot.constants import Tokens  from bot.utils.extensions import invoke_help_command  from bot.utils.pagination import ImagePaginator @@ -50,10 +51,9 @@ 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) +    @group(name="movies", aliases=("movie",), invoke_without_command=True)      async def movies(self, ctx: Context, genre: str = "", amount: int = 5) -> None:          """          Get random movies by specifying genre. Also support amount parameter, that define how much movies will be shown. @@ -72,15 +72,17 @@ class Movie(Cog):          # Capitalize genre for getting data from Enum, get random page, send help when genre don't exist.          genre = genre.capitalize()          try: -            result = await self.get_movies_list(self.http_session, MovieGenres[genre].value, 1) +            result = await self.get_movies_data(self.http_session, MovieGenres[genre].value, 1)          except KeyError:              await invoke_help_command(ctx)              return          # Check if "results" is in result. If not, throw error. -        if "results" not in result.keys(): -            err_msg = f"There is problem while making TMDB API request. Response Code: {result['status_code']}, " \ -                      f"{result['status_message']}." +        if "results" not in result: +            err_msg = ( +                f"There is problem while making TMDB API request. Response Code: {result['status_code']}, " +                f"{result['status_message']}." +            )              await ctx.send(err_msg)              logger.warning(err_msg) @@ -88,8 +90,8 @@ class Movie(Cog):          page = random.randint(1, result["total_pages"])          # Get movies list from TMDB, check if results key in result. When not, raise error. -        movies = await self.get_movies_list(self.http_session, MovieGenres[genre].value, page) -        if 'results' not in movies.keys(): +        movies = await self.get_movies_data(self.http_session, MovieGenres[genre].value, page) +        if "results" not in movies:              err_msg = f"There is problem while making TMDB API request. Response Code: {result['status_code']}, " \                        f"{result['status_message']}."              await ctx.send(err_msg) @@ -101,12 +103,12 @@ class Movie(Cog):          await ImagePaginator.paginate(pages, ctx, embed) -    @movies.command(name='genres', aliases=['genre', 'g']) +    @movies.command(name="genres", aliases=("genre", "g"))      async def genres(self, ctx: Context) -> None:          """Show all currently available genres for .movies command."""          await ctx.send(f"Current available genres: {', '.join('`' + genre.name + '`' for genre in MovieGenres)}") -    async def get_movies_list(self, client: ClientSession, genre_id: str, page: int) -> Dict[str, Any]: +    async def get_movies_data(self, client: ClientSession, genre_id: str, page: int) -> List[Dict[str, Any]]:          """Return JSON of TMDB discover request."""          # Define params of request          params = { @@ -130,7 +132,7 @@ class Movie(Cog):          pages = []          for i in range(amount): -            movie_id = movies['results'][i]['id'] +            movie_id = movies["results"][i]["id"]              movie = await self.get_movie(client, movie_id)              page, img = await self.create_page(movie) @@ -151,7 +153,7 @@ class Movie(Cog):          # Add title + tagline (if not empty)          text += f"**{movie['title']}**\n" -        if movie['tagline']: +        if movie["tagline"]:              text += f"{movie['tagline']}\n\n"          else:              text += "\n" @@ -162,8 +164,8 @@ class Movie(Cog):          text += "__**Production Information**__\n" -        companies = movie['production_companies'] -        countries = movie['production_countries'] +        companies = movie["production_companies"] +        countries = movie["production_countries"]          text += f"**Made by:** {', '.join(company['name'] for company in companies)}\n"          text += f"**Made in:** {', '.join(country['name'] for country in countries)}\n\n" @@ -173,8 +175,8 @@ class Movie(Cog):          budget = f"{movie['budget']:,d}" if movie['budget'] else "?"          revenue = f"{movie['revenue']:,d}" if movie['revenue'] else "?" -        if movie['runtime'] is not None: -            duration = divmod(movie['runtime'], 60) +        if movie["runtime"] is not None: +            duration = divmod(movie["runtime"], 60)          else:              duration = ("?", "?") @@ -182,7 +184,7 @@ class Movie(Cog):          text += f"**Revenue:** ${revenue}\n"          text += f"**Duration:** {f'{duration[0]} hour(s) {duration[1]} minute(s)'}\n\n" -        text += movie['overview'] +        text += movie["overview"]          img = f"http://image.tmdb.org/t/p/w200{movie['poster_path']}" @@ -198,5 +200,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 07c13524..6be78117 100644 --- a/bot/exts/evergreen/ping.py +++ b/bot/exts/evergreen/ping.py @@ -4,13 +4,14 @@ from discord import Embed  from discord.ext import commands  from bot import start_time +from bot.bot import Bot  from bot.constants import Colours  class Ping(commands.Cog):      """Get info about the bot's ping and uptime.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot):          self.bot = bot      @commands.command(name="ping") @@ -39,6 +40,6 @@ class Ping(commands.Cog):          await ctx.send(f"I started up {uptime_string}.") -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the Ping cog."""      bot.add_cog(Ping(bot)) diff --git a/bot/exts/evergreen/pythonfacts.py b/bot/exts/evergreen/pythonfacts.py index 457c2fd3..80a8da5d 100644 --- a/bot/exts/evergreen/pythonfacts.py +++ b/bot/exts/evergreen/pythonfacts.py @@ -3,31 +3,34 @@ import itertools  import discord  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Colours -with open('bot/resources/evergreen/python_facts.txt') as file: +with open("bot/resources/evergreen/python_facts.txt") as file:      FACTS = itertools.cycle(list(file))  COLORS = itertools.cycle([Colours.python_blue, Colours.python_yellow]) +PYFACTS_DISCUSSION = "https://github.com/python-discord/meta/discussions/93"  class PythonFacts(commands.Cog):      """Sends a random fun fact about Python.""" -    def __init__(self, bot: commands.Bot) -> None: -        self.bot = bot - -    @commands.command(name='pythonfact', aliases=['pyfact']) +    @commands.command(name="pythonfact", aliases=("pyfact",))      async def get_python_fact(self, ctx: commands.Context) -> None:          """Sends a Random fun fact about Python.""" -        embed = discord.Embed(title='Python Facts', -                                    description=next(FACTS), -                                    colour=next(COLORS)) -        embed.add_field(name='Suggestions', -                        value="Suggest more facts [here!](https://github.com/python-discord/meta/discussions/93)") +        embed = discord.Embed( +            title="Python Facts", +            description=next(FACTS), +            colour=next(COLORS) +        ) +        embed.add_field( +            name="Suggestions", +            value=f"Suggest more facts [here!]({PYFACTS_DISCUSSION})" +        )          await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: -    """Load PythonFacts Cog.""" -    bot.add_cog(PythonFacts(bot)) +def setup(bot: Bot) -> None: +    """Load the PythonFacts Cog.""" +    bot.add_cog(PythonFacts()) diff --git a/bot/exts/evergreen/recommend_game.py b/bot/exts/evergreen/recommend_game.py index 5e262a5b..35d60128 100644 --- a/bot/exts/evergreen/recommend_game.py +++ b/bot/exts/evergreen/recommend_game.py @@ -6,13 +6,14 @@ from random import shuffle  import discord  from discord.ext import commands +from bot.bot import Bot +  log = logging.getLogger(__name__)  game_recs = []  # Populate the list `game_recs` with resource files  for rec_path in Path("bot/resources/evergreen/game_recs").glob("*.json"): -    with rec_path.open(encoding='utf8') as file: -        data = json.load(file) +    data = json.loads(rec_path.read_text("utf8"))      game_recs.append(data)  shuffle(game_recs) @@ -20,11 +21,11 @@ shuffle(game_recs)  class RecommendGame(commands.Cog):      """Commands related to recommending games.""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self, bot: Bot) -> None:          self.bot = bot          self.index = 0 -    @commands.command(name="recommendgame", aliases=['gamerec']) +    @commands.command(name="recommendgame", aliases=("gamerec",))      async def recommend_game(self, ctx: commands.Context) -> None:          """Sends an Embed of a random game recommendation."""          if self.index >= len(game_recs): @@ -33,18 +34,18 @@ class RecommendGame(commands.Cog):          game = game_recs[self.index]          self.index += 1 -        author = self.bot.get_user(int(game['author'])) +        author = self.bot.get_user(int(game["author"]))          # Creating and formatting Embed          embed = discord.Embed(color=discord.Colour.blue())          if author is not None:              embed.set_author(name=author.name, icon_url=author.avatar_url) -        embed.set_image(url=game['image']) -        embed.add_field(name='Recommendation: ' + game['title'] + '\n' + game['link'], value=game['description']) +        embed.set_image(url=game["image"]) +        embed.add_field(name=f"Recommendation: {game['title']}\n{game['link']}", value=game["description"])          await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Loads the RecommendGame cog."""      bot.add_cog(RecommendGame(bot)) diff --git a/bot/exts/evergreen/rps.py b/bot/exts/evergreen/rps.py new file mode 100644 index 00000000..c6bbff46 --- /dev/null +++ b/bot/exts/evergreen/rps.py @@ -0,0 +1,57 @@ +from random import choice + +from discord.ext import commands + +from bot.bot import Bot + +CHOICES = ["rock", "paper", "scissors"] +SHORT_CHOICES = ["r", "p", "s"] + +# Using a dictionary instead of conditions to check for the winner. +WINNER_DICT = { +    "r": { +        "r": 0, +        "p": -1, +        "s": 1, +    }, +    "p": { +        "r": 1, +        "p": 0, +        "s": -1, +    }, +    "s": { +        "r": -1, +        "p": 1, +        "s": 0, +    } +} + + +class RPS(commands.Cog): +    """Rock Paper Scissors. The Classic Game!""" + +    @commands.command(case_insensitive=True) +    async def rps(self, ctx: commands.Context, move: str) -> None: +        """Play the classic game of Rock Paper Scissors with your own sir-lancebot!""" +        move = move.lower() +        player_mention = ctx.author.mention + +        if move not in CHOICES and move not in SHORT_CHOICES: +            raise commands.BadArgument(f"Invalid move. Please make move from options: {', '.join(CHOICES).upper()}.") + +        bot_move = choice(CHOICES) +        # value of player_result will be from (-1, 0, 1) as (lost, tied, won). +        player_result = WINNER_DICT[move[0]][bot_move[0]] + +        if player_result == 0: +            message_string = f"{player_mention} You and Sir Lancebot played {bot_move}, it's a tie." +            await ctx.send(message_string) +        elif player_result == 1: +            await ctx.send(f"Sir Lancebot played {bot_move}! {player_mention} won!") +        else: +            await ctx.send(f"Sir Lancebot played {bot_move}! {player_mention} lost!") + + +def setup(bot: Bot) -> None: +    """Load the RPS Cog.""" +    bot.add_cog(RPS(bot)) diff --git a/bot/exts/evergreen/snakes/__init__.py b/bot/exts/evergreen/snakes/__init__.py index bc42f0c2..7740429b 100644 --- a/bot/exts/evergreen/snakes/__init__.py +++ b/bot/exts/evergreen/snakes/__init__.py @@ -1,12 +1,11 @@  import logging -from discord.ext import commands - +from bot.bot import Bot  from bot.exts.evergreen.snakes._snakes_cog import Snakes  log = logging.getLogger(__name__) -def setup(bot: commands.Bot) -> None: -    """Snakes Cog load.""" +def setup(bot: Bot) -> None: +    """Load the Snakes Cog."""      bot.add_cog(Snakes(bot)) diff --git a/bot/exts/evergreen/snakes/_converter.py b/bot/exts/evergreen/snakes/_converter.py index eee248cf..26bde611 100644 --- a/bot/exts/evergreen/snakes/_converter.py +++ b/bot/exts/evergreen/snakes/_converter.py @@ -24,8 +24,8 @@ class Snake(Converter):          await self.build_list()          name = name.lower() -        if name == 'python': -            return 'Python (programming language)' +        if name == "python": +            return "Python (programming language)"          def get_potential(iterable: Iterable, *, threshold: int = 80) -> List[str]:              nonlocal name @@ -47,12 +47,12 @@ class Snake(Converter):          if name.lower() in self.special_cases:              return self.special_cases.get(name.lower(), name.lower()) -        names = {snake['name']: snake['scientific'] for snake in self.snakes} +        names = {snake["name"]: snake["scientific"] for snake in self.snakes}          all_names = names.keys() | names.values()          timeout = len(all_names) * (3 / 4)          embed = discord.Embed( -            title='Found multiple choices. Please choose the correct one.', colour=0x59982F) +            title="Found multiple choices. Please choose the correct one.", colour=0x59982F)          embed.set_author(name=ctx.author.display_name, icon_url=ctx.author.avatar_url)          name = await disambiguate(ctx, get_potential(all_names), timeout=timeout, embed=embed) @@ -63,14 +63,11 @@ class Snake(Converter):          """Build list of snakes from the static snake resources."""          # Get all the snakes          if cls.snakes is None: -            with (SNAKE_RESOURCES / "snake_names.json").open(encoding="utf8") as snakefile: -                cls.snakes = json.load(snakefile) - +            cls.snakes = json.loads((SNAKE_RESOURCES / "snake_names.json").read_text("utf8"))          # Get the special cases          if cls.special_cases is None: -            with (SNAKE_RESOURCES / "special_snakes.json").open(encoding="utf8") as snakefile: -                special_cases = json.load(snakefile) -            cls.special_cases = {snake['name'].lower(): snake for snake in special_cases} +            special_cases = json.loads((SNAKE_RESOURCES / "special_snakes.json").read_text("utf8")) +            cls.special_cases = {snake["name"].lower(): snake for snake in special_cases}      @classmethod      async def random(cls) -> str: @@ -81,5 +78,5 @@ class Snake(Converter):          so I can get it from here.          """          await cls.build_list() -        names = [snake['scientific'] for snake in cls.snakes] +        names = [snake["scientific"] for snake in cls.snakes]          return random.choice(names) diff --git a/bot/exts/evergreen/snakes/_snakes_cog.py b/bot/exts/evergreen/snakes/_snakes_cog.py index 3732b559..07d3c363 100644 --- a/bot/exts/evergreen/snakes/_snakes_cog.py +++ b/bot/exts/evergreen/snakes/_snakes_cog.py @@ -9,15 +9,15 @@ import textwrap  import urllib  from functools import partial  from io import BytesIO -from typing import Any, Dict, List +from typing import Any, Dict, List, Optional -import aiohttp  import async_timeout  from PIL import Image, ImageDraw, ImageFont  from discord import Colour, Embed, File, Member, Message, Reaction  from discord.errors import HTTPException -from discord.ext.commands import Bot, Cog, CommandError, Context, bot_has_permissions, group +from discord.ext.commands import Cog, CommandError, Context, bot_has_permissions, group +from bot.bot import Bot  from bot.constants import ERROR_REPLIES, Tokens  from bot.exts.evergreen.snakes import _utils as utils  from bot.exts.evergreen.snakes._converter import Snake @@ -143,8 +143,8 @@ class Snakes(Cog):      https://github.com/python-discord/code-jam-1      """ -    wiki_brief = re.compile(r'(.*?)(=+ (.*?) =+)', flags=re.DOTALL) -    valid_image_extensions = ('gif', 'png', 'jpeg', 'jpg', 'webp') +    wiki_brief = re.compile(r"(.*?)(=+ (.*?) =+)", flags=re.DOTALL) +    valid_image_extensions = ("gif", "png", "jpeg", "jpg", "webp")      def __init__(self, bot: Bot):          self.active_sal = {} @@ -183,28 +183,28 @@ class Snakes(Cog):          # Get the size of the snake icon, configure the height of the image box (yes, it changes)          icon_width = 347  # Hardcoded, not much i can do about that          icon_height = int((icon_width / snake.width) * snake.height) -        frame_copies = icon_height // CARD['frame'].height + 1 +        frame_copies = icon_height // CARD["frame"].height + 1          snake.thumbnail((icon_width, icon_height))          # Get the dimensions of the final image -        main_height = icon_height + CARD['top'].height + CARD['bottom'].height -        main_width = CARD['frame'].width +        main_height = icon_height + CARD["top"].height + CARD["bottom"].height +        main_width = CARD["frame"].width          # Start creating the foreground          foreground = Image.new("RGBA", (main_width, main_height), (0, 0, 0, 0)) -        foreground.paste(CARD['top'], (0, 0)) +        foreground.paste(CARD["top"], (0, 0))          # Generate the frame borders to the correct height          for offset in range(frame_copies): -            position = (0, CARD['top'].height + offset * CARD['frame'].height) -            foreground.paste(CARD['frame'], position) +            position = (0, CARD["top"].height + offset * CARD["frame"].height) +            foreground.paste(CARD["frame"], position)          # Add the image and bottom part of the image -        foreground.paste(snake, (36, CARD['top'].height))  # Also hardcoded :( -        foreground.paste(CARD['bottom'], (0, CARD['top'].height + icon_height)) +        foreground.paste(snake, (36, CARD["top"].height))  # Also hardcoded :( +        foreground.paste(CARD["bottom"], (0, CARD["top"].height + icon_height))          # Setup the background -        back = random.choice(CARD['backs']) +        back = random.choice(CARD["backs"])          back_copies = main_height // back.height + 1          full_image = Image.new("RGBA", (main_width, main_height), (0, 0, 0, 0)) @@ -216,11 +216,11 @@ class Snakes(Cog):          full_image.paste(foreground, (0, 0), foreground)          # Get the first two sentences of the info -        description = '.'.join(content['info'].split(".")[:2]) + '.' +        description = ".".join(content["info"].split(".")[:2]) + "."          # Setup positioning variables          margin = 36 -        offset = CARD['top'].height + icon_height + margin +        offset = CARD["top"].height + icon_height + margin          # Create blank rectangle image which will be behind the text          rectangle = Image.new( @@ -242,12 +242,12 @@ class Snakes(Cog):          # Draw the text onto the final image          draw = ImageDraw.Draw(full_image)          for line in textwrap.wrap(description, 36): -            draw.text([margin + 4, offset], line, font=CARD['font']) -            offset += CARD['font'].getsize(line)[1] +            draw.text([margin + 4, offset], line, font=CARD["font"]) +            offset += CARD["font"].getsize(line)[1]          # Get the image contents as a BufferIO object          buffer = BytesIO() -        full_image.save(buffer, 'PNG') +        full_image.save(buffer, "PNG")          buffer.seek(0)          return buffer @@ -275,13 +275,13 @@ class Snakes(Cog):          return message -    async def _fetch(self, session: aiohttp.ClientSession, url: str, params: dict = None) -> dict: +    async def _fetch(self, url: str, params: Optional[dict] = None) -> dict:          """Asynchronous web request helper method."""          if params is None:              params = {}          async with async_timeout.timeout(10): -            async with session.get(url, params=params) as response: +            async with self.bot.http_session.get(url, params=params) as response:                  return await response.json()      def _get_random_long_message(self, messages: List[str], retries: int = 10) -> str: @@ -309,96 +309,95 @@ class Snakes(Cog):          """          snake_info = {} -        async with aiohttp.ClientSession() as session: -            params = { -                'format': 'json', -                'action': 'query', -                'list': 'search', -                'srsearch': name, -                'utf8': '', -                'srlimit': '1', -            } - -            json = await self._fetch(session, URL, params=params) - -            # Wikipedia does have a error page -            try: -                pageid = json["query"]["search"][0]["pageid"] -            except KeyError: -                # Wikipedia error page ID(?) -                pageid = 41118 -            except IndexError: -                return None - -            params = { -                'format': 'json', -                'action': 'query', -                'prop': 'extracts|images|info', -                'exlimit': 'max', -                'explaintext': '', -                'inprop': 'url', -                'pageids': pageid -            } +        params = { +            "format": "json", +            "action": "query", +            "list": "search", +            "srsearch": name, +            "utf8": "", +            "srlimit": "1", +        } -            json = await self._fetch(session, URL, params=params) +        json = await self._fetch(URL, params=params) -            # Constructing dict - handle exceptions later -            try: -                snake_info["title"] = json["query"]["pages"][f"{pageid}"]["title"] -                snake_info["extract"] = json["query"]["pages"][f"{pageid}"]["extract"] -                snake_info["images"] = json["query"]["pages"][f"{pageid}"]["images"] -                snake_info["fullurl"] = json["query"]["pages"][f"{pageid}"]["fullurl"] -                snake_info["pageid"] = json["query"]["pages"][f"{pageid}"]["pageid"] -            except KeyError: -                snake_info["error"] = True - -            if snake_info["images"]: -                i_url = 'https://commons.wikimedia.org/wiki/Special:FilePath/' -                image_list = [] -                map_list = [] -                thumb_list = [] - -                # Wikipedia has arbitrary images that are not snakes -                banned = [ -                    'Commons-logo.svg', -                    'Red%20Pencil%20Icon.png', -                    'distribution', -                    'The%20Death%20of%20Cleopatra%20arthur.jpg', -                    'Head%20of%20holotype', -                    'locator', -                    'Woma.png', -                    '-map.', -                    '.svg', -                    'ange.', -                    'Adder%20(PSF).png' -                ] - -                for image in snake_info["images"]: -                    # Images come in the format of `File:filename.extension` -                    file, sep, filename = image["title"].partition(':') -                    filename = filename.replace(" ", "%20")  # Wikipedia returns good data! - -                    if not filename.startswith('Map'): -                        if any(ban in filename for ban in banned): -                            pass -                        else: -                            image_list.append(f"{i_url}{filename}") -                            thumb_list.append(f"{i_url}{filename}?width=100") +        # Wikipedia does have a error page +        try: +            pageid = json["query"]["search"][0]["pageid"] +        except KeyError: +            # Wikipedia error page ID(?) +            pageid = 41118 +        except IndexError: +            return None + +        params = { +            "format": "json", +            "action": "query", +            "prop": "extracts|images|info", +            "exlimit": "max", +            "explaintext": "", +            "inprop": "url", +            "pageids": pageid +        } + +        json = await self._fetch(URL, params=params) + +        # Constructing dict - handle exceptions later +        try: +            snake_info["title"] = json["query"]["pages"][f"{pageid}"]["title"] +            snake_info["extract"] = json["query"]["pages"][f"{pageid}"]["extract"] +            snake_info["images"] = json["query"]["pages"][f"{pageid}"]["images"] +            snake_info["fullurl"] = json["query"]["pages"][f"{pageid}"]["fullurl"] +            snake_info["pageid"] = json["query"]["pages"][f"{pageid}"]["pageid"] +        except KeyError: +            snake_info["error"] = True + +        if snake_info["images"]: +            i_url = "https://commons.wikimedia.org/wiki/Special:FilePath/" +            image_list = [] +            map_list = [] +            thumb_list = [] + +            # Wikipedia has arbitrary images that are not snakes +            banned = [ +                "Commons-logo.svg", +                "Red%20Pencil%20Icon.png", +                "distribution", +                "The%20Death%20of%20Cleopatra%20arthur.jpg", +                "Head%20of%20holotype", +                "locator", +                "Woma.png", +                "-map.", +                ".svg", +                "ange.", +                "Adder%20(PSF).png" +            ] + +            for image in snake_info["images"]: +                # Images come in the format of `File:filename.extension` +                file, sep, filename = image["title"].partition(":") +                filename = filename.replace(" ", "%20")  # Wikipedia returns good data! + +                if not filename.startswith("Map"): +                    if any(ban in filename for ban in banned): +                        pass                      else: -                        map_list.append(f"{i_url}{filename}") +                        image_list.append(f"{i_url}{filename}") +                        thumb_list.append(f"{i_url}{filename}?width=100") +                else: +                    map_list.append(f"{i_url}{filename}") -            snake_info["image_list"] = image_list -            snake_info["map_list"] = map_list -            snake_info["thumb_list"] = thumb_list -            snake_info["name"] = name +        snake_info["image_list"] = image_list +        snake_info["map_list"] = map_list +        snake_info["thumb_list"] = thumb_list +        snake_info["name"] = name -            match = self.wiki_brief.match(snake_info['extract']) -            info = match.group(1) if match else None +        match = self.wiki_brief.match(snake_info["extract"]) +        info = match.group(1) if match else None -            if info: -                info = info.replace("\n", "\n\n")  # Give us some proper paragraphs. +        if info: +            info = info.replace("\n", "\n\n")  # Give us some proper paragraphs. -            snake_info["info"] = info +        snake_info["info"] = info          return snake_info @@ -423,7 +422,7 @@ class Snakes(Cog):          try:              reaction, user = await ctx.bot.wait_for("reaction_add", timeout=45.0, check=predicate)          except asyncio.TimeoutError: -            await ctx.channel.send(f"You took too long. The correct answer was **{options[answer]}**.") +            await ctx.send(f"You took too long. The correct answer was **{options[answer]}**.")              await message.clear_reactions()              return @@ -438,13 +437,13 @@ class Snakes(Cog):      # endregion      # region: Commands -    @group(name='snakes', aliases=('snake',), invoke_without_command=True) +    @group(name="snakes", aliases=("snake",), invoke_without_command=True)      async def snakes_group(self, ctx: Context) -> None:          """Commands from our first code jam."""          await invoke_help_command(ctx)      @bot_has_permissions(manage_messages=True) -    @snakes_group.command(name='antidote') +    @snakes_group.command(name="antidote")      @locked()      async def antidote_command(self, ctx: Context) -> None:          """ @@ -498,9 +497,11 @@ class Snakes(Cog):          for i in range(0, 10):              page_guess_list.append(f"{HOLE_EMOJI} {HOLE_EMOJI} {HOLE_EMOJI} {HOLE_EMOJI}")              page_result_list.append(f"{CROSS_EMOJI} {CROSS_EMOJI} {CROSS_EMOJI} {CROSS_EMOJI}") -            board.append(f"`{i+1:02d}` " -                         f"{page_guess_list[i]} - " -                         f"{page_result_list[i]}") +            board.append( +                f"`{i+1:02d}` " +                f"{page_guess_list[i]} - " +                f"{page_result_list[i]}" +            )              board.append(EMPTY_UNICODE)          antidote_embed.add_field(name="10 guesses remaining", value="\n".join(board))          board_id = await ctx.send(embed=antidote_embed)  # Display board @@ -578,15 +579,19 @@ class Snakes(Cog):              antidote_embed = Embed(color=SNAKE_COLOR, title="Antidote")              antidote_embed.set_author(name=ctx.author.name, icon_url=ctx.author.avatar_url)              antidote_embed.set_image(url="https://media.giphy.com/media/ceeN6U57leAhi/giphy.gif") -            antidote_embed.add_field(name=EMPTY_UNICODE, -                                     value=f"Sorry you didnt make the antidote in time.\n" -                                           f"The formula was {' '.join(antidote_answer)}") +            antidote_embed.add_field( +                name=EMPTY_UNICODE, +                value=( +                    f"Sorry you didnt make the antidote in time.\n" +                    f"The formula was {' '.join(antidote_answer)}" +                ) +            )              await board_id.edit(embed=antidote_embed)          log.debug("Ending pagination and removing all reactions...")          await board_id.clear_reactions() -    @snakes_group.command(name='draw') +    @snakes_group.command(name="draw")      async def draw_command(self, ctx: Context) -> None:          """          Draws a random snek using Perlin noise. @@ -621,10 +626,10 @@ class Snakes(Cog):                  bg_color=bg_color              )              png_bytes = utils.frame_to_png_bytes(image_frame) -            file = File(png_bytes, filename='snek.png') +            file = File(png_bytes, filename="snek.png")              await ctx.send(file=file) -    @snakes_group.command(name='get') +    @snakes_group.command(name="get")      @bot_has_permissions(manage_messages=True)      @locked()      async def get_command(self, ctx: Context, *, name: Snake = None) -> None: @@ -642,8 +647,9 @@ class Snakes(Cog):              else:                  data = await self._get_snek(name) -            if data.get('error'): -                return await ctx.send('Could not fetch data from Wikipedia.') +            if data.get("error"): +                await ctx.send("Could not fetch data from Wikipedia.") +                return              description = data["info"] @@ -661,19 +667,25 @@ class Snakes(Cog):              # Build and send the embed.              embed = Embed( -                title=data.get("title", data.get('name')), +                title=data.get("title", data.get("name")),                  description=description,                  colour=0x59982F,              ) -            emoji = 'https://emojipedia-us.s3.amazonaws.com/thumbs/60/google/3/snake_1f40d.png' -            image = next((url for url in data['image_list'] -                          if url.endswith(self.valid_image_extensions)), emoji) +            emoji = "https://emojipedia-us.s3.amazonaws.com/thumbs/60/google/3/snake_1f40d.png" + +            _iter = ( +                url +                for url in data["image_list"] +                if url.endswith(self.valid_image_extensions) +            ) +            image = next(_iter, emoji) +              embed.set_image(url=image)              await ctx.send(embed=embed) -    @snakes_group.command(name='guess', aliases=('identify',)) +    @snakes_group.command(name="guess", aliases=("identify",))      @locked()      async def guess_command(self, ctx: Context) -> None:          """ @@ -693,11 +705,15 @@ class Snakes(Cog):                  data = await self._get_snek(snake) -                image = next((url for url in data['image_list'] -                              if url.endswith(self.valid_image_extensions)), None) +                _iter = ( +                    url +                    for url in data["image_list"] +                    if url.endswith(self.valid_image_extensions) +                ) +                image = next(_iter, None)              embed = Embed( -                title='Which of the following is the snake in the image?', +                title="Which of the following is the snake in the image?",                  description="\n".join(                      f"{'ABCD'[snakes.index(snake)]}: {snake}" for snake in snakes),                  colour=SNAKE_COLOR @@ -708,7 +724,7 @@ class Snakes(Cog):          options = {f"{'abcd'[snakes.index(snake)]}": snake for snake in snakes}          await self._validate_answer(ctx, guess, answer, options) -    @snakes_group.command(name='hatch') +    @snakes_group.command(name="hatch")      async def hatch_command(self, ctx: Context) -> None:          """          Hatches your personal snake. @@ -720,7 +736,7 @@ class Snakes(Cog):          snake_image = utils.snakes[snake_name]          # Hatch the snake -        message = await ctx.channel.send(embed=Embed(description="Hatching your snake :snake:...")) +        message = await ctx.send(embed=Embed(description="Hatching your snake :snake:..."))          await asyncio.sleep(1)          for stage in utils.stages: @@ -734,12 +750,12 @@ class Snakes(Cog):          my_snake_embed = Embed(description=":tada: Congrats! You hatched: **{0}**".format(snake_name))          my_snake_embed.set_thumbnail(url=snake_image)          my_snake_embed.set_footer( -            text=" Owner: {0}#{1}".format(ctx.message.author.name, ctx.message.author.discriminator) +            text=" Owner: {0}#{1}".format(ctx.author.name, ctx.author.discriminator)          ) -        await ctx.channel.send(embed=my_snake_embed) +        await ctx.send(embed=my_snake_embed) -    @snakes_group.command(name='movie') +    @snakes_group.command(name="movie")      async def movie_command(self, ctx: Context) -> None:          """          Gets a random snake-related movie from TMDB. @@ -800,12 +816,12 @@ class Snakes(Cog):          embed.set_thumbnail(url="https://i.imgur.com/LtFtC8H.png")          try: -            await ctx.channel.send(embed=embed) +            await ctx.send(embed=embed)          except HTTPException as err: -            await ctx.channel.send("An error occurred while fetching a snake-related movie!") +            await ctx.send("An error occurred while fetching a snake-related movie!")              raise err from None -    @snakes_group.command(name='quiz') +    @snakes_group.command(name="quiz")      @locked()      async def quiz_command(self, ctx: Context) -> None:          """ @@ -828,10 +844,10 @@ class Snakes(Cog):              )          ) -        quiz = await ctx.channel.send("", embed=embed) +        quiz = await ctx.send(embed=embed)          await self._validate_answer(ctx, quiz, answer, options) -    @snakes_group.command(name='name', aliases=('name_gen',)) +    @snakes_group.command(name="name", aliases=("name_gen",))      async def name_command(self, ctx: Context, *, name: str = None) -> None:          """          Snakifies a username. @@ -855,7 +871,7 @@ class Snakes(Cog):          This was written by Iceman, and modified for inclusion into the bot by lemon.          """          snake_name = await self._get_snake_name() -        snake_name = snake_name['name'] +        snake_name = snake_name["name"]          snake_prefix = ""          # Set aside every word in the snake name except the last. @@ -900,9 +916,10 @@ class Snakes(Cog):              color=SNAKE_COLOR          ) -        return await ctx.send(embed=embed) +        await ctx.send(embed=embed) +        return -    @snakes_group.command(name='sal') +    @snakes_group.command(name="sal")      @locked()      async def sal_command(self, ctx: Context) -> None:          """ @@ -921,7 +938,7 @@ class Snakes(Cog):          await game.open_game() -    @snakes_group.command(name='about') +    @snakes_group.command(name="about")      async def about_command(self, ctx: Context) -> None:          """Show an embed with information about the event, its participants, and its winners."""          contributors = [ @@ -964,9 +981,9 @@ class Snakes(Cog):              )          ) -        await ctx.channel.send(embed=embed) +        await ctx.send(embed=embed) -    @snakes_group.command(name='card') +    @snakes_group.command(name="card")      async def card_command(self, ctx: Context, *, name: Snake = None) -> None:          """          Create an interesting little card from a snake. @@ -976,7 +993,7 @@ class Snakes(Cog):          # Get the snake data we need          if not name:              name_obj = await self._get_snake_name() -            name = name_obj['scientific'] +            name = name_obj["scientific"]              content = await self._get_snek(name)          elif isinstance(name, dict): @@ -990,7 +1007,7 @@ class Snakes(Cog):              stream = BytesIO()              async with async_timeout.timeout(10): -                async with self.bot.http_session.get(content['image_list'][0]) as response: +                async with self.bot.http_session.get(content["image_list"][0]) as response:                      stream.write(await response.read())              stream.seek(0) @@ -1001,10 +1018,10 @@ class Snakes(Cog):          # Send it!          await ctx.send(              f"A wild {content['name'].title()} appears!", -            file=File(final_buffer, filename=content['name'].replace(" ", "") + ".png") +            file=File(final_buffer, filename=content["name"].replace(" ", "") + ".png")          ) -    @snakes_group.command(name='fact') +    @snakes_group.command(name="fact")      async def fact_command(self, ctx: Context) -> None:          """          Gets a snake-related fact. @@ -1018,9 +1035,9 @@ class Snakes(Cog):              color=SNAKE_COLOR,              description=question          ) -        await ctx.channel.send(embed=embed) +        await ctx.send(embed=embed) -    @snakes_group.command(name='snakify') +    @snakes_group.command(name="snakify")      async def snakify_command(self, ctx: Context, *, message: str = None) -> None:          """          How would I talk if I were a snake? @@ -1033,14 +1050,14 @@ class Snakes(Cog):          """          with ctx.typing():              embed = Embed() -            user = ctx.message.author +            user = ctx.author              if not message:                  # Get a random message from the users history                  messages = [] -                async for message in ctx.channel.history(limit=500).filter( -                        lambda msg: msg.author == ctx.message.author  # Message was sent by author. +                async for message in ctx.history(limit=500).filter( +                        lambda msg: msg.author == ctx.author  # Message was sent by author.                  ):                      messages.append(message.content) @@ -1059,9 +1076,9 @@ class Snakes(Cog):              )              embed.description = f"*{self._snakify(message)}*" -            await ctx.channel.send(embed=embed) +            await ctx.send(embed=embed) -    @snakes_group.command(name='video', aliases=('get_video',)) +    @snakes_group.command(name="video", aliases=("get_video",))      async def video_command(self, ctx: Context, *, search: str = None) -> None:          """          Gets a YouTube video about snakes. @@ -1072,13 +1089,13 @@ class Snakes(Cog):          """          # Are we searching for anything specific?          if search: -            query = search + ' snake' +            query = search + " snake"          else:              snake = await self._get_snake_name() -            query = snake['name'] +            query = snake["name"]          # Build the URL and make the request -        url = 'https://www.googleapis.com/youtube/v3/search' +        url = "https://www.googleapis.com/youtube/v3/search"          response = await self.bot.http_session.get(              url,              params={ @@ -1094,14 +1111,14 @@ class Snakes(Cog):          # Send the user a video          if len(data) > 0:              num = random.randint(0, len(data) - 1) -            youtube_base_url = 'https://www.youtube.com/watch?v=' -            await ctx.channel.send( +            youtube_base_url = "https://www.youtube.com/watch?v=" +            await ctx.send(                  content=f"{youtube_base_url}{data[num]['id']['videoId']}"              )          else:              log.warning(f"YouTube API error. Full response looks like {response}") -    @snakes_group.command(name='zen') +    @snakes_group.command(name="zen")      async def zen_command(self, ctx: Context) -> None:          """          Gets a random quote from the Zen of Python, except as if spoken by a snake. @@ -1120,7 +1137,7 @@ class Snakes(Cog):          # Embed and send          embed.description = zen_quote -        await ctx.channel.send( +        await ctx.send(              embed=embed          )      # endregion diff --git a/bot/exts/evergreen/snakes/_utils.py b/bot/exts/evergreen/snakes/_utils.py index 7d6caf04..0a5894b7 100644 --- a/bot/exts/evergreen/snakes/_utils.py +++ b/bot/exts/evergreen/snakes/_utils.py @@ -17,38 +17,38 @@ from bot.constants import Roles  SNAKE_RESOURCES = Path("bot/resources/snakes").absolute() -h1 = r'''``` +h1 = r"""```          ----         ------       /--------\       |--------|       |--------|        \------/ -        ----```''' -h2 = r'''``` +        ----```""" +h2 = r"""```          ----         ------       /---\-/--\       |-----\--|       |--------|        \------/ -        ----```''' -h3 = r'''``` +        ----```""" +h3 = r"""```          ----         ------       /---\-/--\       |-----\--|       |-----/--|        \----\-/ -        ----```''' -h4 = r'''``` +        ----```""" +h4 = r"""```          -----         -----  \       /--|  /---\       |--\  -\---|       |--\--/--  /        \------- / -        ------```''' +        ------```"""  stages = [h1, h2, h3, h4]  snakes = {      "Baby Python": "https://i.imgur.com/SYOcmSa.png", @@ -114,8 +114,7 @@ ANGLE_RANGE = math.pi * 2  def get_resource(file: str) -> List[dict]:      """Load Snake resources JSON.""" -    with (SNAKE_RESOURCES / f"{file}.json").open(encoding="utf-8") as snakefile: -        return json.load(snakefile) +    return json.loads((SNAKE_RESOURCES / f"{file}.json").read_text("utf-8"))  def smoothstep(t: float) -> float: @@ -191,8 +190,9 @@ class PerlinNoiseFactory(object):      def get_plain_noise(self, *point) -> float:          """Get plain noise for a single point, without taking into account either octaves or tiling."""          if len(point) != self.dimension: -            raise ValueError("Expected {0} values, got {1}".format( -                self.dimension, len(point))) +            raise ValueError( +                f"Expected {self.dimension} values, got {len(point)}" +            )          # Build a list of the (min, max) bounds in each dimension          grid_coords = [] @@ -321,7 +321,7 @@ def create_snek_frame(          image_dimensions[Y] / 2 - (dimension_range[Y] / 2 + min_dimensions[Y])      ) -    image = Image.new(mode='RGB', size=image_dimensions, color=bg_color) +    image = Image.new(mode="RGB", size=image_dimensions, color=bg_color)      draw = ImageDraw(image)      for index in range(1, len(points)):          point = points[index] @@ -345,7 +345,7 @@ def create_snek_frame(  def frame_to_png_bytes(image: Image) -> io.BytesIO:      """Convert image to byte stream."""      stream = io.BytesIO() -    image.save(stream, format='PNG') +    image.save(stream, format="PNG")      stream.seek(0)      return stream @@ -373,7 +373,7 @@ class SnakeAndLaddersGame:          self.snakes = snakes          self.ctx = context          self.channel = self.ctx.channel -        self.state = 'booting' +        self.state = "booting"          self.started = False          self.author = self.ctx.author          self.players = [] @@ -413,7 +413,7 @@ class SnakeAndLaddersGame:              "**Snakes and Ladders**: A new game is about to start!",              file=File(                  str(SNAKE_RESOURCES / "snakes_and_ladders" / "banner.jpg"), -                filename='Snakes and Ladders.jpg' +                filename="Snakes and Ladders.jpg"              )          )          startup = await self.channel.send( @@ -423,7 +423,7 @@ class SnakeAndLaddersGame:          for emoji in STARTUP_SCREEN_EMOJI:              await startup.add_reaction(emoji) -        self.state = 'waiting' +        self.state = "waiting"          while not self.started:              try: @@ -460,7 +460,7 @@ class SnakeAndLaddersGame:          self.players.append(user)          self.player_tiles[user.id] = 1 -        avatar_bytes = await user.avatar_url_as(format='jpeg', size=PLAYER_ICON_IMAGE_SIZE).read() +        avatar_bytes = await user.avatar_url_as(format="jpeg", size=PLAYER_ICON_IMAGE_SIZE).read()          im = Image.open(io.BytesIO(avatar_bytes)).resize((BOARD_PLAYER_SIZE, BOARD_PLAYER_SIZE))          self.avatar_images[user.id] = im @@ -475,7 +475,7 @@ class SnakeAndLaddersGame:              if user == p:                  await self.channel.send(user.mention + " You are already in the game.", delete_after=10)                  return -        if self.state != 'waiting': +        if self.state != "waiting":              await self.channel.send(user.mention + " You cannot join at this time.", delete_after=10)              return          if len(self.players) is MAX_PLAYERS: @@ -510,7 +510,7 @@ class SnakeAndLaddersGame:                      delete_after=10                  ) -                if self.state != 'waiting' and len(self.players) == 0: +                if self.state != "waiting" and len(self.players) == 0:                      await self.channel.send("**Snakes and Ladders**: The game has been surrendered!")                      is_surrendered = True                      self._destruct() @@ -535,12 +535,12 @@ class SnakeAndLaddersGame:              await self.channel.send(user.mention + " Only the author of the game can start it.", delete_after=10)              return -        if not self.state == 'waiting': +        if not self.state == "waiting":              await self.channel.send(user.mention + " The game cannot be started at this time.", delete_after=10)              return -        self.state = 'starting' -        player_list = ', '.join(user.mention for user in self.players) +        self.state = "starting" +        player_list = ", ".join(user.mention for user in self.players)          await self.channel.send("**Snakes and Ladders**: The game is starting!\nPlayers: " + player_list)          await self.start_round() @@ -556,10 +556,10 @@ class SnakeAndLaddersGame:                  ))              ) -        self.state = 'roll' +        self.state = "roll"          for user in self.players:              self.round_has_rolled[user.id] = False -        board_img = Image.open(str(SNAKE_RESOURCES / "snakes_and_ladders" / "board.jpg")) +        board_img = Image.open(SNAKE_RESOURCES / "snakes_and_ladders" / "board.jpg")          player_row_size = math.ceil(MAX_PLAYERS / 2)          for i, player in enumerate(self.players): @@ -574,8 +574,8 @@ class SnakeAndLaddersGame:              board_img.paste(self.avatar_images[player.id],                              box=(x_offset, y_offset)) -        board_file = File(frame_to_png_bytes(board_img), filename='Board.jpg') -        player_list = '\n'.join((user.mention + ": Tile " + str(self.player_tiles[user.id])) for user in self.players) +        board_file = File(frame_to_png_bytes(board_img), filename="Board.jpg") +        player_list = "\n".join((user.mention + ": Tile " + str(self.player_tiles[user.id])) for user in self.players)          # Store and send new messages          temp_board = await self.channel.send( @@ -644,7 +644,7 @@ class SnakeAndLaddersGame:          if user.id not in self.player_tiles:              await self.channel.send(user.mention + " You are not in the match.", delete_after=10)              return -        if self.state != 'roll': +        if self.state != "roll":              await self.channel.send(user.mention + " You may not roll at this time.", delete_after=10)              return          if self.round_has_rolled[user.id]: @@ -673,7 +673,7 @@ class SnakeAndLaddersGame:      async def _complete_round(self) -> None:          """At the conclusion of a round check to see if there's been a winner.""" -        self.state = 'post_round' +        self.state = "post_round"          # check for winner          winner = self._check_winner() @@ -688,7 +688,7 @@ class SnakeAndLaddersGame:      def _check_winner(self) -> Member:          """Return a winning member if we're in the post-round state and there's a winner.""" -        if self.state != 'post_round': +        if self.state != "post_round":              return None          return next((player for player in self.players if self.player_tiles[player.id] == 100),                      None) diff --git a/bot/exts/evergreen/source.py b/bot/exts/evergreen/source.py index 45752bf9..fc209bc3 100644 --- a/bot/exts/evergreen/source.py +++ b/bot/exts/evergreen/source.py @@ -1,39 +1,18 @@  import inspect  from pathlib import Path -from typing import Optional, Tuple, Union +from typing import Optional, Tuple  from discord import Embed  from discord.ext import commands +from bot.bot import Bot  from bot.constants import Source - -SourceType = Union[commands.Command, commands.Cog, str, commands.ExtensionNotLoaded] - - -class SourceConverter(commands.Converter): -    """Convert an argument into a help command, tag, command, or cog.""" - -    async def convert(self, ctx: commands.Context, argument: str) -> SourceType: -        """Convert argument into source object.""" -        cog = ctx.bot.get_cog(argument) -        if cog: -            return cog - -        cmd = ctx.bot.get_command(argument) -        if cmd: -            return cmd - -        raise commands.BadArgument( -            f"Unable to convert `{argument}` to valid command or Cog." -        ) +from bot.utils.converters import SourceConverter, SourceType  class BotSource(commands.Cog):      """Displays information about the bot's source code.""" -    def __init__(self, bot: commands.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.""" @@ -54,7 +33,8 @@ class BotSource(commands.Cog):          Raise BadArgument if `source_item` is a dynamically-created object (e.g. via internal eval).          """          if isinstance(source_item, commands.Command): -            src = source_item.callback.__code__ +            callback = inspect.unwrap(source_item.callback) +            src = callback.__code__              filename = src.co_filename          else:              src = type(source_item) @@ -85,12 +65,8 @@ class BotSource(commands.Cog):          url, location, first_line = self.get_source_link(source_object)          if isinstance(source_object, commands.Command): -            if source_object.cog_name == 'Help': -                title = "Help Command" -                description = source_object.__doc__.splitlines()[1] -            else: -                description = source_object.short_doc -                title = f"Command: {source_object.qualified_name}" +            description = source_object.short_doc +            title = f"Command: {source_object.qualified_name}"          else:              title = f"Cog: {source_object.qualified_name}"              description = source_object.description.splitlines()[0] @@ -104,6 +80,6 @@ class BotSource(commands.Cog):          return embed -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the BotSource cog.""" -    bot.add_cog(BotSource(bot)) +    bot.add_cog(BotSource()) diff --git a/bot/exts/evergreen/space.py b/bot/exts/evergreen/space.py index 323ff659..5e87c6d5 100644 --- a/bot/exts/evergreen/space.py +++ b/bot/exts/evergreen/space.py @@ -1,15 +1,16 @@  import logging  import random  from datetime import date, datetime -from typing import Any, Dict, Optional, Union +from typing import Any, Dict, Optional  from urllib.parse import urlencode  from discord import Embed  from discord.ext import tasks -from discord.ext.commands import BadArgument, Cog, Context, Converter, group +from discord.ext.commands import Cog, Context, group  from bot.bot import Bot  from bot.constants import Tokens +from bot.utils.converters import DateConverter  from bot.utils.extensions import invoke_help_command  logger = logging.getLogger(__name__) @@ -21,25 +22,10 @@ NASA_EPIC_BASE_URL = "https://epic.gsfc.nasa.gov"  APOD_MIN_DATE = date(1995, 6, 16) -class DateConverter(Converter): -    """Parse SOL or earth date (in format YYYY-MM-DD) into `int` or `datetime`. When invalid input, raise error.""" - -    async def convert(self, ctx: Context, argument: str) -> Union[int, datetime]: -        """Parse date (SOL or earth) into `datetime` or `int`. When invalid value, raise error.""" -        if argument.isdigit(): -            return int(argument) -        try: -            date = datetime.strptime(argument, "%Y-%m-%d") -        except ValueError: -            raise BadArgument(f"Can't convert `{argument}` to `datetime` in format `YYYY-MM-DD` or `int` in SOL.") -        return date - -  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 = {} @@ -67,7 +53,7 @@ class Space(Cog):          await invoke_help_command(ctx)      @space.command(name="apod") -    async def apod(self, ctx: Context, date: Optional[str] = None) -> None: +    async def apod(self, ctx: Context, date: Optional[str]) -> None:          """          Get Astronomy Picture of Day from NASA API. Date is optional parameter, what formatting is YYYY-MM-DD. @@ -100,7 +86,7 @@ class Space(Cog):          )      @space.command(name="nasa") -    async def nasa(self, ctx: Context, *, search_term: Optional[str] = None) -> None: +    async def nasa(self, ctx: Context, *, search_term: Optional[str]) -> None:          """Get random NASA information/facts + image. Support `search_term` parameter for more specific search."""          params = {              "media_type": "image" @@ -125,8 +111,8 @@ class Space(Cog):          )      @space.command(name="epic") -    async def epic(self, ctx: Context, date: Optional[str] = None) -> None: -        """Get one of latest random image of earth from NASA EPIC API. Support date parameter, format is YYYY-MM-DD.""" +    async def epic(self, ctx: Context, date: Optional[str]) -> None: +        """Get a random image of the Earth from the NASA EPIC API. Support date parameter, format is YYYY-MM-DD."""          if date:              try:                  show_date = datetime.strptime(date, "%Y-%m-%d").date().isoformat() @@ -161,8 +147,8 @@ class Space(Cog):      async def mars(          self,          ctx: Context, -        date: Optional[DateConverter] = None, -        rover: Optional[str] = "curiosity" +        date: Optional[DateConverter], +        rover: str = "curiosity"      ) -> None:          """          Get random Mars image by date. Support both SOL (martian solar day) and earth date and rovers. @@ -207,7 +193,7 @@ class Space(Cog):              )          ) -    @mars.command(name="dates", aliases=["d", "date", "rover", "rovers", "r"]) +    @mars.command(name="dates", aliases=("d", "date", "rover", "rovers", "r"))      async def dates(self, ctx: Context) -> None:          """Get current available rovers photo date ranges."""          await ctx.send("\n".join( @@ -242,7 +228,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/speedrun.py b/bot/exts/evergreen/speedrun.py index 21aad5aa..774eff81 100644 --- a/bot/exts/evergreen/speedrun.py +++ b/bot/exts/evergreen/speedrun.py @@ -5,23 +5,22 @@ from random import choice  from discord.ext import commands +from bot.bot import Bot +  log = logging.getLogger(__name__) -with Path('bot/resources/evergreen/speedrun_links.json').open(encoding="utf8") as file: -    LINKS = json.load(file) + +LINKS = json.loads(Path("bot/resources/evergreen/speedrun_links.json").read_text("utf8"))  class Speedrun(commands.Cog):      """Commands about the video game speedrunning community.""" -    def __init__(self, bot: commands.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."""          await ctx.send(choice(LINKS)) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the Speedrun cog.""" -    bot.add_cog(Speedrun(bot)) +    bot.add_cog(Speedrun()) diff --git a/bot/exts/evergreen/status_codes.py b/bot/exts/evergreen/status_codes.py index 7c00fe20..181c71ce 100644 --- a/bot/exts/evergreen/status_codes.py +++ b/bot/exts/evergreen/status_codes.py @@ -1,30 +1,35 @@  from http import HTTPStatus +from random import choice  import discord  from discord.ext import commands -from bot.utils.extensions import invoke_help_command +from bot.bot import Bot  HTTP_DOG_URL = "https://httpstatusdogs.com/img/{code}.jpg"  HTTP_CAT_URL = "https://http.cat/{code}.jpg"  class HTTPStatusCodes(commands.Cog): -    """Commands that give HTTP statuses described and visualized by cats and dogs.""" +    """ +    Fetch an image depicting HTTP status codes as a dog or a cat. -    def __init__(self, bot: commands.Bot): +    If neither animal is selected a cat or dog is chosen randomly for the given status code. +    """ + +    def __init__(self, bot: Bot):          self.bot = bot -    @commands.group(name="http_status", aliases=("status", "httpstatus")) -    async def http_status_group(self, ctx: commands.Context) -> None: -        """Group containing dog and cat http status code commands.""" -        if not ctx.invoked_subcommand: -            await invoke_help_command(ctx) +    @commands.group(name="http_status", aliases=("status", "httpstatus"), invoke_without_command=True) +    async def http_status_group(self, ctx: commands.Context, code: int) -> None: +        """Choose a cat or dog randomly for the given status code.""" +        subcmd = choice((self.http_cat, self.http_dog)) +        await subcmd(ctx, code) -    @http_status_group.command(name='cat') +    @http_status_group.command(name="cat")      async def http_cat(self, ctx: commands.Context, code: int) -> None:          """Sends an embed with an image of a cat, portraying the status code.""" -        embed = discord.Embed(title=f'**Status: {code}**') +        embed = discord.Embed(title=f"**Status: {code}**")          url = HTTP_CAT_URL.format(code=code)          try: @@ -36,18 +41,23 @@ class HTTPStatusCodes(commands.Cog):                      raise NotImplementedError          except ValueError: -            embed.set_footer(text='Inputted status code does not exist.') +            embed.set_footer(text="Inputted status code does not exist.")          except NotImplementedError: -            embed.set_footer(text='Inputted status code is not implemented by http.cat yet.') +            embed.set_footer(text="Inputted status code is not implemented by http.cat yet.")          finally:              await ctx.send(embed=embed) -    @http_status_group.command(name='dog') +    @http_status_group.command(name="dog")      async def http_dog(self, ctx: commands.Context, code: int) -> None:          """Sends an embed with an image of a dog, portraying the status code.""" -        embed = discord.Embed(title=f'**Status: {code}**') +        # These codes aren't server-friendly. +        if code in (304, 422): +            await self.http_cat(ctx, code) +            return + +        embed = discord.Embed(title=f"**Status: {code}**")          url = HTTP_DOG_URL.format(code=code)          try: @@ -59,15 +69,15 @@ class HTTPStatusCodes(commands.Cog):                      raise NotImplementedError          except ValueError: -            embed.set_footer(text='Inputted status code does not exist.') +            embed.set_footer(text="Inputted status code does not exist.")          except NotImplementedError: -            embed.set_footer(text='Inputted status code is not implemented by httpstatusdogs.com yet.') +            embed.set_footer(text="Inputted status code is not implemented by httpstatusdogs.com yet.")          finally:              await ctx.send(embed=embed) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the HTTPStatusCodes cog."""      bot.add_cog(HTTPStatusCodes(bot)) diff --git a/bot/exts/evergreen/tic_tac_toe.py b/bot/exts/evergreen/tic_tac_toe.py index 6c33ebc4..48e8e142 100644 --- a/bot/exts/evergreen/tic_tac_toe.py +++ b/bot/exts/evergreen/tic_tac_toe.py @@ -58,7 +58,7 @@ class Player:              )          try: -            react, _ = await self.ctx.bot.wait_for('reaction_add', timeout=30.0, check=check_for_move) +            react, _ = await self.ctx.bot.wait_for("reaction_add", timeout=30.0, check=check_for_move)          except asyncio.TimeoutError:              return True, None          else: @@ -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):          self.games: t.List[Game] = []      @guild_only() @@ -327,5 +326,5 @@ class TicTacToe(Cog):  def setup(bot: Bot) -> None: -    """Load TicTacToe Cog.""" -    bot.add_cog(TicTacToe(bot)) +    """Load the TicTacToe cog.""" +    bot.add_cog(TicTacToe()) diff --git a/bot/exts/evergreen/timed.py b/bot/exts/evergreen/timed.py index 5f177fd6..2ea6b419 100644 --- a/bot/exts/evergreen/timed.py +++ b/bot/exts/evergreen/timed.py @@ -4,6 +4,8 @@ from time import perf_counter  from discord import Message  from discord.ext import commands +from bot.bot import Bot +  class TimedCommands(commands.Cog):      """Time the command execution of a command.""" @@ -16,7 +18,7 @@ class TimedCommands(commands.Cog):          return await ctx.bot.get_context(msg) -    @commands.command(name="timed", aliases=["time", "t"]) +    @commands.command(name="timed", aliases=("time", "t"))      async def timed(self, ctx: commands.Context, *, command: str) -> None:          """Time the command execution of a command."""          new_ctx = await self.create_execution_context(ctx, command) @@ -41,6 +43,6 @@ class TimedCommands(commands.Cog):          await ctx.send(f"Command execution for `{new_ctx.command}` finished in {(t_end - t_start):.4f} seconds.") -def setup(bot: commands.Bot) -> None: -    """Cog load.""" -    bot.add_cog(TimedCommands(bot)) +def setup(bot: Bot) -> None: +    """Load the Timed cog.""" +    bot.add_cog(TimedCommands()) diff --git a/bot/exts/evergreen/trivia_quiz.py b/bot/exts/evergreen/trivia_quiz.py index fe692c2a..a8d10afd 100644 --- a/bot/exts/evergreen/trivia_quiz.py +++ b/bot/exts/evergreen/trivia_quiz.py @@ -1,56 +1,235 @@  import asyncio  import json  import logging +import operator  import random +from dataclasses import dataclass  from pathlib import Path +from typing import Callable, List, Optional  import discord  from discord.ext import commands  from fuzzywuzzy import fuzz -from bot.constants import Roles - +from bot.bot import Bot +from bot.constants import Colours, NEGATIVE_REPLIES, Roles  logger = logging.getLogger(__name__) +DEFAULT_QUESTION_LIMIT = 6 +STANDARD_VARIATION_TOLERANCE = 83 +DYNAMICALLY_GEN_VARIATION_TOLERANCE = 95  WRONG_ANS_RESPONSE = [      "No one answered correctly!", -    "Better luck next time" +    "Better luck next time...", +] + +N_PREFIX_STARTS_AT = 5 +N_PREFIXES = [ +    "penta", "hexa", "hepta", "octa", "nona", +    "deca", "hendeca", "dodeca", "trideca", "tetradeca", +] + +PLANETS = [ +    ("1st", "Mercury"), +    ("2nd", "Venus"), +    ("3rd", "Earth"), +    ("4th", "Mars"), +    ("5th", "Jupiter"), +    ("6th", "Saturn"), +    ("7th", "Uranus"), +    ("8th", "Neptune"), +] + +TAXONOMIC_HIERARCHY = [ +    "species", "genus", "family", "order", +    "class", "phylum", "kingdom", "domain",  ] +UNITS_TO_BASE_UNITS = { +    "hertz": ("(unit of frequency)", "s^-1"), +    "newton": ("(unit of force)", "m*kg*s^-2"), +    "pascal": ("(unit of pressure & stress)", "m^-1*kg*s^-2"), +    "joule": ("(unit of energy & quantity of heat)", "m^2*kg*s^-2"), +    "watt": ("(unit of power)", "m^2*kg*s^-3"), +    "coulomb": ("(unit of electric charge & quantity of electricity)", "s*A"), +    "volt": ("(unit of voltage & electromotive force)", "m^2*kg*s^-3*A^-1"), +    "farad": ("(unit of capacitance)", "m^-2*kg^-1*s^4*A^2"), +    "ohm": ("(unit of electric resistance)", "m^2*kg*s^-3*A^-2"), +    "weber": ("(unit of magnetic flux)", "m^2*kg*s^-2*A^-1"), +    "tesla": ("(unit of magnetic flux density)", "kg*s^-2*A^-1"), +} + + +@dataclass(frozen=True) +class QuizEntry: +    """Dataclass for a quiz entry (a question and a string containing answers separated by commas).""" + +    question: str +    answer: str + + +def linear_system(q_format: str, a_format: str) -> QuizEntry: +    """Generate a system of linear equations with two unknowns.""" +    x, y = random.randint(2, 5), random.randint(2, 5) +    answer = a_format.format(x, y) + +    coeffs = random.sample(range(1, 6), 4) + +    question = q_format.format( +        coeffs[0], +        coeffs[1], +        coeffs[0] * x + coeffs[1] * y, +        coeffs[2], +        coeffs[3], +        coeffs[2] * x + coeffs[3] * y, +    ) + +    return QuizEntry(question, answer) + + +def mod_arith(q_format: str, a_format: str) -> QuizEntry: +    """Generate a basic modular arithmetic question.""" +    quotient, m, b = random.randint(30, 40), random.randint(10, 20), random.randint(200, 350) +    ans = random.randint(0, 9)  # max remainder is 9, since the minimum modulus is 10 +    a = quotient * m + ans - b + +    question = q_format.format(a, b, m) +    answer = a_format.format(ans) + +    return QuizEntry(question, answer) + + +def ngonal_prism(q_format: str, a_format: str) -> QuizEntry: +    """Generate a question regarding vertices on n-gonal prisms.""" +    n = random.randint(0, len(N_PREFIXES) - 1) + +    question = q_format.format(N_PREFIXES[n]) +    answer = a_format.format((n + N_PREFIX_STARTS_AT) * 2) + +    return QuizEntry(question, answer) + + +def imag_sqrt(q_format: str, a_format: str) -> QuizEntry: +    """Generate a negative square root question.""" +    ans_coeff = random.randint(3, 10) + +    question = q_format.format(ans_coeff ** 2) +    answer = a_format.format(ans_coeff) + +    return QuizEntry(question, answer) + + +def binary_calc(q_format: str, a_format: str) -> QuizEntry: +    """Generate a binary calculation question.""" +    a = random.randint(15, 20) +    b = random.randint(10, a) +    oper = random.choice( +        ( +            ("+", operator.add), +            ("-", operator.sub), +            ("*", operator.mul), +        ) +    ) + +    # if the operator is multiplication, lower the values of the two operands to make it easier +    if oper[0] == "*": +        a -= 5 +        b -= 5 + +    question = q_format.format(a, oper[0], b) +    answer = a_format.format(oper[1](a, b)) + +    return QuizEntry(question, answer) + + +def solar_system(q_format: str, a_format: str) -> QuizEntry: +    """Generate a question on the planets of the Solar System.""" +    planet = random.choice(PLANETS) + +    question = q_format.format(planet[0]) +    answer = a_format.format(planet[1]) + +    return QuizEntry(question, answer) + + +def taxonomic_rank(q_format: str, a_format: str) -> QuizEntry: +    """Generate a question on taxonomic classification.""" +    level = random.randint(0, len(TAXONOMIC_HIERARCHY) - 2) + +    question = q_format.format(TAXONOMIC_HIERARCHY[level]) +    answer = a_format.format(TAXONOMIC_HIERARCHY[level + 1]) + +    return QuizEntry(question, answer) + + +def base_units_convert(q_format: str, a_format: str) -> QuizEntry: +    """Generate a SI base units conversion question.""" +    unit = random.choice(list(UNITS_TO_BASE_UNITS)) + +    question = q_format.format( +        unit + " " + UNITS_TO_BASE_UNITS[unit][0] +    ) +    answer = a_format.format( +        UNITS_TO_BASE_UNITS[unit][1] +    ) + +    return QuizEntry(question, answer) + + +DYNAMIC_QUESTIONS_FORMAT_FUNCS = { +    201: linear_system, +    202: mod_arith, +    203: ngonal_prism, +    204: imag_sqrt, +    205: binary_calc, +    301: solar_system, +    302: taxonomic_rank, +    303: base_units_convert, +} +  class TriviaQuiz(commands.Cog):      """A cog for all quiz commands.""" -    def __init__(self, bot: commands.Bot) -> None: +    def __init__(self, bot: Bot) -> None:          self.bot = bot -        self.questions = self.load_questions() +          self.game_status = {}  # A variable to store the game status: either running or not running.          self.game_owners = {}  # A variable to store the person's ID who started the quiz game in a channel. -        self.question_limit = 4 + +        self.questions = self.load_questions() +        self.question_limit = 0 +          self.player_scores = {}  # A variable to store all player's scores for a bot session.          self.game_player_scores = {}  # A variable to store temporary game player's scores. +          self.categories = { -            "general": "Test your general knowledge" -            # "retro": "Questions related to retro gaming." +            "general": "Test your general knowledge.", +            "retro": "Questions related to retro gaming.", +            "math": "General questions about mathematics ranging from grade 8 to grade 12.", +            "science": "Put your understanding of science to the test!",          }      @staticmethod      def load_questions() -> dict:          """Load the questions from the JSON file."""          p = Path("bot", "resources", "evergreen", "trivia_quiz.json") -        with p.open(encoding="utf8") as json_data: -            questions = json.load(json_data) -            return questions + +        return json.loads(p.read_text(encoding="utf-8"))      @commands.group(name="quiz", aliases=["trivia"], invoke_without_command=True) -    async def quiz_game(self, ctx: commands.Context, category: str = None) -> None: +    async def quiz_game(self, ctx: commands.Context, category: Optional[str], questions: Optional[int]) -> None:          """          Start a quiz!          Questions for the quiz can be selected from the following categories: -        - general : Test your general knowledge. (default) +        - general: Test your general knowledge. (default) +        - retro: Questions related to retro gaming. +        - math: General questions about mathematics ranging from grade 8 to grade 12. +        - science: Put your understanding of science to the test! +          (More to come!)          """          if ctx.channel.id not in self.game_status: @@ -60,11 +239,12 @@ class TriviaQuiz(commands.Cog):              self.game_player_scores[ctx.channel.id] = {}          # Stop game if running. -        if self.game_status[ctx.channel.id] is True: -            return await ctx.send( -                f"Game is already running..." +        if self.game_status[ctx.channel.id]: +            await ctx.send( +                "Game is already running... "                  f"do `{self.bot.command_prefix}quiz stop`"              ) +            return          # Send embed showing available categories if inputted category is invalid.          if category is None: @@ -76,8 +256,35 @@ class TriviaQuiz(commands.Cog):              await ctx.send(embed=embed)              return +        topic = self.questions[category] +        topic_length = len(topic) + +        if questions is None: +            self.question_limit = DEFAULT_QUESTION_LIMIT +        else: +            if questions > topic_length: +                await ctx.send( +                    embed=self.make_error_embed( +                        f"This category only has {topic_length} questions. " +                        "Please input a lower value!" +                    ) +                ) +                return + +            elif questions < 1: +                await ctx.send( +                    embed=self.make_error_embed( +                        "You must choose to complete at least one question. " +                        f"(or enter nothing for the default value of {DEFAULT_QUESTION_LIMIT + 1} questions)" +                    ) +                ) +                return + +            else: +                self.question_limit = questions - 1 +          # Start game if not running. -        if self.game_status[ctx.channel.id] is False: +        if not self.game_status[ctx.channel.id]:              self.game_owners[ctx.channel.id] = ctx.author              self.game_status[ctx.channel.id] = True              start_embed = self.make_start_embed(category) @@ -85,11 +292,10 @@ class TriviaQuiz(commands.Cog):              await ctx.send(embed=start_embed)  # send an embed with the rules              await asyncio.sleep(1) -        topic = self.questions[category] -          done_question = []          hint_no = 0 -        answer = None +        answers = None +          while self.game_status[ctx.channel.id]:              # Exit quiz if number of questions for a round are already sent.              if len(done_question) > self.question_limit and hint_no == 0: @@ -111,34 +317,58 @@ class TriviaQuiz(commands.Cog):                          done_question.append(question_dict["id"])                          break -                q = question_dict["question"] -                answer = question_dict["answer"] +                if "dynamic_id" not in question_dict: +                    question = question_dict["question"] +                    answers = question_dict["answer"].split(", ") + +                    var_tol = STANDARD_VARIATION_TOLERANCE +                else: +                    format_func = DYNAMIC_QUESTIONS_FORMAT_FUNCS[question_dict["dynamic_id"]] + +                    quiz_entry = format_func( +                        question_dict["question"], +                        question_dict["answer"], +                    ) -                embed = discord.Embed(colour=discord.Colour.gold()) -                embed.title = f"Question #{len(done_question)}" -                embed.description = q -                await ctx.send(embed=embed)  # Send question embed. +                    question, answers = quiz_entry.question, quiz_entry.answer +                    answers = [answers] -            # A function to check whether user input is the correct answer(close to the right answer) -            def check(m: discord.Message) -> bool: -                return ( -                    m.channel == ctx.channel -                    and fuzz.ratio(answer.lower(), m.content.lower()) > 85 +                    var_tol = DYNAMICALLY_GEN_VARIATION_TOLERANCE + +                embed = discord.Embed( +                    colour=Colours.gold, +                    title=f"Question #{len(done_question)}", +                    description=question,                  ) +                if img_url := question_dict.get("img_url"): +                    embed.set_image(url=img_url) + +                await ctx.send(embed=embed) + +            def check_func(variation_tolerance: int) -> Callable[[discord.Message], bool]: +                def contains_correct_answer(m: discord.Message) -> bool: +                    return m.channel == ctx.channel and any( +                        fuzz.ratio(answer.lower(), m.content.lower()) > variation_tolerance +                        for answer in answers +                    ) + +                return contains_correct_answer +              try: -                msg = await self.bot.wait_for('message', check=check, timeout=10) +                msg = await self.bot.wait_for("message", check=check_func(var_tol), timeout=10)              except asyncio.TimeoutError:                  # In case of TimeoutError and the game has been stopped, then do nothing. -                if self.game_status[ctx.channel.id] is False: +                if not self.game_status[ctx.channel.id]:                      break -                # if number of hints sent or time alerts sent is less than 2, then send one.                  if hint_no < 2:                      hint_no += 1 +                      if "hints" in question_dict:                          hints = question_dict["hints"] -                        await ctx.send(f"**Hint #{hint_no+1}\n**{hints[hint_no]}") + +                        await ctx.send(f"**Hint #{hint_no}\n**{hints[hint_no - 1]}")                      else:                          await ctx.send(f"{30 - hint_no * 10}s left!") @@ -151,10 +381,17 @@ class TriviaQuiz(commands.Cog):                      response = random.choice(WRONG_ANS_RESPONSE)                      await ctx.send(response) -                    await self.send_answer(ctx.channel, question_dict) + +                    await self.send_answer( +                        ctx.channel, +                        answers, +                        False, +                        question_dict, +                        self.question_limit - len(done_question) + 1, +                    )                      await asyncio.sleep(1) -                    hint_no = 0  # init hint_no = 0 so that 2 hints/time alerts can be sent for the new question. +                    hint_no = 0  # Reset the hint counter so that on the next round, it's in the initial state                      await self.send_score(ctx.channel, self.game_player_scores[ctx.channel.id])                      await asyncio.sleep(2) @@ -162,8 +399,7 @@ class TriviaQuiz(commands.Cog):                  if self.game_status[ctx.channel.id] is False:                      break -                # Reduce points by 25 for every hint/time alert that has been sent. -                points = 100 - 25*hint_no +                points = 100 - 25 * hint_no                  if msg.author in self.game_player_scores[ctx.channel.id]:                      self.game_player_scores[ctx.channel.id][msg.author] += points                  else: @@ -178,23 +414,50 @@ class TriviaQuiz(commands.Cog):                  hint_no = 0                  await ctx.send(f"{msg.author.mention} got the correct answer :tada: {points} points!") -                await self.send_answer(ctx.channel, question_dict) + +                await self.send_answer( +                    ctx.channel, +                    answers, +                    True, +                    question_dict, +                    self.question_limit - len(done_question) + 1, +                )                  await self.send_score(ctx.channel, self.game_player_scores[ctx.channel.id]) +                  await asyncio.sleep(2) -    @staticmethod -    def make_start_embed(category: str) -> discord.Embed: +    def make_start_embed(self, category: str) -> discord.Embed:          """Generate a starting/introduction embed for the quiz.""" -        start_embed = discord.Embed(colour=discord.Colour.red()) -        start_embed.title = "Quiz game Starting!!" -        start_embed.description = "Each game consists of 5 questions.\n" -        start_embed.description += "**Rules :**\nNo cheating and have fun!" -        start_embed.description += f"\n **Category** : {category}" +        start_embed = discord.Embed( +            colour=Colours.blue, +            title="Quiz game starting!", +            description=( +                f"This game consists of {self.question_limit + 1} questions.\n" +                "**Rules: **No cheating and have fun!\n" +                f"**Category**: {category}" +            ), +        ) +          start_embed.set_footer( -            text="Points for each question reduces by 25 after 10s or after a hint. Total time is 30s per question" +            text=( +                "Points for each question reduces by 25 after 10s or after a hint. " +                "Total time is 30s per question" +            )          ) +          return start_embed +    @staticmethod +    def make_error_embed(desc: str) -> discord.Embed: +        """Generate an error embed with the given description.""" +        error_embed = discord.Embed( +            colour=Colours.soft_red, +            title=random.choice(NEGATIVE_REPLIES), +            description=desc, +        ) + +        return error_embed +      @quiz_game.command(name="stop")      async def stop_quiz(self, ctx: commands.Context) -> None:          """ @@ -202,21 +465,24 @@ class TriviaQuiz(commands.Cog):          Note: Only mods or the owner of the quiz can stop it.          """ -        if self.game_status[ctx.channel.id] is True: -            # Check if the author is the game starter or a moderator. -            if ( -                ctx.author == self.game_owners[ctx.channel.id] -                or any(Roles.moderator == role.id for role in ctx.author.roles) -            ): -                await ctx.send("Quiz stopped.") -                await self.declare_winner(ctx.channel, self.game_player_scores[ctx.channel.id]) +        try: +            if self.game_status[ctx.channel.id]: +                # Check if the author is the game starter or a moderator. +                if ctx.author == self.game_owners[ctx.channel.id] or any( +                    Roles.moderator == role.id for role in ctx.author.roles +                ): +                    self.game_status[ctx.channel.id] = False +                    del self.game_owners[ctx.channel.id] +                    self.game_player_scores[ctx.channel.id] = {} + +                    await ctx.send("Quiz stopped.") +                    await self.declare_winner(ctx.channel, self.game_player_scores[ctx.channel.id]) -                self.game_status[ctx.channel.id] = False -                del self.game_owners[ctx.channel.id] -                self.game_player_scores[ctx.channel.id] = {} +                else: +                    await ctx.send(f"{ctx.author.mention}, you are not authorised to stop this game :ghost:!")              else: -                await ctx.send(f"{ctx.author.mention}, you are not authorised to stop this game :ghost:!") -        else: +                await ctx.send("No quiz running.") +        except KeyError:              await ctx.send("No quiz running.")      @quiz_game.command(name="leaderboard") @@ -226,18 +492,20 @@ class TriviaQuiz(commands.Cog):      @staticmethod      async def send_score(channel: discord.TextChannel, player_data: dict) -> None: -        """A function which sends the score.""" +        """Send the current scores of players in the game channel."""          if len(player_data) == 0:              await channel.send("No one has made it onto the leaderboard yet.")              return -        embed = discord.Embed(colour=discord.Colour.blue()) -        embed.title = "Score Board" -        embed.description = "" +        embed = discord.Embed( +            colour=Colours.blue, +            title="Score Board", +            description="", +        ) -        sorted_dict = sorted(player_data.items(), key=lambda a: a[1], reverse=True) +        sorted_dict = sorted(player_data.items(), key=operator.itemgetter(1), reverse=True)          for item in sorted_dict: -            embed.description += f"{item[0]} : {item[1]}\n" +            embed.description += f"{item[0]}: {item[1]}\n"          await channel.send(embed=embed) @@ -250,7 +518,6 @@ class TriviaQuiz(commands.Cog):              # Check if more than 1 player has highest points.              if no_of_winners > 1: -                word = "You guys"                  winners = []                  points_copy = list(player_data.values()).copy() @@ -261,44 +528,65 @@ class TriviaQuiz(commands.Cog):                  winners_mention = " ".join(winner.mention for winner in winners)              else: -                word = "You"                  author_index = list(player_data.values()).index(highest_points)                  winner = list(player_data.keys())[author_index]                  winners_mention = winner.mention              await channel.send(                  f"Congratulations {winners_mention} :tada: " -                f"{word} have won this quiz game with a grand total of {highest_points} points!" +                f"You have won this quiz game with a grand total of {highest_points} points!"              )      def category_embed(self) -> discord.Embed:          """Build an embed showing all available trivia categories.""" -        embed = discord.Embed(colour=discord.Colour.blue()) -        embed.title = "The available question categories are:" +        embed = discord.Embed( +            colour=Colours.blue, +            title="The available question categories are:", +            description="", +        ) +          embed.set_footer(text="If a category is not chosen, a random one will be selected.") -        embed.description = ""          for cat, description in self.categories.items(): -            embed.description += f"**- {cat.capitalize()}**\n{description.capitalize()}\n" +            embed.description += ( +                f"**- {cat.capitalize()}**\n" +                f"{description.capitalize()}\n" +            )          return embed      @staticmethod -    async def send_answer(channel: discord.TextChannel, question_dict: dict) -> None: +    async def send_answer( +        channel: discord.TextChannel, +        answers: List[str], +        answer_is_correct: bool, +        question_dict: dict, +        q_left: int, +    ) -> None:          """Send the correct answer of a question to the game channel.""" -        answer = question_dict["answer"] -        info = question_dict["info"] -        embed = discord.Embed(color=discord.Colour.red()) -        embed.title = f"The correct answer is **{answer}**\n" -        embed.description = "" +        info = question_dict.get("info") + +        plurality = " is" if len(answers) == 1 else "s are" -        if info != "": +        embed = discord.Embed( +            color=Colours.bright_green, +            title=( +                ("You got it! " if answer_is_correct else "") +                + f"The correct answer{plurality} **`{', '.join(answers)}`**\n" +            ), +            description="", +        ) + +        if info is not None:              embed.description += f"**Information**\n{info}\n\n" -        embed.description += "Let's move to the next question.\nRemaining questions: " +        embed.description += ( +            ("Let's move to the next question." if q_left > 0 else "") +            + f"\nRemaining questions: {q_left}" +        )          await channel.send(embed=embed) -def setup(bot: commands.Bot) -> None: -    """Load the cog.""" +def setup(bot: Bot) -> None: +    """Load the TriviaQuiz cog."""      bot.add_cog(TriviaQuiz(bot)) diff --git a/bot/exts/evergreen/wikipedia.py b/bot/exts/evergreen/wikipedia.py index 068c4f43..83937438 100644 --- a/bot/exts/evergreen/wikipedia.py +++ b/bot/exts/evergreen/wikipedia.py @@ -20,7 +20,7 @@ WIKI_THUMBNAIL = (      "https://upload.wikimedia.org/wikipedia/en/thumb/8/80/Wikipedia-logo-v2.svg"      "/330px-Wikipedia-logo-v2.svg.png"  ) -WIKI_SNIPPET_REGEX = r'(<!--.*?-->|<[^>]*>)' +WIKI_SNIPPET_REGEX = r"(<!--.*?-->|<[^>]*>)"  WIKI_SEARCH_RESULT = (      "**[{name}]({url})**\n"      "{description}\n" @@ -39,18 +39,18 @@ class WikipediaSearch(commands.Cog):          async with self.bot.http_session.get(url=url) as resp:              if resp.status == 200:                  raw_data = await resp.json() -                number_of_results = raw_data['query']['searchinfo']['totalhits'] +                number_of_results = raw_data["query"]["searchinfo"]["totalhits"]                  if number_of_results: -                    results = raw_data['query']['search'] +                    results = raw_data["query"]["search"]                      lines = []                      for article in results:                          line = WIKI_SEARCH_RESULT.format( -                            name=article['title'], +                            name=article["title"],                              description=unescape(                                  re.sub( -                                    WIKI_SNIPPET_REGEX, '', article['snippet'] +                                    WIKI_SNIPPET_REGEX, "", article["snippet"]                                  )                              ),                              url=f"https://en.wikipedia.org/?curid={article['pageid']}" @@ -72,7 +72,7 @@ class WikipediaSearch(commands.Cog):                  return      @commands.cooldown(1, 10, commands.BucketType.user) -    @commands.command(name="wikipedia", aliases=["wiki"]) +    @commands.command(name="wikipedia", aliases=("wiki",))      async def wikipedia_search_command(self, ctx: commands.Context, *, search: str) -> None:          """Sends paginated top 10 results of Wikipedia search.."""          contents = await self.wiki_request(ctx.channel, search) @@ -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/wolfram.py b/bot/exts/evergreen/wolfram.py index 14ec1041..d23afd6f 100644 --- a/bot/exts/evergreen/wolfram.py +++ b/bot/exts/evergreen/wolfram.py @@ -9,6 +9,7 @@ from discord import Embed  from discord.ext import commands  from discord.ext.commands import BucketType, Cog, Context, check, group +from bot.bot import Bot  from bot.constants import Colours, STAFF_ROLES, Wolfram  from bot.utils.pagination import ImagePaginator @@ -39,9 +40,11 @@ async def send_embed(      """Generate & send a response embed with Wolfram as the author."""      embed = Embed(colour=colour)      embed.description = message_txt -    embed.set_author(name="Wolfram Alpha", -                     icon_url=WOLF_IMAGE, -                     url="https://www.wolframalpha.com/") +    embed.set_author( +        name="Wolfram Alpha", +        icon_url=WOLF_IMAGE, +        url="https://www.wolframalpha.com/" +    )      if footer:          embed.set_footer(text=footer) @@ -55,10 +58,10 @@ def custom_cooldown(*ignore: List[int]) -> Callable:      """      Implement per-user and per-guild cooldowns for requests to the Wolfram API. -    A list of roles may be provided to ignore the per-user cooldown +    A list of roles may be provided to ignore the per-user cooldown.      """      async def predicate(ctx: Context) -> bool: -        if ctx.invoked_with == 'help': +        if ctx.invoked_with == "help":              # if the invoked command is help we don't want to increase the ratelimits since it's not actually              # invoking the command/making a request, so instead just check if the user/guild are on cooldown.              guild_cooldown = not guildcd.get_bucket(ctx.message).get_tokens() == 0  # if guild is on cooldown @@ -102,9 +105,9 @@ def custom_cooldown(*ignore: List[int]) -> Callable:      return check(predicate) -async def get_pod_pages(ctx: Context, bot: commands.Bot, query: str) -> Optional[List[Tuple]]: +async def get_pod_pages(ctx: Context, bot: Bot, query: str) -> Optional[List[Tuple]]:      """Get the Wolfram API pod pages for the provided query.""" -    async with ctx.channel.typing(): +    async with ctx.typing():          url_str = parse.urlencode({              "input": query,              "appid": APPID, @@ -117,7 +120,7 @@ async def get_pod_pages(ctx: Context, bot: commands.Bot, query: str) -> Optional          request_url = QUERY.format(request="query", data=url_str)          async with bot.http_session.get(request_url) as response: -            json = await response.json(content_type='text/plain') +            json = await response.json(content_type="text/plain")          result = json["queryresult"] @@ -162,7 +165,7 @@ async def get_pod_pages(ctx: Context, bot: commands.Bot, query: str) -> Optional  class Wolfram(Cog):      """Commands for interacting with the Wolfram|Alpha API.""" -    def __init__(self, bot: commands.Bot): +    def __init__(self, bot: Bot):          self.bot = bot      @group(name="wolfram", aliases=("wolf", "wa"), invoke_without_command=True) @@ -179,7 +182,7 @@ class Wolfram(Cog):          query = QUERY.format(request="simple", data=url_str)          # Give feedback that the bot is working. -        async with ctx.channel.typing(): +        async with ctx.typing():              async with self.bot.http_session.get(query) as response:                  status = response.status                  image_bytes = await response.read() @@ -188,11 +191,11 @@ class Wolfram(Cog):              image_url = "attachment://image.png"              if status == 501: -                message = "Failed to get response" +                message = "Failed to get response."                  footer = ""                  color = Colours.soft_red              elif status == 400: -                message = "No input found" +                message = "No input found."                  footer = ""                  color = Colours.soft_red              elif status == 403: @@ -221,9 +224,11 @@ class Wolfram(Cog):              return          embed = Embed() -        embed.set_author(name="Wolfram Alpha", -                         icon_url=WOLF_IMAGE, -                         url="https://www.wolframalpha.com/") +        embed.set_author( +            name="Wolfram Alpha", +            icon_url=WOLF_IMAGE, +            url="https://www.wolframalpha.com/" +        )          embed.colour = Colours.soft_orange          await ImagePaginator.paginate(pages, ctx, embed) @@ -262,18 +267,18 @@ class Wolfram(Cog):          query = QUERY.format(request="result", data=url_str)          # Give feedback that the bot is working. -        async with ctx.channel.typing(): +        async with ctx.typing():              async with self.bot.http_session.get(query) as response:                  status = response.status                  response_text = await response.text()              if status == 501: -                message = "Failed to get response" +                message = "Failed to get response."                  color = Colours.soft_red              elif status == 400: -                message = "No input found" +                message = "No input found."                  color = Colours.soft_red -            elif response_text == "Error 1: Invalid appid": +            elif response_text == "Error 1: Invalid appid.":                  message = "Wolfram API key is invalid or missing."                  color = Colours.soft_red              else: @@ -283,6 +288,6 @@ class Wolfram(Cog):              await send_embed(ctx, message, color) -def setup(bot: commands.Bot) -> None: +def setup(bot: Bot) -> None:      """Load the Wolfram cog."""      bot.add_cog(Wolfram(bot)) diff --git a/bot/exts/evergreen/wonder_twins.py b/bot/exts/evergreen/wonder_twins.py index afc5346e..40edf785 100644 --- a/bot/exts/evergreen/wonder_twins.py +++ b/bot/exts/evergreen/wonder_twins.py @@ -2,15 +2,15 @@ import random  from pathlib import Path  import yaml -from discord.ext.commands import Bot, Cog, Context, command +from discord.ext.commands import Cog, Context, command + +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):          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"] @@ -38,7 +38,7 @@ class WonderTwins(Cog):              object_name = self.append_onto(adjective, object_name)          return f"{object_name} of {water_type}" -    @command(name="formof", aliases=["wondertwins", "wondertwin", "fo"]) +    @command(name="formof", aliases=("wondertwins", "wondertwin", "fo"))      async def form_of(self, ctx: Context) -> None:          """Command to send a Wonder Twins inspired phrase to the user invoking the command."""          await ctx.send(f"Form of {self.format_phrase()}!") @@ -46,4 +46,4 @@ class WonderTwins(Cog):  def setup(bot: Bot) -> None:      """Load the WonderTwins cog.""" -    bot.add_cog(WonderTwins(bot)) +    bot.add_cog(WonderTwins()) diff --git a/bot/exts/evergreen/xkcd.py b/bot/exts/evergreen/xkcd.py index 1ff98ca2..c98830bc 100644 --- a/bot/exts/evergreen/xkcd.py +++ b/bot/exts/evergreen/xkcd.py @@ -53,7 +53,7 @@ class XKCD(Cog):              await ctx.send(embed=embed)              return -        comic = randint(1, self.latest_comic_info['num']) if comic is None else comic.group(0) +        comic = randint(1, self.latest_comic_info["num"]) if comic is None else comic.group(0)          if comic == "latest":              info = self.latest_comic_info @@ -69,7 +69,7 @@ class XKCD(Cog):                      return          embed.title = f"XKCD comic #{info['num']}" -        embed.description = info['alt'] +        embed.description = info["alt"]          embed.url = f"{BASE_URL}/{info['num']}"          if info["img"][-3:] in ("jpg", "png", "gif"): @@ -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)) | 
