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

Author: kaustubh-nair

zulipterminal/helper.py

@@ -13,13 +13,20 @@
 )
 
 import lxml.html
-from typing_extensions import TypedDict
+from typing_extensions import Literal, TypedDict
 
 
 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

@@ -4,7 +4,7 @@
 from concurrent.futures import Future, ThreadPoolExecutor, wait
 from typing import (
     Any, Callable, DefaultDict, Dict, FrozenSet, Iterable, List, Optional, Set,
-    Tuple, Union,
+    Tuple, Union, cast,
 )
 from urllib.parse import urlparse
 
@@ -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
 
@@ -139,9 +140,10 @@ def __init__(self, controller: Any) -> None:
         unicode_emoji_data = unicode_emojis.EMOJI_DATA
         for name, data in unicode_emoji_data.items():
             data['type'] = 'unicode_emoji'
+        typed_unicode_emoji_data = cast(NamedEmojiData, unicode_emoji_data)
 
         custom_emojis = self.fetch_custom_emojis()
-        all_emojis = (list(unicode_emoji_data.items())
+        all_emojis = (list(typed_unicode_emoji_data.items())
                       + list(custom_emojis.items()))
         self.active_emoji_data = OrderedDict(sorted(all_emojis,
                                                     key=lambda e: e[0]))
@@ -364,12 +366,12 @@ def update_stream_message(self, topic: str, message_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, *,