Type hints to config.py key_bindings.py and lexer.py

Author: amjith

litecli/config.py

@@ -1,32 +1,39 @@
+"""LiteCLI configuration helpers with typing."""
+
 # mypy: ignore-errors
 
+from __future__ import annotations
+
 import errno
 import shutil
 import os
 import platform
 from os.path import expanduser, exists, dirname
+from typing import Optional
+
 from configobj import ConfigObj
 
 
-def config_location():
+def config_location() -> str:
     if "XDG_CONFIG_HOME" in os.environ:
         return "%s/litecli/" % expanduser(os.environ["XDG_CONFIG_HOME"])
     elif platform.system() == "Windows":
-        return os.getenv("USERPROFILE") + "\\AppData\\Local\\dbcli\\litecli\\"
+        userprofile = os.getenv("USERPROFILE", "")
+        return userprofile + "\\AppData\\Local\\dbcli\\litecli\\"
     else:
         return expanduser("~/.config/litecli/")
 
 
-def load_config(usr_cfg, def_cfg=None):
+def load_config(usr_cfg: str, def_cfg: Optional[str] = None) -> ConfigObj:
     cfg = ConfigObj()
-    cfg.merge(ConfigObj(def_cfg, interpolation=False))
+    if def_cfg:
+        cfg.merge(ConfigObj(def_cfg, interpolation=False))
     cfg.merge(ConfigObj(expanduser(usr_cfg), interpolation=False, encoding="utf-8"))
     cfg.filename = expanduser(usr_cfg)
-
     return cfg
 
 
-def ensure_dir_exists(path):
+def ensure_dir_exists(path: str) -> None:
     parent_dir = expanduser(dirname(path))
     try:
         os.makedirs(parent_dir)
@@ -36,27 +43,25 @@ def ensure_dir_exists(path):
             raise
 
 
-def write_default_config(source, destination, overwrite=False):
+def write_default_config(source: str, destination: str, overwrite: bool = False) -> None:
     destination = expanduser(destination)
     if not overwrite and exists(destination):
         return
-
     ensure_dir_exists(destination)
-
     shutil.copyfile(source, destination)
 
 
-def upgrade_config(config, def_config):
+def upgrade_config(config: str, def_config: str) -> None:
     cfg = load_config(config, def_config)
     cfg.write()
 
 
-def get_config(liteclirc_file=None):
+def get_config(liteclirc_file: Optional[str] = None) -> ConfigObj:
     from litecli import __file__ as package_root
 
     package_root = os.path.dirname(package_root)
 
-    liteclirc_file = liteclirc_file or "%sconfig" % config_location()
+    liteclirc_file = liteclirc_file or f"{config_location()}config"
 
     default_config = os.path.join(package_root, "liteclirc")
     try:

litecli/key_bindings.py

@@ -1,26 +1,31 @@
+"""Key bindings with type hints."""
+
 # mypy: ignore-errors
 
-from __future__ import unicode_literals
+from __future__ import annotations
 import logging
+from typing import Any
+
 from prompt_toolkit.enums import EditingMode
 from prompt_toolkit.filters import completion_is_selected
 from prompt_toolkit.key_binding import KeyBindings
+from prompt_toolkit.key_binding.key_processor import KeyPressEvent
 
 _logger = logging.getLogger(__name__)
 
 
-def cli_bindings(cli):
+def cli_bindings(cli: Any) -> KeyBindings:
     """Custom key bindings for cli."""
     kb = KeyBindings()
 
     @kb.add("f3")
-    def _(event):
+    def _(_event: KeyPressEvent) -> None:
         """Enable/Disable Multiline Mode."""
         _logger.debug("Detected F3 key.")
         cli.multi_line = not cli.multi_line
 
     @kb.add("f4")
-    def _(event):
+    def _(event: KeyPressEvent) -> None:
         """Toggle between Vi and Emacs mode."""
         _logger.debug("Detected F4 key.")
         if cli.key_bindings == "vi":
@@ -31,7 +36,7 @@ def _(event):
             cli.key_bindings = "vi"
 
     @kb.add("tab")
-    def _(event):
+    def _(event: KeyPressEvent) -> None:
         """Force autocompletion at cursor."""
         _logger.debug("Detected <Tab> key.")
         b = event.app.current_buffer
@@ -41,7 +46,7 @@ def _(event):
             b.start_completion(select_first=True)
 
     @kb.add("s-tab")
-    def _(event):
+    def _(event: KeyPressEvent) -> None:
         """Force autocompletion at cursor."""
         _logger.debug("Detected <Tab> key.")
         b = event.app.current_buffer
@@ -51,7 +56,7 @@ def _(event):
             b.start_completion(select_last=True)
 
     @kb.add("c-space")
-    def _(event):
+    def _(event: KeyPressEvent) -> None:
         """
         Initialize autocompletion at cursor.
 
@@ -69,7 +74,7 @@ def _(event):
             b.start_completion(select_first=False)
 
     @kb.add("enter", filter=completion_is_selected)
-    def _(event):
+    def _(event: KeyPressEvent) -> None:
         """Makes the enter key work as the tab key only when showing the menu.
 
         In other words, don't execute query when enter is pressed in

litecli/lexer.py

@@ -1,5 +1,7 @@
 # mypy: ignore-errors
 
+from __future__ import annotations
+
 from pygments.lexer import inherit
 from pygments.lexers.sql import MySqlLexer
 from pygments.token import Keyword
@@ -8,4 +10,10 @@
 class LiteCliLexer(MySqlLexer):
     """Extends SQLite lexer to add keywords."""
 
-    tokens = {"root": [(r"\brepair\b", Keyword), (r"\boffset\b", Keyword), inherit]}
+    tokens = {
+        "root": [
+            (r"\brepair\b", Keyword),
+            (r"\boffset\b", Keyword),
+            inherit,
+        ]
+    }