Vote improvements (#45)

* Updated the vote command to use the emoji module instead of regex

* Updated changelog

* Modified vote command so it reacts with emojis in the order they appeared

Author: Ersatz77

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+- Improved emoji parsing logic for the `vote` command
+
 ## [0.14.0] - 2021-08-25
 
 ### Changed

commanderbot_ext/ext/vote/vote_cog.py

@@ -1,52 +1,48 @@
 import re
 from typing import Iterable, cast
 
+import emoji
 from discord import Message
 from discord.ext.commands import Bot, Cog, Context, command
 
 DEFAULT_VOTE_EMOJIS = ("👍", "👎")
-
-EMOJIS_PATTERN = re.compile(
-    "["
-    "\U0001F1E0-\U0001F1FF"
-    "\U0001F300-\U0001F5FF"
-    "\U0001F600-\U0001F64F"
-    "\U0001F680-\U0001F6FF"
-    "\U0001F700-\U0001F77F"
-    "\U0001F780-\U0001F7FF"
-    "\U0001F800-\U0001F8FF"
-    "\U0001F900-\U0001F9FF"
-    "\U0001FA00-\U0001FA6F"
-    "\U0001FA70-\U0001FAFF"
-    "\U00002702-\U000027B0"
-    "\U000024C2-\U0001F251"
-    "\U0000200d"
-    "]+|"
-    r"\<\:\w+\:\d+\>"
-    "",
-    flags=re.UNICODE,
-)
+CUSTOM_EMOJI_PATTERN = re.compile(r"\<\:\w+\:\d+\>")
 
 
 class VoteCog(Cog, name="commanderbot_ext.ext.vote"):
     def __init__(self, bot: Bot):
         self.bot: Bot = bot
 
     @staticmethod
-    def get_vote_emojis(message: Message) -> Iterable[str]:
-        # If the message has content, look for emojis within it.
-        if message.clean_content:
-            # If any emojis were found, use them instead of the defaults.
-            if found_emojis := EMOJIS_PATTERN.findall(str(message.clean_content)):
-                return found_emojis
-        # If nothing else was returned, use the default vote emojis.
-        return DEFAULT_VOTE_EMOJIS
+    def get_emojis(message: Message) -> Iterable[str]:
+        # Get message content and cast it to a string
+        message_content: str = str(message.clean_content)
+
+        # Find unicode and custom emojis in the message
+        found_emojis: list[dict] = emoji.emoji_lis(message_content)
+        for custom_emoji in CUSTOM_EMOJI_PATTERN.finditer(message_content):
+            found_emojis.append(
+                {"location": custom_emoji.start(), "emoji": custom_emoji.group()}
+            )
+        
+        # Return early with the default emojis if no emojis were found
+        if not found_emojis:
+            return DEFAULT_VOTE_EMOJIS
+
+        # Create a list of unique emojis that are sorted in the order they appeared
+        emojis: list[str] = []
+        for e in sorted(found_emojis, key=lambda i: i["location"]):
+            emoji_char: str = str(e["emoji"])
+            if emoji_char not in emojis:
+                emojis.append(emoji_char)
+
+        return emojis
 
     @command(name="vote")
     async def cmd_vote(self, ctx: Context):
         # Determine which emoji reactions to seed the message with, silently ignoring
         # errors raised by any individual emoji.
-        for emoji in self.get_vote_emojis(cast(Message, ctx.message)):
+        for emoji in self.get_emojis(cast(Message, ctx.message)):
             try:
                 await ctx.message.add_reaction(emoji)
             except:

poetry.lock

@@ -19,6 +19,7 @@ lectern = ">=0.14.0"
 beet = ">=0.32.1"
 aiohttp = "^3.7.4"
 PyYAML = "^5.4.1"
+emoji = "^1.4.2"
 
 [tool.poetry.dev-dependencies]
 black = "^21.5b0"