Add the version to get ty working

Author: kracekumar

litecli/clistyle.py

@@ -1,20 +1,20 @@
 from __future__ import annotations
 
 import logging
-
+from typing import cast
 
 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 import Style, merge_styles
 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
+from pygments.style import Style as PygmentsStyle
+from pygments.token import Token, _TokenType, string_to_tokentype
+from pygments.util import ClassNotFound
 
 logger = logging.getLogger(__name__)
 
 # map Pygments tokens (ptk 1.0) to class names (ptk 2.0).
-TOKEN_TO_PROMPT_STYLE: dict[Token, str] = {
+TOKEN_TO_PROMPT_STYLE: dict[_TokenType, 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 +43,10 @@
 }
 
 # reverse dict for cli_helpers, because they still expect Pygments tokens.
-PROMPT_STYLE_TO_TOKEN: dict[str, Token] = {v: k for k, v in TOKEN_TO_PROMPT_STYLE.items()}
+PROMPT_STYLE_TO_TOKEN: dict[str, _TokenType] = {v: k for k, v in TOKEN_TO_PROMPT_STYLE.items()}
 
 
-def parse_pygments_style(token_name: str, style_object: PygmentsStyle | dict, style_dict: dict[str, str]) -> tuple[Token, str]:
+def parse_pygments_style(token_name: str, style_object: PygmentsStyle | dict, style_dict: dict[str, str]) -> tuple[_TokenType, str]:
     """Parse token type and style string.
 
     :param token_name: str name of Pygments token. Example: "Token.String"
@@ -111,4 +111,5 @@ class OutputStyle(PygmentsStyle):
         default_style = ""
         styles = style
 
-    return OutputStyle
+    # mypy does not complain only ty complains: error[invalid-return-type]: Return type does not match returned value. Hence added cast.
+    return cast(OutputStyle, PygmentsStyle)

litecli/completion_refresher.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
 import threading
+from collections import OrderedDict
 from typing import Callable
 
 from .packages.special.main import COMMANDS
-from collections import OrderedDict
-
 from .sqlcompleter import SQLCompleter
 from .sqlexecute import SQLExecute
 
@@ -94,7 +93,7 @@ def _bg_refresh(
             # break statement.
             continue
 
-        for callback in callbacks:
+        for callback in callbacks:  # ty: ignore[not-iterable]
             callback(completer)
 
 

litecli/main.py

@@ -12,18 +12,20 @@
 from datetime import datetime
 from io import open
 
+from litecli import sqlexecute
+
 try:
     from sqlean import OperationalError, sqlite_version
 except ImportError:
     from sqlite3 import OperationalError, sqlite_version
 from time import time
-from typing import Any, Iterable
+from typing import Any, Iterable, cast
 
 import click
 import sqlparse
 from cli_helpers.tabular_output import TabularOutputFormatter, preprocessors
 from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
-from prompt_toolkit.completion import DynamicCompleter
+from prompt_toolkit.completion import Completion, DynamicCompleter
 from prompt_toolkit.document import Document
 from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode
 from prompt_toolkit.filters import HasFocus, IsDone
@@ -35,8 +37,6 @@
 )
 from prompt_toolkit.lexers import PygmentsLexer
 from prompt_toolkit.shortcuts import CompleteStyle, PromptSession
-from typing import cast
-from prompt_toolkit.completion import Completion
 
 from .__init__ import __version__
 from .clibuffer import cli_is_multiline
@@ -53,8 +53,6 @@
 from .sqlcompleter import SQLCompleter
 from .sqlexecute import SQLExecute
 
-click.disable_unicode_literals_warning = True
-
 # Query tuples are used for maintaining history
 Query = namedtuple("Query", ["query", "successful", "mutating"])
 
@@ -84,7 +82,7 @@ def __init__(
         self.key_bindings = c["main"]["key_bindings"]
         special.set_favorite_queries(self.config)
         self.formatter = TabularOutputFormatter(format_name=c["main"]["table_format"])
-        self.formatter.litecli = self
+        self.formatter.litecli = self  # ty: ignore[unresolved-attribute]
         self.syntax_style = c["main"]["syntax_style"]
         self.less_chatty = c["main"].as_bool("less_chatty")
         self.show_bottom_toolbar = c["main"].as_bool("show_bottom_toolbar")
@@ -200,11 +198,14 @@ def change_db(self, arg: str | None, **_: Any) -> Iterable[tuple]:
             self.sqlexecute.connect(database=arg)
 
         self.refresh_completions()
+        # guard so that ty doesn't complain
+        dbname = self.sqlexecute.dbname if self.sqlexecute is not None else ""
+
         yield (
             None,
             None,
             None,
-            'You are now connected to database "%s"' % (self.sqlexecute.dbname),
+            'You are now connected to database "%s"' % (dbname),
         )
 
     def execute_from_file(self, arg: str | None, **_: Any) -> Iterable[tuple[Any, ...]]:

litecli/packages/special/__init__.py

@@ -1,6 +1,7 @@
 # ruff: noqa
 
 from __future__ import annotations
+from types import FunctionType
 
 from typing import Callable, Any
 
@@ -9,8 +10,9 @@
 
 def export(defn: Callable[..., Any]) -> Callable[..., Any]:
     """Decorator to explicitly mark functions that are exposed in a lib."""
-    globals()[defn.__name__] = defn
-    __all__.append(defn.__name__)
+    if isinstance(defn, FunctionType):
+        globals()[defn.__name__] = defn
+        __all__.append(defn.__name__)
     return defn
 
 

litecli/packages/special/favoritequeries.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import annotations
 
+import builtins
 from typing import Any, cast
 
 
@@ -39,7 +40,7 @@ class FavoriteQueries(object):
     def __init__(self, config: Any) -> None:
         self.config = config
 
-    def list(self) -> list[str]:
+    def list(self) -> builtins.list[str]:
         section = cast(dict[str, str], self.config.get(self.section_name, {}))
         return list(section.keys())
 

litecli/sqlexecute.py

@@ -1,9 +1,8 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Generator, Iterable
-
 from contextlib import closing
+from typing import Any, Generator, Iterable
 
 try:
     import sqlean as sqlite3
@@ -13,12 +12,13 @@
 except ImportError:
     import sqlite3
     from sqlite3 import OperationalError
-from litecli.packages.special.utils import check_if_sqlitedotcommand
-
-import sqlparse
 import os.path
 from urllib.parse import urlparse
 
+import sqlparse
+
+from litecli.packages.special.utils import check_if_sqlitedotcommand
+
 from .packages import special
 
 _logger = logging.getLogger(__name__)
@@ -88,7 +88,8 @@ def connect(self, database: str | None = None) -> None:
             if not os.path.exists(db_dir_name):
                 raise Exception("Path does not exist: {}".format(db_dir_name))
 
-        conn = sqlite3.connect(database=db_name, isolation_level=None, uri=uri)
+        # sqlean exposes the connect method during run-time
+        conn = sqlite3.connect(database=db_name, isolation_level=None, uri=uri)  # ty: ignore[possibly-missing-attribute]
         conn.text_factory = lambda x: x.decode("utf-8", "backslashreplace")
         if self.conn:
             self.conn.close()

pyproject.toml

@@ -15,9 +15,10 @@ dependencies = [
     "prompt-toolkit>=3.0.3,<4.0.0",
     "pygments>=1.6",
     "sqlparse>=0.4.4",
-    "setuptools",                   # Required by llm commands to install models
+    "setuptools", # Required by llm commands to install models
     "pip",
     "llm>=0.25.0",
+    "ty>=0.0.2",
 ]
 
 [build-system]
@@ -87,3 +88,23 @@ exclude = [
     '^\.pytest_cache/',
     '^\.ruff_cache/',
 ]
+
+
+[tool.ty.environment]
+python-version = "3.9"
+root = ["litecli"]
+
+[tool.ty.rules]
+unresolved-import = "ignore"
+
+[tool.ty.src]
+exclude = [
+    '**/build/',
+    '**/dist/',
+    '**/.tox/',
+    '**/.venv/',
+    '**/.mypy_cache/',
+    '**/.pytest_cache/',
+    '**/.ruff_cache/',
+    'tests/**'
+]

tests/test_main.py

@@ -1,26 +1,28 @@
 # mypy: ignore-errors
 
 import os
-from collections import namedtuple
-from textwrap import dedent
 import shutil
+from collections import namedtuple
 from datetime import datetime
+from textwrap import dedent
 from unittest.mock import patch
 
 import click
 import pytest
 from click.testing import CliRunner
+from utils import create_db, db_connection, dbtest, run
 
-from litecli.main import cli, LiteCli
+from litecli.main import LiteCli, cli
 from litecli.packages.special.main import COMMANDS as SPECIAL_COMMANDS
-from utils import dbtest, run, create_db, db_connection
 
 test_dir = os.path.abspath(os.path.dirname(__file__))
 project_dir = os.path.dirname(test_dir)
 default_config_file = os.path.join(project_dir, "tests", "liteclirc")
 
 CLI_ARGS = ["--liteclirc", default_config_file, "_test_db"]
 
+clickoutput: str
+
 
 @dbtest
 def test_execute_arg(executor):
@@ -237,7 +239,7 @@ def stub_terminal_size():
 
     old_func = shutil.get_terminal_size
 
-    shutil.get_terminal_size = stub_terminal_size
+    shutil.get_terminal_size = stub_terminal_size  # ty: ignore[invalid-assignment]
     lc = LiteCli()
     assert isinstance(lc.get_reserved_space(), int)
     shutil.get_terminal_size = old_func

tests/utils.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 # mypy: ignore-errors
 
+import multiprocessing
 import os
-import time
 import signal
-import platform
-import multiprocessing
+import sys
+import time
 from contextlib import closing
+
 import pytest
 
 try:
@@ -75,8 +76,8 @@ def send_ctrl_c_to_pid(pid, wait_seconds):
     """Sends a Ctrl-C like signal to the given `pid` after `wait_seconds`
     seconds."""
     time.sleep(wait_seconds)
-    system_name = platform.system()
-    if system_name == "Windows":
+    # ty, is aware of sys.platform and not platform.system. See: https://github.com/astral-sh/ty/issues/2033
+    if sys.platform == "win32":
         os.kill(pid, signal.CTRL_C_EVENT)
     else:
         os.kill(pid, signal.SIGINT)