Type hints for cli_* files.

Author: amjith

litecli/clibuffer.py

@@ -1,13 +1,15 @@
 # mypy: ignore-errors
 
-from __future__ import unicode_literals
+from __future__ import annotations
+
+from typing import Any
 
 from prompt_toolkit.enums import DEFAULT_BUFFER
-from prompt_toolkit.filters import Condition
+from prompt_toolkit.filters import Condition, Filter
 from prompt_toolkit.application import get_app
 
 
-def cli_is_multiline(cli):
+def cli_is_multiline(cli: Any) -> Filter:
     @Condition
     def cond():
         doc = get_app().layout.get_buffer_by_name(DEFAULT_BUFFER).document
@@ -20,7 +22,7 @@ def cond():
     return cond
 
 
-def _multiline_exception(text):
+def _multiline_exception(text: str) -> bool:
     orig = text
     text = text.strip()
 

litecli/clistyle.py

@@ -1,20 +1,22 @@
 # mypy: ignore-errors
 
-from __future__ import unicode_literals
+from __future__ import annotations
 
 import logging
+from typing import Dict, List, Tuple
 
 import pygments.styles
 from pygments.token import string_to_tokentype, Token
 from pygments.style import Style as PygmentsStyle
 from pygments.util import ClassNotFound
 from prompt_toolkit.styles.pygments import style_from_pygments_cls
 from prompt_toolkit.styles import merge_styles, Style
+from prompt_toolkit.styles.style import _MergedStyle
 
 logger = logging.getLogger(__name__)
 
 # map Pygments tokens (ptk 1.0) to class names (ptk 2.0).
-TOKEN_TO_PROMPT_STYLE = {
+TOKEN_TO_PROMPT_STYLE: Dict[Token, str] = {
     Token.Menu.Completions.Completion.Current: "completion-menu.completion.current",
     Token.Menu.Completions.Completion: "completion-menu.completion",
     Token.Menu.Completions.Meta.Current: "completion-menu.meta.completion.current",
@@ -43,10 +45,10 @@
 }
 
 # reverse dict for cli_helpers, because they still expect Pygments tokens.
-PROMPT_STYLE_TO_TOKEN = {v: k for k, v in TOKEN_TO_PROMPT_STYLE.items()}
+PROMPT_STYLE_TO_TOKEN: Dict[str, Token] = {v: k for k, v in TOKEN_TO_PROMPT_STYLE.items()}
 
 
-def parse_pygments_style(token_name, style_object, style_dict):
+def parse_pygments_style(token_name: str, style_object, style_dict: Dict[str, str]) -> Tuple[Token, str]:
     """Parse token type and style string.
 
     :param token_name: str name of Pygments token. Example: "Token.String"
@@ -62,13 +64,13 @@ def parse_pygments_style(token_name, style_object, style_dict):
         return token_type, style_dict[token_name]
 
 
-def style_factory(name, cli_style):
+def style_factory(name: str, cli_style: Dict[str, str]) -> _MergedStyle:
     try:
         style = pygments.styles.get_style_by_name(name)
     except ClassNotFound:
         style = pygments.styles.get_style_by_name("native")
 
-    prompt_styles = []
+    prompt_styles: List[Tuple[str, str]] = []
     # prompt-toolkit used pygments tokens for styling before, switched to style
     # names in 2.0. Convert old token types to new style names, for backwards compatibility.
     for token in cli_style:
@@ -86,11 +88,11 @@ def style_factory(name, cli_style):
             # https://github.com/jonathanslenders/python-prompt-toolkit/blob/master/prompt_toolkit/styles/defaults.py
             prompt_styles.append((token, cli_style[token]))
 
-    override_style = Style([("bottom-toolbar", "noreverse")])
+    override_style: Style = Style([("bottom-toolbar", "noreverse")])
     return merge_styles([style_from_pygments_cls(style), override_style, Style(prompt_styles)])
 
 
-def style_factory_output(name, cli_style):
+def style_factory_output(name: str, cli_style: Dict[str, str]):
     try:
         style = pygments.styles.get_style_by_name(name).styles
     except ClassNotFound:

litecli/clitoolbar.py

@@ -1,19 +1,19 @@
 # mypy: ignore-errors
 
-from __future__ import unicode_literals
+from __future__ import annotations
+
+from typing import Callable, List, Tuple
 
 from prompt_toolkit.key_binding.vi_state import InputMode
 from prompt_toolkit.enums import EditingMode
 from prompt_toolkit.application import get_app
 
 
-def create_toolbar_tokens_func(cli, show_fish_help):
-    """
-    Return a function that generates the toolbar tokens.
-    """
+def create_toolbar_tokens_func(cli, show_fish_help: Callable[[], bool]) -> Callable[[], List[Tuple[str, str]]]:
+    """Return a function that generates the toolbar tokens."""
 
-    def get_toolbar_tokens():
-        result = []
+    def get_toolbar_tokens() -> List[Tuple[str, str]]:
+        result: List[Tuple[str, str]] = []
         result.append(("class:bottom-toolbar", " "))
 
         if cli.multi_line:
@@ -37,7 +37,7 @@ def get_toolbar_tokens():
     return get_toolbar_tokens
 
 
-def _get_vi_mode():
+def _get_vi_mode() -> str:
     """Get the current vi mode for display."""
     return {
         InputMode.INSERT: "I",

litecli/packages/special/llm.py

@@ -88,7 +88,7 @@ def run_external_cmd(
         sys.argv = original_args
 
 
-def build_command_tree(cmd: click.BaseCommand) -> Optional[Dict[str, Any]]:
+def build_command_tree(cmd: click.Command) -> Optional[Dict[str, Any]]:
     """Recursively build a command tree for a Click app.
 
     Args: