From cba2478e1532510c5ae6c9b7d8e57a7041b4a872 Mon Sep 17 00:00:00 2001 From: Colby Gallup Date: Tue, 13 Oct 2020 23:52:58 -0400 Subject: [PATCH 1/2] Refactor: class -> topic --- lehrbot.py | 82 ++++++++++++++++++++--------------------- classes.py => topics.py | 16 ++++---- 2 files changed, 49 insertions(+), 49 deletions(-) rename classes.py => topics.py (73%) diff --git a/lehrbot.py b/lehrbot.py index c8c8cc1..1e25c26 100644 --- a/lehrbot.py +++ b/lehrbot.py @@ -10,60 +10,60 @@ from discord.message import Message from discord.embeds import Embed -import classes +import topics client: discord.Client = discord.Client() queues: Dict[str, List[Member]] = defaultdict(list) -def get_all_classes(guild: Guild) -> List[str]: +def get_all_topics(guild: Guild) -> List[str]: roles: List[Role] = guild.roles r: Role return [r.name[6:] for r in roles if r.name.startswith('Class-')] -async def showclasses(user: Member, channel: TextChannel) -> None: +async def showtopics(user: Member, channel: TextChannel) -> None: out = user.mention + " List of classes:\n" - out += "\n".join(get_all_classes(channel.guild)) + out += "\n".join(get_all_topics(channel.guild)) await channel.send(out) -async def joinqueue(user: Member, channel: TextChannel, cls: str) -> None: - if cls not in get_all_classes(channel.guild): +async def joinqueue(user: Member, channel: TextChannel, topic: str) -> None: + if topic not in get_all_topics(channel.guild): await channel.send( - user.mention + ' Section {} does not exist.'.format(cls) + user.mention + ' Topic {} does not exist.'.format(topic) ) return - if user in queues[cls]: - queues[cls].remove(user) + if user in queues[topic]: + queues[topic].remove(user) await channel.send( - user.mention + ' has left the {} queue.'.format(cls) + user.mention + ' has left the {} queue.'.format(topic) ) else: - queues[cls].append(user) + queues[topic].append(user) await channel.send( - user.mention + ' has joined the {} queue.'.format(cls) + user.mention + ' has joined the {} queue.'.format(topic) ) -async def showqueue(caller: Member, channel: TextChannel, cls: str) -> None: +async def showqueue(caller: Member, channel: TextChannel, topic: str) -> None: user: Member - if len(queues[cls]) == 0: + if len(queues[topic]) == 0: await channel.send( - '{} Queue "{}" is empty.'.format(caller.mention, cls) + '{} Queue "{}" is empty.'.format(caller.mention, topic) ) else: - out: str = '{} Members in "{}" queue:\n'.format(caller.mention, cls) - for user in queues[cls]: + out: str = '{} Members in "{}" queue:\n'.format(caller.mention, topic) + for user in queues[topic]: out += user.display_name + '\n' await channel.send(out) -@classes.check_admin -async def ready(mentor: Member, channel: TextChannel, cls: str) -> None: - student: Member = queues[cls].pop(0) +@topics.check_admin +async def ready(mentor: Member, channel: TextChannel, topic: str) -> None: + student: Member = queues[topic].pop(0) await channel.send( mentor.mention + " is ready for " + student.mention + "." ) @@ -76,38 +76,38 @@ async def help(channel: TextChannel) -> None: color=0xf76902 ) embedVar.add_field( - name="$joinqueue ", + name="$joinqueue ", value="Add yourself to an existing queue.", inline=False ) embedVar.add_field( - name="$showqueue ", + name="$showqueue ", value="Show the people currently in queue.", inline=False ) embedVar.add_field( - name="$showclasses", - value="Lists all classes.", + name="$showtopics", + value="Lists all topics.", inline=False ) embedVar.add_field( name="$ready (admin only)", - value="Move to the next student in the queue.", + value="Move to the next person in the queue.", inline=False ) embedVar.add_field( - name="$makeclass (admin only)", - value="Create a class.", + name="$maketopic (admin only)", + value="Create a topic.", inline=False ) embedVar.add_field( - name="$deleteclass (admin only)", - value="Deletes a class.", + name="$deletetopic (admin only)", + value="Deletes a topic.", inline=False ) embedVar.add_field( - name="$clear (admin only)", - value="Clears the queue of the specified class.", + name="$clear (admin only)", + value="Clears the queue of the specified topic.", inline=False ) await channel.send(embed=embedVar) @@ -119,10 +119,10 @@ async def on_ready() -> None: await client.change_presence(activity=discord.Game("$help")) -@classes.check_admin -async def clear(caller: Member, channel: TextChannel, cls: str) -> None: - queues[cls] = list() - await channel.send(caller + " has cleared the queue for " + cls + ".") +@topics.check_admin +async def clear(caller: Member, channel: TextChannel, topic: str) -> None: + queues[topic] = list() + await channel.send(caller + " has cleared the queue for " + topic + ".") @client.event @@ -134,18 +134,18 @@ async def on_message(message: Message) -> None: tokens: List[str] = message.content[1:].split(' ') if tokens[0] == 'joinqueue': await joinqueue(message.author, message.channel, tokens[1]) - elif tokens[0] == 'showclasses': - await showclasses(message.author, message.channel) + elif tokens[0] == 'showtopics': + await showtopics(message.author, message.channel) elif tokens[0] == 'ready': await ready(message.author, message.channel, tokens[1]) elif tokens[0] == 'showqueue': await showqueue(message.author, message.channel, tokens[1]) elif tokens[0] == 'help': await help(message.channel) - elif tokens[0] == 'makeclass': - await classes.makeclass(message.author, message.channel, tokens[1]) - elif tokens[0] == 'deleteclass': - await classes.deleteclass( + elif tokens[0] == 'maketopic': + await topics.maketopic(message.author, message.channel, tokens[1]) + elif tokens[0] == 'deletetopic': + await topics.deletetopic( message.author, message.channel, tokens[1] ) elif tokens[0] == 'clear': diff --git a/classes.py b/topics.py similarity index 73% rename from classes.py rename to topics.py index ec48d2d..cb0dee9 100644 --- a/classes.py +++ b/topics.py @@ -18,35 +18,35 @@ async def wrapper(caller: Member, channel: TextChannel, *args, **kwargs): @check_admin -async def makeclass(caller: Member, channel: TextChannel, name: str) -> None: +async def maketopic(caller: Member, channel: TextChannel, name: str) -> None: guild: Guild = caller.guild await guild.create_role( - name="Class-" + name, + name="Topic-" + name, mentionable=True, reason="Requested by " + caller.mention ) await channel.send( - caller.mention + ' Class role "{}" has been created.'.format(name) + caller.mention + ' Topic role "{}" has been created.'.format(name) ) @check_admin -async def deleteclass(caller: Member, channel: TextChannel, name: str) -> None: +async def deletetopic(caller: Member, channel: TextChannel, name: str) -> None: guild: Guild = caller.guild roles: List[Role] = guild.roles role: Role # doesn't do anything except type hints for role in roles: - if role.name == "Class-" + name: + if role.name == "Topic-" + name: await role.delete(reason="Requested by " + caller.mention) await channel.send( caller.mention + - ' Class role "{}" has been deleted.'.format(name) + ' Topic role "{}" has been deleted.'.format(name) ) return - # only runs if the class doesn't exist + # only runs if the topic doesn't exist await channel.send( - caller.mention + ' Class role "{}" does not exist.'.format(name) + caller.mention + ' Topic role "{}" does not exist.'.format(name) ) From c03f569b8606f7ad533449c45ac018c9499fc1fa Mon Sep 17 00:00:00 2001 From: Colby Gallup Date: Sat, 17 Oct 2020 12:52:13 -0400 Subject: [PATCH 2/2] Added missed spots from refactor --- lehrbot.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lehrbot.py b/lehrbot.py index 1e25c26..4683ad1 100644 --- a/lehrbot.py +++ b/lehrbot.py @@ -20,11 +20,11 @@ def get_all_topics(guild: Guild) -> List[str]: roles: List[Role] = guild.roles r: Role - return [r.name[6:] for r in roles if r.name.startswith('Class-')] + return [r.name[6:] for r in roles if r.name.startswith('Topic-')] async def showtopics(user: Member, channel: TextChannel) -> None: - out = user.mention + " List of classes:\n" + out = user.mention + " List of topics:\n" out += "\n".join(get_all_topics(channel.guild)) await channel.send(out)