Added a Tag Feature to Group Queries by Related Topics (#18)

* Adding tags to various queries

* Implemented a simple study guide generator

* Documented my code slightly

* Reformatted the utils file slightly

* Cleaned up code

* Added tags to every query

Author: jrg94

pymon.py

@@ -4,7 +4,7 @@
 from discord import Message
 from discord.ext import commands
 from discord_slash import SlashCommand
-from discord_slash.utils.manage_commands import create_option
+from discord_slash.utils.manage_commands import create_choice, create_option
 
 import pymon_utils as utils
 
@@ -27,7 +27,8 @@
 # Discord bot code
 async def _react_on_mention(message: Message):
     if client.user.mentioned_in(message) and not message.mention_everyone:
-        indices = utils.search(keyword_mapping, utils.generate_keywords(message.content))
+        indices = utils.search(
+            keyword_mapping, utils.generate_keywords(message.content))
         if indices:
             reply = list()
             reply.extend([
@@ -110,6 +111,45 @@ async def _get(ctx, index: int):
     await ctx.send(embed=embed)
 
 
+@slash.slash(
+    name="study",
+    description="Provides a study guide from a set of predetermined tags.",
+    options=[
+        create_option(
+            name="tag",
+            description="Select a topic for your study guide.",
+            required=True,
+            option_type=3,
+            choices=[
+                create_choice(
+                    value=tag,
+                    name=f"{tag} ({len(utils.get_queries_from_tag(queries, tag))})",
+                )
+                for tag in sorted(utils.generate_tags_set(queries))
+            ]
+        )
+    ]
+)
+async def _study(ctx, tag: str):
+    """
+    Prints out a list of questions relevant to the tag.
+
+    :param ctx: the context to send messages to
+    :return: None
+    """
+    matches = utils.get_queries_from_tag(queries, tag)
+    embed = discord.Embed(
+        title=f"Pymon v{__version__}: Study Guide for {tag}",
+        color=discord.Color.red(),
+        description="\n".join(
+            f"• ID-{match[0]}: {utils.create_md_link(match[1].get('resource'), match[1].get('query'))}"
+            for match in matches
+        )
+    )
+
+    await ctx.send(embed=embed)
+
+
 @slash.slash(
     name="refresh",
     description="Refreshes the bot's knowledge base.",

pymon_utils.py

@@ -128,3 +128,34 @@ def refresh_knowledge() -> tuple[list, dict]:
     keyword_mapping = generate_keyword_mapping(queries)
     generate_similar_queries(queries, keyword_mapping)
     return queries, keyword_mapping
+
+
+def generate_tags_set(queries: list) -> set:
+    """
+    A handy method for processing the set of tags contained in Pymon's
+    brain. 
+
+    :param queries: the list of queries from Pymon's brain
+    :return: a set of tags represented in Pymon's brain
+    """
+    tags = set()
+    for query in queries:
+        query_tags = query.get("tags", [])
+        tags |= set(query_tags)
+    return tags
+
+
+def get_queries_from_tag(queries: list, tag: str) -> list[tuple[int, dict]]:
+    """
+    Given a tag, this function searches Pymon's brain for all the
+    matching queries.
+
+    :param queries: Pymon's brain as a list of queries
+    :param tag: a tag to lookup
+    :return: a list of tuples in the form (query ID, query)
+    """
+    matches = list()
+    for i, query in enumerate(queries):
+        if tag in query.get("tags", []):
+            matches.append((i, query))
+    return matches