Use a stub rather than TYPE_CHECKING

Author: kovidgoyal

kittens/ask/main.py

@@ -9,13 +9,13 @@
 from kitty.cli import parse_args
 from kitty.cli_stub import AskCLIOptions
 from kitty.constants import cache_dir
+from kitty.typing import BossType
 
 from ..tui.handler import result_handler
 from ..tui.operations import alternate_screen, styled
 
 if TYPE_CHECKING:
     import readline
-    import kitty
 else:
     readline = None
 
@@ -127,7 +127,7 @@ def main(args: List[str]) -> Response:
 
 
 @result_handler()
-def handle_result(args: List[str], data: Response, target_window_id: int, boss: 'kitty.boss.Boss') -> None:
+def handle_result(args: List[str], data: Response, target_window_id: int, boss: BossType) -> None:
     if data['response'] is not None:
         func, *args = data['items']
         getattr(boss, func)(data['response'], *args)

kittens/hints/main.py

@@ -10,8 +10,8 @@
 from gettext import gettext as _
 from itertools import repeat
 from typing import (
-    TYPE_CHECKING, Any, Callable, Dict, Generator, Iterable, List, Optional,
-    Pattern, Sequence, Set, Tuple, Type, cast
+    Any, Callable, Dict, Generator, Iterable, List, Optional, Pattern,
+    Sequence, Set, Tuple, Type, cast
 )
 
 from kitty.cli import parse_args
@@ -20,30 +20,26 @@
 from kitty.key_encoding import (
     KeyEvent, backspace_key, enter_key, key_defs as K
 )
+from kitty.typing import BossType, KittyCommonOpts
 from kitty.utils import ScreenSize, screen_size_function
 
 from ..tui.handler import Handler, result_handler
 from ..tui.loop import Loop
 from ..tui.operations import faint, styled
 
-if TYPE_CHECKING:
-    from kitty.config import KittyCommonOpts
-    from kitty.boss import Boss
-
 
 @lru_cache()
-def kitty_common_opts() -> 'KittyCommonOpts':
+def kitty_common_opts() -> KittyCommonOpts:
     import json
     v = os.environ.get('KITTY_COMMON_OPTS')
     if v:
-        return cast('KittyCommonOpts', json.loads(v))
+        return cast(KittyCommonOpts, json.loads(v))
     from kitty.config import common_opts_as_dict
     return common_opts_as_dict()
 
 
 DEFAULT_HINT_ALPHABET = string.digits + string.ascii_lowercase
 DEFAULT_REGEX = r'(?m)^\s*(.+)\s*$'
-screen_size = screen_size_function()
 ESCAPE = K['ESCAPE']
 
 
@@ -346,7 +342,7 @@ def parse_input(text: str) -> str:
     try:
         cols = int(os.environ['OVERLAID_WINDOW_COLS'])
     except KeyError:
-        cols = screen_size().cols
+        cols = screen_size_function()().cols
     return convert_text(text, cols)
 
 
@@ -560,7 +556,7 @@ def main(args: List[str]) -> Optional[Dict[str, Any]]:
     return run(opts, text, items)
 
 
-def linenum_handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: 'Boss', extra_cli_args: Sequence[str], *a: Any) -> None:
+def linenum_handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: BossType, extra_cli_args: Sequence[str], *a: Any) -> None:
     for m, g in zip(data['match'], data['groupdicts']):
         if m:
             path, line = g['path'], g['line']
@@ -589,7 +585,7 @@ def linenum_handle_result(args: List[str], data: Dict[str, Any], target_window_i
 
 
 @result_handler(type_of_input='screen')
-def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: 'Boss') -> None:
+def handle_result(args: List[str], data: Dict[str, Any], target_window_id: int, boss: BossType) -> None:
     if data['customize_processing']:
         m = load_custom_processor(data['customize_processing'])
         if 'handle_result' in m:

kittens/icat/main.py

@@ -13,13 +13,13 @@
 from math import ceil
 from tempfile import NamedTemporaryFile
 from typing import (
-    TYPE_CHECKING, Dict, Generator, List, NamedTuple, Optional, Pattern, Tuple,
-    Union
+    Dict, Generator, List, NamedTuple, Optional, Pattern, Tuple, Union
 )
 
 from kitty.cli import parse_args
 from kitty.cli_stub import IcatCLIOptions
 from kitty.constants import appname
+from kitty.typing import GRT_f, GRT_t
 from kitty.utils import (
     TTYIO, ScreenSize, ScreenSizeGetter, fit_image, screen_size_function
 )
@@ -30,9 +30,6 @@
 )
 from ..tui.operations import clear_images_on_screen
 
-if TYPE_CHECKING:
-    from ..tui.images import GRT_f, GRT_t  # noqa
-
 OPTIONS = '''\
 --align
 type=choices

kittens/tui/handler.py

@@ -3,35 +3,29 @@
 # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
 
+from types import TracebackType
 from typing import (
-    TYPE_CHECKING, Any, Callable, ContextManager, Dict, Optional, Sequence, Type,
-    Union
+    Any, Callable, ContextManager, Dict, Optional, Sequence, Type, Union
 )
 
-if TYPE_CHECKING:
-    from kitty.utils import ScreenSize
-    from .loop import TermManager, Loop, Debug, MouseEvent
-    from .images import ImageManager
-    from kitty.conf.utils import KittensKeyAction
-    from kitty.boss import Boss
-    from kitty.key_encoding import KeyEvent
-    from types import TracebackType
-    ScreenSize, TermManager, Loop, Debug, KeyEvent, MouseEvent, TracebackType, Boss, ImageManager
-    import asyncio
+from kitty.typing import (
+    AbstractEventLoop, BossType, Debug, ImageManagerType, KeyEventType,
+    KittensKeyActionType, LoopType, MouseEvent, ScreenSize, TermManagerType
+)
 
 
 class Handler:
 
-    image_manager_class: Optional[Type['ImageManager']] = None
+    image_manager_class: Optional[Type[ImageManagerType]] = None
 
     def _initialize(
         self,
-        screen_size: 'ScreenSize',
-        term_manager: 'TermManager',
+        screen_size: ScreenSize,
+        term_manager: TermManagerType,
         schedule_write: Callable[[bytes], None],
-        tui_loop: 'Loop',
-        debug: 'Debug',
-        image_manager: Optional['ImageManager'] = None
+        tui_loop: LoopType,
+        debug: Debug,
+        image_manager: Optional[ImageManagerType] = None
     ) -> None:
         from .operations import commander
         self.screen_size = screen_size
@@ -43,23 +37,23 @@ def _initialize(
         self._image_manager = image_manager
 
     @property
-    def image_manager(self) -> 'ImageManager':
+    def image_manager(self) -> ImageManagerType:
         assert self._image_manager is not None
         return self._image_manager
 
     @property
-    def asyncio_loop(self) -> 'asyncio.AbstractEventLoop':
+    def asyncio_loop(self) -> AbstractEventLoop:
         return self._tui_loop.asycio_loop
 
-    def add_shortcut(self, action: 'KittensKeyAction', key: str, mods: Optional[int] = None, is_text: Optional[bool] = False) -> None:
+    def add_shortcut(self, action: KittensKeyActionType, key: str, mods: Optional[int] = None, is_text: Optional[bool] = False) -> None:
         if not hasattr(self, '_text_shortcuts'):
             self._text_shortcuts, self._key_shortcuts = {}, {}
         if is_text:
             self._text_shortcuts[key] = action
         else:
             self._key_shortcuts[(key, mods or 0)] = action
 
-    def shortcut_action(self, key_event_or_text: Union[str, 'KeyEvent']) -> Optional['KittensKeyAction']:
+    def shortcut_action(self, key_event_or_text: Union[str, KeyEventType]) -> Optional[KittensKeyActionType]:
         if isinstance(key_event_or_text, str):
             return self._text_shortcuts.get(key_event_or_text)
         return self._key_shortcuts.get((key_event_or_text.key, key_event_or_text.mods))
@@ -70,7 +64,7 @@ def __enter__(self) -> None:
         self.debug.fobj = self
         self.initialize()
 
-    def __exit__(self, etype: type, value: Exception, tb: 'TracebackType') -> None:
+    def __exit__(self, etype: type, value: Exception, tb: TracebackType) -> None:
         del self.debug.fobj
         self.finalize()
         if self._image_manager is not None:
@@ -82,7 +76,7 @@ def initialize(self) -> None:
     def finalize(self) -> None:
         pass
 
-    def on_resize(self, screen_size: 'ScreenSize') -> None:
+    def on_resize(self, screen_size: ScreenSize) -> None:
         self.screen_size = screen_size
 
     def quit_loop(self, return_code: Optional[int] = None) -> None:
@@ -94,7 +88,7 @@ def on_term(self) -> None:
     def on_text(self, text: str, in_bracketed_paste: bool = False) -> None:
         pass
 
-    def on_key(self, key_event: 'KeyEvent') -> None:
+    def on_key(self, key_event: KeyEventType) -> None:
         pass
 
     def on_mouse(self, mouse_event: 'MouseEvent') -> None:
@@ -127,7 +121,7 @@ def print(self, *args: object, sep: str = ' ', end: str = '\r\n') -> None:
         data = sep.join(map(str, args)) + end
         self.write(data)
 
-    def suspend(self) -> ContextManager['TermManager']:
+    def suspend(self) -> ContextManager[TermManagerType]:
         return self._term_manager.suspend()
 
 
@@ -141,7 +135,7 @@ def __init__(self, impl: Callable, type_of_input: Optional[str], no_ui: bool):
         self.no_ui = no_ui
         self.type_of_input = type_of_input
 
-    def __call__(self, args: Sequence[str], data: Any, target_window_id: int, boss: 'Boss') -> Any:
+    def __call__(self, args: Sequence[str], data: Any, target_window_id: int, boss: BossType) -> Any:
         return self.impl(args, data, target_window_id, boss)
 
 

kittens/tui/images.py

@@ -10,10 +10,13 @@
 from contextlib import suppress
 from itertools import count
 from typing import (
-    TYPE_CHECKING, Any, DefaultDict, Deque, Dict, List, Optional, Sequence,
-    Tuple, Union
+    Any, DefaultDict, Deque, Dict, List, Optional, Sequence, Tuple, Union
 )
 
+from kitty.typing import (
+    CompletedProcess, GRT_a, GRT_d, GRT_f, GRT_m, GRT_o, GRT_t, HandlerType,
+    TypedDict
+)
 from kitty.utils import ScreenSize, fit_image
 
 from .operations import cursor
@@ -25,28 +28,11 @@
     fsenc = 'utf-8'
 
 
-try:
-    from typing import TypedDict, Literal
-    GRT_a = Literal['t', 'T', 'q', 'p', 'd']
-    GRT_f = Literal[24, 32, 100]
-    GRT_t = Literal['d', 'f', 't', 's']
-    GRT_o = Literal['z']
-    GRT_m = Literal[0, 1]
-    GRT_d = Literal['a', 'A', 'c', 'C', 'i', 'I', 'p', 'P', 'q', 'Q', 'x', 'X', 'y', 'Y', 'z', 'Z']
-except ImportError:
-    TypedDict = dict
-
-
-if TYPE_CHECKING:
-    import subprocess
-    from .handler import Handler
-
-
 class ImageData:
 
     def __init__(self, fmt: str, width: int, height: int, mode: str):
         self.width, self.height, self.fmt, self.mode = width, height, fmt, mode
-        self.transmit_fmt: 'GRT_f' = (24 if self.mode == 'rgb' else 32)
+        self.transmit_fmt: GRT_f = (24 if self.mode == 'rgb' else 32)
 
 
 class OpenFailed(ValueError):
@@ -71,7 +57,7 @@ class NoImageMagick(Exception):
     pass
 
 
-def run_imagemagick(path: str, cmd: Sequence[str], keep_stdout: bool = True) -> 'subprocess.CompletedProcess[bytes]':
+def run_imagemagick(path: str, cmd: Sequence[str], keep_stdout: bool = True) -> CompletedProcess:
     import subprocess
     try:
         p = subprocess.run(cmd, stdout=subprocess.PIPE if keep_stdout else subprocess.DEVNULL, stderr=subprocess.PIPE)
@@ -140,16 +126,16 @@ def can_display_images() -> bool:
 
 
 class GraphicsCommand:
-    a: 'GRT_a' = 't'  # action
-    f: 'GRT_f' = 32   # image data format
-    t: 'GRT_t' = 'd'  # transmission medium
+    a: GRT_a = 't'  # action
+    f: GRT_f = 32   # image data format
+    t: GRT_t = 'd'  # transmission medium
     s: int = 0        # sent image width
     v: int = 0        # sent image height
     S: int = 0        # size of data to read from file
     O: int = 0        # offset of data to read from file
     i: int = 0        # image id
-    o: Optional['GRT_o'] = None  # type of compression
-    m: 'GRT_m' = 0    # 0 or 1 whether there is more chunked data
+    o: Optional[GRT_o] = None  # type of compression
+    m: GRT_m = 0    # 0 or 1 whether there is more chunked data
     x: int = 0        # left edge of image area to display
     y: int = 0        # top edge of image area to display
     w: int = 0        # image width to display
@@ -159,7 +145,7 @@ class GraphicsCommand:
     c: int = 0        # number of cols to display image over
     r: int = 0        # number of rows to display image over
     z: int = 0        # z-index
-    d: 'GRT_d' = 'a'  # what to delete
+    d: GRT_d = 'a'  # what to delete
 
     def serialize(self, payload: bytes = b'') -> bytes:
         items = []
@@ -193,7 +179,7 @@ class Placement(TypedDict):
 
 class ImageManager:
 
-    def __init__(self, handler: 'Handler'):
+    def __init__(self, handler: HandlerType):
         self.image_id_counter = count()
         self.handler = handler
         self.filesystem_ok: Optional[bool] = None

kittens/tui/loop.py

@@ -12,9 +12,7 @@
 import sys
 from contextlib import contextmanager
 from functools import partial
-from typing import (
-    TYPE_CHECKING, Any, Callable, Dict, Generator, List, NamedTuple, Optional
-)
+from typing import Any, Callable, Dict, Generator, List, NamedTuple, Optional
 
 from kitty.constants import is_macos
 from kitty.fast_data_types import (
@@ -24,20 +22,12 @@
     ALT, CTRL, PRESS, RELEASE, REPEAT, SHIFT, backspace_key, decode_key_event,
     enter_key, key_defs as K
 )
-from kitty.utils import screen_size_function, write_all
+from kitty.typing import ImageManagerType, KeyEventType, Protocol
+from kitty.utils import ScreenSizeGetter, screen_size_function, write_all
 
 from .handler import Handler
 from .operations import init_state, reset_state
 
-if TYPE_CHECKING:
-    from kitty.key_encoding import KeyEvent
-    from .images import ImageManager
-    KeyEvent, ImageManager
-    from typing import Protocol
-else:
-    Protocol = object
-
-
 C, D = K['C'], K['D']
 
 
@@ -156,7 +146,7 @@ def initialize(self) -> None:
         self.write('\r\n')
         self.write('Press the Enter key to quit')
 
-    def on_key(self, key_event: 'KeyEvent') -> None:
+    def on_key(self, key_event: KeyEventType) -> None:
         if key_event is enter_key:
             self.quit_loop(1)
 
@@ -355,7 +345,7 @@ def quit(self, return_code: Optional[int] = None) -> None:
             self.return_code = return_code
         self.asycio_loop.stop()
 
-    def loop_impl(self, handler: Handler, term_manager: TermManager, image_manager: Optional['ImageManager'] = None) -> Optional[str]:
+    def loop_impl(self, handler: Handler, term_manager: TermManager, image_manager: Optional[ImageManagerType] = None) -> Optional[str]:
         self.write_buf = []
         tty_fd = term_manager.tty_fd
         tb = None
@@ -399,7 +389,7 @@ def _on_sigwinch() -> None:
 
         signal_manager = SignalManager(self.asycio_loop, _on_sigwinch, handler.on_interrupt, handler.on_term)
         with TermManager() as term_manager, signal_manager:
-            self._get_screen_size = screen_size_function(term_manager.tty_fd)
+            self._get_screen_size: ScreenSizeGetter = screen_size_function(term_manager.tty_fd)
             image_manager = None
             if handler.image_manager_class is not None:
                 image_manager = handler.image_manager_class(handler)