Skip to content

Switch to extension based Cogs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Switch to extension based Cogs #7

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6769861
Switch to extension based Cogs
Oct 3, 2021
37adce7
Add !issue command
Oct 3, 2021
3003342
Update git.py
Oct 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions sanic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
from discord.ext import commands

from sanicbot.core.cogs import HelpCog, GitCog
from sanicbot.core.config import config

bot = commands.Bot(help_command=None, command_prefix=None)
git_cog = GitCog(bot)

EXTENSIONS = (
'sanicbot.extensions.git',
'sanicbot.extensions.help',
)


def main():
bot = commands.Bot(help_command=None, command_prefix='!')

for ext in EXTENSIONS:
bot.load_extension(ext)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By adding Cog classes using bot.add_cog we can avoid adding setup() functions to the cog files. (see PR #8 for implementation). By extending the commands.Bot class we have more control over the bot scope and can handle adding cogs more elegantly.


if __name__ == '__main__':
bot.command_prefix = '!'
bot.add_cog(git_cog)
bot.add_cog(HelpCog(bot))
bot.run(config['SANIC']['token'])


if __name__ == '__main__':
main()
Empty file added sanicbot/extensions/__init__.py
View file
Open in desktop
Empty file.
13 changes: 4 additions & 9 deletions sanicbot/core/cogs.py → sanicbot/extensions/git.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
from sanicbot.core.utils import failure_message, success_message


class GitCog(commands.Cog):
class Git(commands.Cog):
issue_pattern = re.compile(r"#(?P<issue_id>[1,2]\d{3})")

def __init__(self, bot):
def __init__(self, bot: commands.Bot) -> None:
self.bot = bot

async def lookup(self, ctx: Context, number: int, repo: str):
Expand Down Expand Up @@ -51,12 +51,7 @@ async def github_issue_message_listener(self, message: Message):
await self.lookup(
message.channel, int(match.group("issue_id")), "sanic"
)
else:
await self.bot.process_commands(message)


class HelpCog(commands.Cog):
@commands.command()
async def help(self, ctx):
with open("./resources/help.txt") as f:
await ctx.send(f.read())
def setup(bot: commands.Bot):
bot.add_cog(Git(bot))
13 changes: 13 additions & 0 deletions sanicbot/extensions/help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from discord.ext import commands


class Help(commands.Cog):
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By switching to application (slash) commands, this cog becomes obsolete. A user simply needs to start typing / to get a list of commands and their descriptions.

@commands.command()
async def help(self, ctx):
with open("./resources/help.txt") as f:
await ctx.send(f.read())


def setup(bot: commands.Bot):
bot.add_cog(Help())