Replace fuzzywuzzy with rapidfuzz, readd autocomplete

Author: 7bitlyrus

modules/games.py

@@ -15,7 +15,7 @@
 from dateutil import parser
 from discord import app_commands
 from discord.ext import commands, tasks
-from fuzzywuzzy import fuzz
+import rapidfuzz
 
 import tools  # type: ignore
 
@@ -136,17 +136,14 @@ async def sync_db(self) -> Tuple[int, str]:
         return count
 
     def search(self, query: str) -> Optional[dict]:
-        match = {'deku_id': None, 'score': None, 'name': None}
+        match = {'deku_id': None, 'score': 0, 'name': None}
         for game in self.aggregatePipeline:
+            # If the game we are comparing is really short (<=3 chars), do not allow a match if our search is longer.
+            # This prevents things like 'a' being the best match for 'realMyst' and not 'realMyst: Masterpiece Edition'
+            if len(game['name']) <= 5 and len(query) > 5:
+                continue
 
-            methods = [fuzz.ratio, fuzz.partial_ratio, fuzz.token_sort_ratio, fuzz.token_set_ratio]
-            rem_punc = re.compile('[^0-9a-zA-Z ]+')
-
-            # Remove punctuation and casing for name and query
-            scores = [
-                method(rem_punc.sub('', game['name'].lower()), rem_punc.sub('', query.lower())) for method in methods
-            ]
-            score = sum(scores) / len(methods)
+            score = rapidfuzz.fuzz.WRatio(query.lower(), game['name'], processor=rapidfuzz.utils.default_process)
 
             if not match['score'] or (score > match['score']):
                 match = {'deku_id': game['deku_id'], 'score': score, 'name': game['name']}
@@ -177,6 +174,19 @@ def get_name(self, deku_id: str):
         document = self.db.find_one({'deku_id': deku_id}, projection={'name': 1})
         return document['name'] if document else None
 
+    async def _games_search_autocomplete(self, interaction: discord.Interaction, current: str):
+        if current:
+            game = self.search(current)
+
+        else:
+            # Current textbox is empty
+            return []
+
+        if game:
+            return [app_commands.Choice(name=game['name'], value=game['deku_id'])]
+        else:
+            return []
+        
     @app_commands.guilds(discord.Object(id=config.nintendoswitch))
     class GamesCommand(app_commands.Group):
         pass
@@ -186,13 +196,23 @@ class GamesCommand(app_commands.Group):
     @games_group.command(name='search')
     @app_commands.describe(query='The term you want to search for a game')
     @app_commands.checks.cooldown(2, 60, key=lambda i: (i.guild_id, i.user.id))
+    @app_commands.autocomplete(query=_games_search_autocomplete)
     async def _games_search(self, interaction: discord.Interaction, query: str):
         '''Search for Nintendo Switch games'''
         await interaction.response.defer()
-        result = self.search(query)
 
-        if result and result['deku_id']:
-            game = self.db.find_one({'deku_id': result['deku_id']})
+        user_deku_id = self.db.find_one({'deku_id': query.strip()})
+        game = None
+
+        if user_deku_id:
+            game = user_deku_id  # User clicked an autocomplete, giving us the exact deku_id
+            result = {'deku_id': user_deku_id['deku_id'], 'score': 100.0, 'name': user_deku_id['name']}
+
+        else:
+            result = self.search(query)
+
+            if result and result['deku_id']:
+                game = self.db.find_one({'deku_id': result['deku_id']})
 
         if game:
             embed = discord.Embed(

modules/social.py

@@ -22,7 +22,7 @@
 import yaml
 from discord import app_commands
 from discord.ext import commands
-from fuzzywuzzy import process
+from rapidfuzz import process
 from PIL import Image, ImageDraw, ImageFont
 
 import tools  # type: ignore
@@ -963,6 +963,9 @@ async def _profile_timezone(self, interaction: discord.Interaction, timezone: st
             f'{config.redTick} The timezone you provided is invalid. It should be in the format similar to `America/New_York`. If you aren\'t sure how to find it or what yours is, you can visit [this helpful website](https://www.timezoneconverter.com/cgi-bin/findzone.tzc)'
         )
 
+    async def _profile_games_autocomplete(self, interaction: discord.Interaction, current: str):
+        return await self.Games._games_search_autocomplete(interaction, current)
+
     @social_group.command(name='games', description='Pick up-to 5 of your fav Nintendo Switch games to show them off')
     @app_commands.describe(
         game1='You need to pick at least one game. Search by name',
@@ -971,6 +974,13 @@ async def _profile_timezone(self, interaction: discord.Interaction, timezone: st
         game4='Optionally pick a 4th game to show on your profile as well. Search by name',
         game5='Optionally pick a 5th game to show on your profile as well. Search by name',
     )
+    @app_commands.autocomplete(
+       game1=_profile_games_autocomplete,
+       game2=_profile_games_autocomplete,
+       game3=_profile_games_autocomplete,
+       game4=_profile_games_autocomplete,
+       game5=_profile_games_autocomplete,
+    )
     async def _profile_games(
         self,
         interaction: discord.Interaction,
@@ -1584,7 +1594,7 @@ async def _migratefavgames(self, ctx):
                 for name in names:
                     search = self.Games.search(name)
 
-                    if search['score'] > score:
+                    if search and (search['score'] > score):
                         score = search['score']
                         deku_id = search['deku_id']
                         new_name = search['name']
@@ -1604,7 +1614,7 @@ async def _migratefavgames(self, ctx):
             # update the progress message
             interval = (count // 100) + 1
             if ((j + 1) % interval) == 0:
-                percent_complete = (j + 1) / count
+                percent_complete = ((j + 1) / count) * 100
                 await message.edit(content=f'Migrating... {j+1}/{count} ({percent_complete:.0f}%)')
 
         await message.edit(content=f'Migrating... {count}/{count} (100%)')

modules/utility.py

@@ -14,7 +14,7 @@
 import pymongo
 from discord import Webhook, WebhookType, app_commands
 from discord.ext import commands, tasks
-from fuzzywuzzy import process
+from rapidfuzz import process
 
 import tools
 

private

@@ -3,7 +3,7 @@ discord.py==2.4.0
 pymongo[srv]<=3.12.3
 jishaku
 pylint
-fuzzywuzzy[speedup]
+rapidfuzz
 pillow<=9.5.0
 pytz
 codepoints