refactor: rename howsign package to handshapes; remove the URL formatting functions (#4)

Author: sloria

bot.py

@@ -1,24 +1,25 @@
 import asyncio
+import base64
 import datetime as dt
-import logging
 import difflib
+import logging
 import random
-from contextlib import suppress
 import re
 import uuid
-import base64
+from contextlib import suppress
 from typing import Optional
+from urllib.parse import quote_plus
 
 import aiohttp
 import discord
+import gspread
 from discord.ext import commands
 from discord.ext.commands import Context
 from environs import Env
 from google.auth.crypt._python_rsa import RSASigner
 from google.oauth2.service_account import Credentials
-import gspread
 
-import howsign
+import handshapes
 import cuteid
 import catchphrase
 
@@ -137,13 +138,14 @@ def howsign_impl(word: str):
         else f"sending links for: '{word}'"
     )
     logger.info(log)
+    quoted_word = quote_plus(word)
     return {
         "content": template.format(
             word_uppercased=word.upper(),
-            lifeprint=howsign.get_lifeprint_url(word),
-            signingsavvy=howsign.get_signingsavvy_url(word),
-            spread_the_sign=howsign.get_spread_the_sign_url(word),
-            youglish=howsign.get_youglish_url(word),
+            lifeprint=f"https://www.google.com/search?&q=site%3Alifeprint.com+{quoted_word}",
+            signingsavvy=f"https://www.signingsavvy.com/search/{quoted_word}",
+            spread_the_sign=f"https://www.spreadthesign.com/en.us/search/?q={quoted_word}",
+            youglish=f"https://youglish.com/pronounce/{quoted_word}/signlanguage/asl",
         )
     }
 
@@ -157,7 +159,9 @@ async def howsign_command(ctx: Context, *, word: str):
 async def howsign_error(ctx, error):
     if isinstance(error, commands.errors.MissingRequiredArgument):
         logger.info(f"missing argument to '{ctx.invoked_with}'")
-        await ctx.send(f"Enter a word or phrase after `{COMMAND_PREFIX}howsign`")
+        await ctx.send(
+            f"Enter a word or phrase after `{COMMAND_PREFIX}{ctx.invoked_with}`"
+        )
     else:
         logger.error(
             f"unexpected error when handling '{ctx.invoked_with}'", exc_info=error
@@ -182,14 +186,14 @@ async def howsign_error(ctx, error):
 def handshape_impl(name: str):
     logger.info(f"handshape: '{name}'")
     if name == "random":
-        name = random.choice(tuple(howsign.HANDSHAPES.keys()))
+        name = random.choice(tuple(handshapes.HANDSHAPES.keys()))
         logger.info(f"chose '{name}'")
 
     try:
-        handshape = howsign.get_handshape(name)
-    except howsign.HandshapeNotFoundError:
+        handshape = handshapes.get_handshape(name)
+    except handshapes.HandshapeNotFoundError:
         logger.info(f"handshape '{name}' not found")
-        suggestion = did_you_mean(name, tuple(howsign.HANDSHAPES.keys()))
+        suggestion = did_you_mean(name, tuple(handshapes.HANDSHAPES.keys()))
         if suggestion:
             return {
                 "content": f'"{name}" not found. Did you mean "{suggestion}"? Enter `{COMMAND_PREFIX}handshapes` to see a list of handshapes.'
@@ -230,7 +234,8 @@ async def handshape_command(ctx, name="random"):
 def handshapes_impl():
     return {
         "content": HANDSHAPES_TEMPLATE.format(
-            handshapes=", ".join(howsign.HANDSHAPES.keys()), COMMAND_PREFIX=COMMAND_PREFIX
+            handshapes=", ".join(handshapes.HANDSHAPES.keys()),
+            COMMAND_PREFIX=COMMAND_PREFIX,
         )
     }
 

lib/handshapes/__init__.py

@@ -0,0 +1,76 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+from .case_insensitive_dict import CaseInsensitiveDict
+
+ASSETS_PATH = Path(__file__).parent / "assets"
+HANDSHAPES = CaseInsensitiveDict(
+    {
+        "1": ASSETS_PATH / "1.png",
+        "3": ASSETS_PATH / "3.png",
+        "Bent3": ASSETS_PATH / "Bent3.png",
+        "4": ASSETS_PATH / "4.png",
+        "5": ASSETS_PATH / "5.png",
+        "Claw5": ASSETS_PATH / "Claw5.png",
+        "6": ASSETS_PATH / "6.png",
+        "7": ASSETS_PATH / "7.png",
+        "8": ASSETS_PATH / "8.png",
+        "Open8": ASSETS_PATH / "Open8.png",
+        "9": ASSETS_PATH / "9.png",
+        "Flat9": ASSETS_PATH / "Flat9.png",
+        "A": ASSETS_PATH / "A.png",
+        "OpenA": ASSETS_PATH / "OpenA.png",
+        "B": ASSETS_PATH / "B.png",
+        "BentB": ASSETS_PATH / "BentB.png",
+        "FlatB": ASSETS_PATH / "FlatB.png",
+        "OpenB": ASSETS_PATH / "OpenB.png",
+        "C": ASSETS_PATH / "C.png",
+        "FlatC": ASSETS_PATH / "FlatC.png",
+        "SmallC": ASSETS_PATH / "SmallC.png",
+        "D": ASSETS_PATH / "D.png",
+        "E": ASSETS_PATH / "E.png",
+        "G": ASSETS_PATH / "G.png",
+        "H": ASSETS_PATH / "H.png",
+        "I": ASSETS_PATH / "I.png",
+        "K": ASSETS_PATH / "K.png",
+        "L": ASSETS_PATH / "L.png",
+        "M": ASSETS_PATH / "M.png",
+        "OpenM": ASSETS_PATH / "OpenM.png",
+        "N": ASSETS_PATH / "N.png",
+        "OpenN": ASSETS_PATH / "OpenN.png",
+        "O": ASSETS_PATH / "O.png",
+        "FlatO": ASSETS_PATH / "FlatO.png",
+        "SmallO": ASSETS_PATH / "SmallO.png",
+        "R": ASSETS_PATH / "R.png",
+        "S": ASSETS_PATH / "S.png",
+        "T": ASSETS_PATH / "T.png",
+        "V": ASSETS_PATH / "V.png",
+        "BentV": ASSETS_PATH / "BentV.png",
+        "X": ASSETS_PATH / "X.png",
+        "OpenX": ASSETS_PATH / "OpenX.png",
+        "Y": ASSETS_PATH / "Y.png",
+        "ILY": ASSETS_PATH / "ILY.png",
+        "Corna": ASSETS_PATH / "Corna.png",
+    }
+)
+
+
+@dataclass
+class Handshape:
+    name: str
+    path: Path
+
+
+class HandshapeNotFoundError(KeyError):
+    pass
+
+
+def get_handshape(name):
+    try:
+        cased_name = HANDSHAPES._store[name.lower()][0]
+        path = HANDSHAPES[name]
+    except KeyError as error:
+        raise HandshapeNotFoundError(
+            f"Could not find handshape with name '{name}'"
+        ) from error
+    return Handshape(name=cased_name, path=path)

lib/howsign/handshapes/1.png renamed to lib/handshapes/assets/1.png

@@ -20,7 +20,7 @@ def read(fname):
     packages=find_packages("lib"),
     package_dir={"": "lib"},
     package_data={
-        "howsign": ["handshapes/*.png"],
+        "handshapes": ["assets/*.png"],
         "catchphrase": ["*.yaml"],
         "cuteid": ["*.json"],
     },