implement pronouns command

Author: qexat

bot/plugins/pronouns.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+import json
+from typing import cast
+from typing import TypedDict
+
+import urllib.request
+
+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
+
+PRONOUNS_ENDPOINT = "https://api.pronouns.alejo.io/v1/pronouns/"
+USER_ENDPOINT = "https://api.pronouns.alejo.io/v1/users/"
+
+
+class UserData(TypedDict):
+    channel_id: str
+    channel_login: str
+    pronoun_id: str
+    alt_pronoun_id: str | None
+
+
+class PronounData(TypedDict):
+    name: str
+    subject: str
+    object: str
+    singular: bool
+
+
+def _get_user_data(username: str) -> UserData | None:
+    try:
+        resp = urllib.request.urlopen(USER_ENDPOINT + username)
+    except urllib.error.HTTPError:
+        return None
+    else:
+        return cast("UserData", json.load(resp))
+
+
+def _get_pronouns() -> dict[str, PronounData]:
+    resp = urllib.request.urlopen(PRONOUNS_ENDPOINT)
+    return cast("dict[str, PronounData]", json.load(resp))
+
+
+# TODO: add this to bot's setup instead
+PRONOUNS = _get_pronouns()
+
+
+def _get_user_pronouns(username: str) -> tuple[str, str] | None:
+    user_data = _get_user_data(username)
+
+    if user_data is None:
+        return None
+
+    pronoun_data = PRONOUNS[user_data["pronoun_id"]]
+    return (pronoun_data["subject"], pronoun_data["object"])
+
+
+@command('!pronouns')
+async def cmd_pronouns(config: Config, msg: Message) -> str:
+    # TODO: handle display name
+    username = msg.optional_user_arg.lower()
+    pronouns = _get_user_pronouns(username)
+
+    if pronouns is None:
+        return format_msg(msg, f'user not found {esc(username)}')
+
+    (subject, object_) = pronouns
+
+    return format_msg(msg, f'{username}\'s pronouns are: {subject}/{object_}')