Add types for filepaths and completion_engine.

Author: amjith

litecli/packages/completion_engine.py

@@ -1,13 +1,16 @@
 # mypy: ignore-errors
 
-from __future__ import print_function
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional
+
 import sqlparse
-from sqlparse.sql import Comparison, Identifier, Where
+from sqlparse.sql import Comparison, Identifier, Where, Token
 from .parseutils import last_word, extract_tables, find_prev_keyword
 from .special import parse_special_command
 
 
-def suggest_type(full_text, text_before_cursor):
+def suggest_type(full_text: str, text_before_cursor: str) -> List[Dict[str, Any]]:
     """Takes the full_text that is typed so far and also the text before the
     cursor to suggest completion type and scope.
 
@@ -17,7 +20,7 @@ def suggest_type(full_text, text_before_cursor):
 
     word_before_cursor = last_word(text_before_cursor, include="many_punctuations")
 
-    identifier = None
+    identifier: Optional[Identifier] = None
 
     # here should be removed once sqlparse has been fixed
     try:
@@ -86,7 +89,7 @@ def suggest_type(full_text, text_before_cursor):
     return suggest_based_on_last_token(last_token, text_before_cursor, full_text, identifier)
 
 
-def suggest_special(text):
+def suggest_special(text: str) -> List[Dict[str, Any]]:
     text = text.lstrip()
     cmd, _, arg = parse_special_command(text)
 
@@ -126,7 +129,7 @@ def suggest_special(text):
     return [{"type": "keyword"}, {"type": "special"}]
 
 
-def _expecting_arg_idx(arg, text):
+def _expecting_arg_idx(arg: str, text: str) -> int:
     """Return the index of expecting argument.
 
     >>> _expecting_arg_idx("./da", ".import ./da")
@@ -142,7 +145,12 @@ def _expecting_arg_idx(arg, text):
     return len(args) + int(text[-1].isspace())
 
 
-def suggest_based_on_last_token(token, text_before_cursor, full_text, identifier):
+def suggest_based_on_last_token(
+    token: Optional[str | Token],
+    text_before_cursor: str,
+    full_text: str,
+    identifier: Optional[Identifier],
+) -> List[Dict[str, Any]]:
     if isinstance(token, str):
         token_v = token.lower()
     elif isinstance(token, Comparison):
@@ -163,8 +171,8 @@ def suggest_based_on_last_token(token, text_before_cursor, full_text, identifier
     else:
         token_v = token.value.lower()
 
-    def is_operand(x):
-        return x and any([x.endswith(op) for op in ["+", "-", "*", "/"]])
+    def is_operand(x: Optional[str]) -> bool:
+        return bool(x) and any([x.endswith(op) for op in ["+", "-", "*", "/"]])
 
     if not token:
         return [{"type": "keyword"}, {"type": "special"}]
@@ -253,7 +261,7 @@ def is_operand(x):
                 {"type": "alias", "aliases": aliases},
                 {"type": "keyword"},
             ]
-    elif (token_v.endswith("join") and token.is_keyword) or (
+    elif (token_v.endswith("join") and isinstance(token, Token) and token.is_keyword) or (
         token_v in ("copy", "from", "update", "into", "describe", "truncate", "desc", "explain")
     ):
         schema = (identifier and identifier.get_parent_name()) or []
@@ -322,5 +330,5 @@ def is_operand(x):
         return [{"type": "keyword"}]
 
 
-def identifies(id, schema, table, alias):
+def identifies(id: Any, schema: Optional[str], table: str, alias: Optional[str]) -> bool:
     return id == alias or id == table or (schema and (id == schema + "." + table))

litecli/packages/filepaths.py

@@ -1,26 +1,28 @@
 # -*- coding: utf-8
 # mypy: ignore-errors
 
-from __future__ import unicode_literals
+from __future__ import annotations
+
+from typing import List, Tuple
 
 import os
 
 
-def list_path(root_dir):
+def list_path(root_dir: str) -> List[str]:
     """List directory if exists.
 
     :param dir: str
     :return: list
 
     """
-    res = []
+    res: List[str] = []
     if os.path.isdir(root_dir):
         for name in os.listdir(root_dir):
             res.append(name)
     return res
 
 
-def complete_path(curr_dir, last_dir):
+def complete_path(curr_dir: str, last_dir: str) -> str | None:
     """Return the path to complete that matches the last entered component.
 
     If the last entered component is ~, expanded path would not
@@ -35,9 +37,10 @@ def complete_path(curr_dir, last_dir):
         return curr_dir
     elif last_dir == "~":
         return os.path.join(last_dir, curr_dir)
+    return None
 
 
-def parse_path(root_dir):
+def parse_path(root_dir: str) -> Tuple[str, str, int]:
     """Split path into head and last component for the completer.
 
     Also return position where last component starts.
@@ -53,7 +56,7 @@ def parse_path(root_dir):
     return base_dir, last_dir, position
 
 
-def suggest_path(root_dir):
+def suggest_path(root_dir: str) -> List[str]:
     """List all files and subdirectories in a directory.
 
     If the directory is not specified, suggest root directory,
@@ -64,7 +67,7 @@ def suggest_path(root_dir):
 
     """
     if not root_dir:
-        return map(str, [os.path.abspath(os.sep), "~", os.curdir, os.pardir])
+        return [str(x) for x in [os.path.abspath(os.sep), "~", os.curdir, os.pardir]]
 
     if "~" in root_dir:
         root_dir = str(os.path.expanduser(root_dir))
@@ -75,7 +78,7 @@ def suggest_path(root_dir):
     return list_path(root_dir)
 
 
-def dir_path_exists(path):
+def dir_path_exists(path: str) -> bool:
     """Check if the directory path exists for a given file.
 
     For example, for a file /home/user/.cache/litecli/log, check if