pronouns: support alternative ones too

Fixes #239

Author: qexat

bot/plugins/pronouns.py

@@ -7,7 +7,6 @@
 
 from bot.config import Config
 from bot.data import command
-from bot.data import esc
 from bot.data import format_msg
 from bot.message import Message
 
@@ -27,33 +26,61 @@ class PronounData(TypedDict):
 
 
 async def _get_user_data(username: str) -> UserData | None:
-    url = f'https://api.pronouns.alejo.io/v1/users/{username}'
+    url = f"https://api.pronouns.alejo.io/v1/users/{username}"
 
     async with aiohttp.ClientSession() as session:
         async with session.get(url) as resp:
             if resp.status != 200:
                 return None
 
-            return (await resp.json())
+            return await resp.json()
 
 
 @async_lru.alru_cache(maxsize=1)
 async def pronouns() -> dict[str, PronounData]:
+    """
+    Database of all pronouns, with their various forms.
+    """
+
     url = 'https://api.pronouns.alejo.io/v1/pronouns/'
 
     async with aiohttp.ClientSession() as session:
         async with session.get(url) as resp:
-            return (await resp.json())
+            return await resp.json()
 
 
 async def _get_user_pronouns(username: str) -> tuple[str, str] | None:
+    """
+    Get the pronouns of the user given their `username`.
+
+    The returned value is a pair `(main subject/alt subject)`
+    if the user has alternative pronouns,
+    `(main subject/main object)` if they don't, and `None` if
+    their username is not known to the pronouns service.
+
+    Note: pronouns are in English, and put in lowercase.
+    """
+
     user_data = await _get_user_data(username)
 
     if user_data is None:
         return None
 
-    pronoun_data = (await pronouns())[user_data['pronoun_id']]
-    return (pronoun_data['subject'], pronoun_data['object'])
+    all_pronouns = await pronouns()
+    main_pronoun_data = all_pronouns[user_data['pronoun_id']]
+    maybe_alt_pronoun_id = user_data['alt_pronoun_id']
+
+    # first is always main subject
+    first = main_pronoun_data['subject'].casefold()
+
+    if maybe_alt_pronoun_id is not None:
+        # second is alt subject if they have alt pronouns
+        second = all_pronouns[maybe_alt_pronoun_id]['subject'].casefold()
+    else:
+        # second is main object if they don't
+        second = main_pronoun_data['object'].casefold()
+
+    return (first, second)
 
 
 @command('!pronouns')
@@ -63,7 +90,7 @@ async def cmd_pronouns(config: Config, msg: Message) -> str:
     pronouns = await _get_user_pronouns(username)
 
     if pronouns is None:
-        return format_msg(msg, f'user not found {esc(username)}')
+        return format_msg(msg, f"user not found: {username}")
 
     (subj, obj) = pronouns
-    return format_msg(msg, f'{username}\'s pronouns are: {subj}/{obj}')
+    return format_msg(msg, f"{username}'s pronouns are: {subj}/{obj}")