feat(mouthing): respond with ipa and swu

Author: AmitMY

README.md

@@ -94,7 +94,7 @@ signwriting_to_image(fsw)
 ![AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S20544510x500S10019476x475](signwriting/visualizer/test_assets/AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S20544510x500S10019476x475.png)
 
 To use the visualizer with the server, you can hit:
-https://signwriting-sxie2r74ua-uc.a.run.app//visualizer?fsw=M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475
+https://signwriting-sxie2r74ua-uc.a.run.app/visualizer?fsw=M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475
 
 ### `signwriting.utils`
 
@@ -127,7 +127,7 @@ spell(word, language)
 ```
 
 To use the fingerspelling with the server, you can hit:
-https://signwriting-sxie2r74ua-uc.a.run.app//fingerspelling?text=hello&signed_language=ase
+https://signwriting-sxie2r74ua-uc.a.run.app/fingerspelling?text=hello&signed_language=ase
 
 ### `signwriting.mouthing`
 
@@ -146,7 +146,7 @@ Note: Installing English support for `epitran` requires extra steps,
 see "Install flite" at [mouthing/README.md](signwriting/mouthing/README.md).
 
 To use the mouthing with the server, you can hit:
-https://signwriting-sxie2r74ua-uc.a.run.app//mouthing?text=hello&spoken_language=eng-Latn
+https://signwriting-sxie2r74ua-uc.a.run.app/mouthing?text=hello&spoken_language=eng-Latn
 
 
 ## Cite

signwriting/mouthing/mouthing.py

@@ -2,18 +2,27 @@
 import functools
 import json
 import re
+from dataclasses import dataclass
 from pathlib import Path
-from typing import Union
+from typing import Union, Optional
 
 from epitran import Epitran
 
 from signwriting.formats.fsw_to_sign import fsw_to_sign
 from signwriting.formats.sign_to_fsw import sign_to_fsw
+from signwriting.formats.fsw_to_swu import fsw2swu
 from signwriting.utils.join_signs import join_signs_horizontal, sign_from_symbols
 
 MOUTHING_INDEX = Path(__file__).parent / "mouthing.json"
 
 
+@dataclass
+class MouthingResult:
+    ipa: str
+    fsw: Optional[str]
+    swu: Optional[str]
+
+
 @functools.lru_cache()
 def get_mouthings():
     with open(MOUTHING_INDEX, "r", encoding="utf-8") as f:
@@ -74,14 +83,17 @@ def mouth_ipa(characters: str, aspiration=False) -> Union[str, None]:
     return join_signs_horizontal(*words, spacing=10)
 
 
-def mouth(word: str, language: str, aspiration=False):
+def mouth(word: str, language: str, aspiration=False) -> MouthingResult:
     epi = Epitran(language, ligatures=True)
     ipa = epi.transliterate(word)
 
     mouthing_fsw = mouth_ipa(ipa, aspiration=aspiration)
     if mouthing_fsw is None:
         print(f"Failed to mouth {word}, IPA: {ipa}")
-    return mouthing_fsw
+
+    mouthing_swu = fsw2swu(mouthing_fsw) if mouthing_fsw else None
+
+    return MouthingResult(ipa=ipa, fsw=mouthing_fsw, swu=mouthing_swu)
 
 
 if __name__ == "__main__":

signwriting/mouthing/server.py

@@ -4,14 +4,19 @@
 from signwriting.mouthing.mouthing import mouth
 
 parser = reqparse.RequestParser()
-parser.add_argument('text', type=str, required=True, help='Text to mouth')
-parser.add_argument('spoken_language', type=str, required=True,
+parser.add_argument('text', type=str, required=True, location='args', help='Text to mouth')
+parser.add_argument('spoken_language', type=str, required=True, location='args',
                     help='Spoken Language code. See "Language Support" at https://pypi.org/project/epitran/')
 
 
 class Mouthing(Resource):
     def get(self):
         args = parser.parse_args()
 
-        fsw = mouth(args["text"], language=args["spoken_language"])
-        return make_response(jsonify({"fsw": fsw}), 200)
+        result = mouth(args["text"], language=args["spoken_language"])
+
+        return make_response(jsonify({
+            "ipa": result.ipa,
+            "fsw": result.fsw,
+            "swu": result.swu
+        }), 200)

signwriting/visualizer/visualize.py

@@ -87,14 +87,14 @@ def layout_signwriting(images: List[Image.Image], direction: str) -> Image.Image
         max_height = max(img.height for img in images)
         total_width = sum(img.width for img in images) + GAP * (len(images) - 1)
         size = (total_width, max_height)
-        paste_position = lambda offset, img: (offset, (max_height - img.height) // 2)
-        offset_increment = lambda img: img.width + GAP
+        paste_position = lambda offset, img: (offset, (max_height - img.height) // 2) # noqa: E731
+        offset_increment = lambda img: img.width + GAP # noqa: E731
     else:
         max_width = max(img.width for img in images)
         total_height = sum(img.height for img in images) + GAP * (len(images) - 1)
         size = (max_width, total_height)
-        paste_position = lambda offset, img: ((max_width - img.width) // 2, offset)
-        offset_increment = lambda img: img.height + GAP
+        paste_position = lambda offset, img: ((max_width - img.width) // 2, offset) # noqa: E731
+        offset_increment = lambda img: img.height + GAP # noqa: E731
 
     layout_image = Image.new("RGBA", size, (255, 255, 255, 0))
     offset = 0