mypy: Unify type of size parameter to keypress/mouse_event calls.

NOTE: View keypress uses a non-standard type here that needs to be
resolved.

Author: neiljp

zulipterminal/ui.py

@@ -145,6 +145,7 @@ def show_right_panel(self, *, visible: bool) -> None:
         if visible:
             self.body.focus_position = 2
 
+    # FIXME: The type of size should be urwid_Size; this needs checking
     def keypress(self, size: Tuple[int, int], key: str) -> str:
         self.model.new_user_input = True
         if self.controller.editor_mode:

zulipterminal/ui_tools/boxes.py

@@ -15,6 +15,7 @@
 from zulipterminal.helper import (
     Message, match_groups, match_stream, match_user,
 )
+from zulipterminal.urwid_types import urwid_Size
 
 
 class WriteBox(urwid.Pile):
@@ -128,7 +129,7 @@ def autocomplete_streams(self, text: str, state: int) -> Optional[str]:
         except IndexError:
             return None
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('SEND_MESSAGE', key):
             if self.msg_edit_id:
                 if not self.to_write_box:
@@ -645,7 +646,7 @@ def selectable(self) -> bool:
         # is designed to take focus.
         return True
 
-    def mouse_event(self, size: Tuple[int, int], event: Any, button: Any,
+    def mouse_event(self, size: urwid_Size, event: Any, button: Any,
                     col: int, row: int, focus: int) -> Union[bool, Any]:
         if event == 'mouse press':
             if button == 1:
@@ -665,7 +666,7 @@ def mouse_event(self, size: Tuple[int, int], event: Any, button: Any,
 
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('ENTER', key):
             if self.message['type'] == 'private':
                 self.model.controller.view.write_box.private_box_view(
@@ -789,7 +790,7 @@ def main_view(self) -> Any:
             blcorner=u'─', rline=u'', bline=u'─', brcorner=u'─')
         return [self.search_bar, self.recipient_bar]
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('GO_BACK', key):
             self.text_box.set_edit_text("")
             self.controller.editor_mode = False
@@ -820,7 +821,7 @@ def __init__(self, panel_view: Any, search_command: str,
         urwid.connect_signal(self, 'change', update_function)
         super().__init__(edit_text=self.search_text)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('ENTER', key):
             self.panel_view.view.controller.editor_mode = False
             self.panel_view.set_focus("body")

zulipterminal/ui_tools/buttons.py

@@ -3,6 +3,7 @@
 import urwid
 
 from zulipterminal.config.keys import is_command_key, keys_for_command
+from zulipterminal.urwid_types import urwid_Size
 
 
 class MenuButton(urwid.Button):
@@ -77,7 +78,7 @@ def activate(self, key: Any) -> None:
         self.controller.view.body.focus_col = 1
         self.show_function(self)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('ENTER', key):
             self.activate(key)
         return super().keypress(size, key)
@@ -168,7 +169,7 @@ def mark_unmuted(self) -> None:
             # All messages in this stream are read.
             self.update_count(0)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('TOGGLE_TOPIC', key):
             topic_view = self.view.left_panel.topics_view(self)
             self.view.left_panel.is_in_topic_view = True

zulipterminal/ui_tools/views.py

@@ -15,6 +15,7 @@
     UnreadPMButton, UserButton,
 )
 from zulipterminal.ui_tools.utils import create_msg_box_list
+from zulipterminal.urwid_types import urwid_Size
 
 
 class ModListWalker(urwid.SimpleFocusListWalker):
@@ -130,7 +131,7 @@ def load_new_messages(self, anchor: int) -> None:
         self.model.controller.update_screen()
         self.new_loading = False
 
-    def mouse_event(self, size: Any, event: str, button: int, col: int,
+    def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                     row: int, focus: Any) -> Any:
         if event == 'mouse press':
             if button == 4:
@@ -141,7 +142,7 @@ def mouse_event(self, size: Any, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('NEXT_MESSAGE', key) and not self.new_loading:
             try:
                 position = self.log.next_position(self.focus_position)
@@ -278,7 +279,7 @@ def update_streams(self, search_box: Any, new_text: str) -> None:
             self.log.extend(streams_display)
             self.view.controller.update_screen()
 
-    def mouse_event(self, size: Any, event: str, button: int, col: int,
+    def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                     row: int, focus: Any) -> Any:
         if event == 'mouse press':
             if button == 4:
@@ -289,7 +290,7 @@ def mouse_event(self, size: Any, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('SEARCH_STREAMS', key):
             self.set_focus('header')
             return key
@@ -365,7 +366,7 @@ def update_topics_list(self, stream_id: int, topic_name: str,
         if sender_id == self.view.model.user_id:
             self.list_box.set_focus(0)
 
-    def mouse_event(self, size: Any, event: str, button: int, col: int,
+    def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                     row: int, focus: Any) -> Any:
         if event == 'mouse press':
             if button == 4:
@@ -376,7 +377,7 @@ def mouse_event(self, size: Any, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('TOGGLE_TOPIC', key):
             # Exit topic view
             self.view.left_panel.contents[1] = (
@@ -404,7 +405,7 @@ def __init__(self, users_btn_list: List[Any]) -> None:
         self.log = urwid.SimpleFocusListWalker(users_btn_list)
         super().__init__(self.log)
 
-    def mouse_event(self, size: Any, event: str, button: int, col: int,
+    def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                     row: int, focus: Any) -> Any:
         if event == 'mouse press':
             if button == 4:
@@ -460,7 +461,7 @@ def get_next_unread_pm(self) -> Optional[int]:
             return pm
         return None
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('GO_BACK', key):
             self.header.keypress(size, 'esc')
             self.footer.keypress(size, 'esc')
@@ -610,7 +611,7 @@ def users_view(self, users: Any=None) -> Any:
             self.view.user_w = user_w
         return user_w
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('SEARCH_PEOPLE', key):
             self.allow_update_user_list = False
             self.set_focus('header')
@@ -734,7 +735,7 @@ def topics_view(self, stream_button: Any) -> Any:
             )
         return w
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if (is_command_key('SEARCH_STREAMS', key) or
                 is_command_key('SEARCH_TOPICS', key)):
             self.focus_position = 1
@@ -786,7 +787,7 @@ def __init__(self, controller: Any) -> None:
 
         super().__init__(self.log)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('GO_BACK', key) or is_command_key('HELP', key):
             self.controller.exit_popup()
         return super().keypress(size, key)
@@ -822,7 +823,7 @@ def exit_popup_yes(self, args: Any) -> None:
     def exit_popup_no(self, args: Any) -> None:
         self.controller.exit_popup()
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('GO_BACK', key):
             self.controller.exit_popup()
         return super().keypress(size, key)
@@ -886,7 +887,7 @@ def __init__(self, controller: Any, msg: Message) -> None:
 
         super().__init__(self.log)
 
-    def keypress(self, size: Tuple[int, int], key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key('GO_BACK', key) or is_command_key('MSG_INFO', key):
             self.controller.exit_popup()
         return super().keypress(size, key)

zulipterminal/urwid_types.py

@@ -0,0 +1,4 @@
+from typing import Tuple, Union
+
+
+urwid_Size = Union[Tuple[()], Tuple[int], Tuple[int, int]]