refactor: helper/model/emojis: Use TypedDict for emoji data.

Author: kaustubh-nair

tools/convert-unicode-emoji-data

@@ -23,7 +23,8 @@ for emoji_code, emoji_names in emoji_dict.items():
 ordered_emojis = OrderedDict(sorted(emoji_map.items()))
 
 with open(OUTPUT_FILE, "w") as f:
-    f.write('from collections import OrderedDict\n\n\n')
+    f.write('from collections import OrderedDict\n\n')
+    f.write('from helper import NamedEmojiData\n\n\n')
     f.write('# Generated automatically by '
             'tools/convert-unicode-emoji-data\n')
     f.write('# Do not modify.\n\n')
@@ -32,7 +33,7 @@ with open(OUTPUT_FILE, "w") as f:
         # {'smile': {'code': '263a', 'type': 'unicode_emoji'}}
         f.write("    ('%s', {'code': '%s',\n"
                 "     'type': '%s'}),\n" % (emoji_code, emoji_name, 'unicode_emoji'))
-    f.write('])\n')
+    f.write('])  # type: NamedEmojiData\n')
 
 print("Emoji list saved in {}".format(OUTPUT_FILE))
 if os.path.exists(INPUT_FILE):

zulipterminal/helper.py

@@ -14,12 +14,20 @@
 
 import lxml.html
 from mypy_extensions import TypedDict
+from typing_extensions import Literal
 
 
 MACOS = platform.system() == "Darwin"
 LINUX = platform.system() == "Linux"
 WSL = 'microsoft' in platform.release().lower()
 
+EmojiData = TypedDict('EmojiData', {
+    'code': str,
+    'type': Literal['realm_emoji', 'unicode_emoji'],
+})
+
+NamedEmojiData = Dict[str, EmojiData]
+
 Message = TypedDict('Message', {
     'id': int,
     'sender_id': int,

zulipterminal/model.py

@@ -14,8 +14,9 @@
 from zulipterminal import unicode_emojis
 from zulipterminal.config.keys import keys_for_command
 from zulipterminal.helper import (
-    Message, asynch, canonicalize_color, classify_unread_counts,
-    display_error_if_present, index_messages, initial_index, notify, set_count,
+    Message, NamedEmojiData, asynch, canonicalize_color,
+    classify_unread_counts, display_error_if_present, index_messages,
+    initial_index, notify, set_count,
 )
 from zulipterminal.ui_tools.utils import create_msg_box_list
 
@@ -127,8 +128,8 @@ def __init__(self, controller: Any) -> None:
         self.unread_counts = classify_unread_counts(self)
 
         custom_emojis = self.fetch_custom_emojis()
-        all_emojis = (list(unicode_emojis.EMOJI_DATA.items())
-                      + list(custom_emojis.items()))
+        all_emojis = list(unicode_emojis.EMOJI_DATA.items()
+                          + list(custom_emojis.items()))
         self.active_emoji_data = OrderedDict(sorted(all_emojis,
                                                     key=lambda e: e[0]))
 
@@ -348,12 +349,12 @@ def update_stream_message(self, topic: str, msg_id: int,
         display_error_if_present(response, self.controller)
         return response['result'] == 'success'
 
-    def fetch_custom_emojis(self) -> Dict[str, Dict[str, str]]:
+    def fetch_custom_emojis(self) -> NamedEmojiData:
         response = self.client.get_realm_emoji()
         custom_emojis = {emoji['name']: {'code': emoji_code,
                                          'type': 'realm_emoji'}
                          for emoji_code, emoji in response['emoji'].items()
-                         if not emoji['deactivated']}
+                         if not emoji['deactivated']}  # type: NamedEmojiData
         return custom_emojis
 
     def get_messages(self, *,

zulipterminal/unicode_emojis.py

@@ -1,5 +1,7 @@
 from collections import OrderedDict
 
+from helper import NamedEmojiData
+
 
 # Generated automatically by tools/convert-unicode-emoji-data
 # Do not modify.
@@ -3111,4 +3113,4 @@
      'type': 'unicode_emoji'}),
     ('zzz', {'code': '1f4a4',
      'type': 'unicode_emoji'}),
-])
+])  # type: NamedEmojiData