mypy: Clarify keypress methods can return Optional[str] per urwid docs.

Author: neiljp

zulipterminal/ui.py

@@ -146,7 +146,7 @@ def show_right_panel(self, *, visible: bool) -> None:
             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:
+    def keypress(self, size: Tuple[int, int], key: str) -> Optional[str]:
         self.model.new_user_input = True
         if self.controller.editor_mode:
             return self.controller.editor.keypress((size[1],), key)

zulipterminal/ui_tools/boxes.py

@@ -129,7 +129,7 @@ def autocomplete_streams(self, text: str, state: int) -> Optional[str]:
         except IndexError:
             return None
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('SEND_MESSAGE', key):
             if self.msg_edit_id:
                 if not self.to_write_box:
@@ -666,7 +666,7 @@ def mouse_event(self, size: urwid_Size, event: str, button: int,
 
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('ENTER', key):
             if self.message['type'] == 'private':
                 self.model.controller.view.write_box.private_box_view(
@@ -790,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: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('GO_BACK', key):
             self.text_box.set_edit_text("")
             self.controller.editor_mode = False
@@ -821,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: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[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

@@ -78,7 +78,7 @@ def activate(self, key: Any) -> None:
         self.controller.view.body.focus_col = 1
         self.show_function(self)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('ENTER', key):
             self.activate(key)
         return super().keypress(size, key)
@@ -169,7 +169,7 @@ def mark_unmuted(self) -> None:
             # All messages in this stream are read.
             self.update_count(0)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[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

@@ -142,7 +142,7 @@ def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('NEXT_MESSAGE', key) and not self.new_loading:
             try:
                 position = self.log.next_position(self.focus_position)
@@ -290,7 +290,7 @@ def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('SEARCH_STREAMS', key):
             self.set_focus('header')
             return key
@@ -377,7 +377,7 @@ def mouse_event(self, size: urwid_Size, event: str, button: int, col: int,
                 return True
         return super().mouse_event(size, event, button, col, row, focus)
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('TOGGLE_TOPIC', key):
             # Exit topic view
             self.view.left_panel.contents[1] = (
@@ -461,7 +461,7 @@ def get_next_unread_pm(self) -> Optional[int]:
             return pm
         return None
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('GO_BACK', key):
             self.header.keypress(size, 'esc')
             self.footer.keypress(size, 'esc')
@@ -611,7 +611,7 @@ def users_view(self, users: Any=None) -> Any:
             self.view.user_w = user_w
         return user_w
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('SEARCH_PEOPLE', key):
             self.allow_update_user_list = False
             self.set_focus('header')
@@ -735,7 +735,7 @@ def topics_view(self, stream_button: Any) -> Any:
             )
         return w
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if (is_command_key('SEARCH_STREAMS', key) or
                 is_command_key('SEARCH_TOPICS', key)):
             self.focus_position = 1