Merge pull request #1270 from dbcli/RW/add-limited-mypy-to-ci

rolandwalker · web-flow · commit 9379f4e3a0f8 · 2025-07-18T11:02:08.000-04:00
Add type checking to CI
diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml
@@ -0,0 +1,32 @@
+name: lint
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'AUTHORS'
+
+jobs:
+  linters:
+    name: Typecheck
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: '3.13'
+
+      - uses: astral-sh/setup-uv@7edac99f961f18b581bbd960d59d049f04c0002f # v6.4.1
+        with:
+          version: 'latest'
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run mypy
+        run: |
+          uv run --no-sync --frozen -- python -m mypy --no-pretty --install-types .
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,12 @@
+Upcoming Release (TBD)
+======================
+
+Internal
+--------
+
+* Add limited typechecking to CI.
+
+
 1.35.0 (2025/07/18)
 ======================
 
diff --git a/mycli/__init__.py b/mycli/__init__.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import importlib.metadata
 
 __version__ = importlib.metadata.version("mycli")
diff --git a/mycli/clibuffer.py b/mycli/clibuffer.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from prompt_toolkit.application import get_app
 from prompt_toolkit.enums import DEFAULT_BUFFER
 from prompt_toolkit.filters import Condition
diff --git a/mycli/clistyle.py b/mycli/clistyle.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import logging
 
 from prompt_toolkit.styles import Style, merge_styles
diff --git a/mycli/clitoolbar.py b/mycli/clitoolbar.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from prompt_toolkit.application import get_app
 from prompt_toolkit.enums import EditingMode
 from prompt_toolkit.key_binding.vi_state import InputMode
diff --git a/mycli/compat.py b/mycli/compat.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Platform and Python version compatibility support."""
 
 import sys
diff --git a/mycli/completion_refresher.py b/mycli/completion_refresher.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from collections import OrderedDict
 import threading
 
diff --git a/mycli/config.py b/mycli/config.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from copy import copy
 from importlib import resources
 from io import BytesIO, TextIOWrapper
diff --git a/mycli/key_bindings.py b/mycli/key_bindings.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import logging
 
 from prompt_toolkit.enums import EditingMode
diff --git a/mycli/lexer.py b/mycli/lexer.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from pygments.lexer import inherit
 from pygments.lexers.sql import MySqlLexer
 from pygments.token import Keyword
diff --git a/mycli/magic.py b/mycli/magic.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import logging
 
 import sql.connection
diff --git a/mycli/main.py b/mycli/main.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from collections import defaultdict, namedtuple
 import logging
 import os
diff --git a/mycli/packages/completion_engine.py b/mycli/packages/completion_engine.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import sqlparse
 from sqlparse.sql import Comparison, Identifier, Where
 
diff --git a/mycli/packages/filepaths.py b/mycli/packages/filepaths.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 import platform
 
diff --git a/mycli/packages/hybrid_redirection.py b/mycli/packages/hybrid_redirection.py
@@ -5,8 +5,8 @@
 
 import sqlglot
 
-from mycli.compat import WIN
-from mycli.packages.special.delimitercommand import DelimiterCommand
+from mycli.compat import WIN  # type: ignore[attr-defined]
+from mycli.packages.special.delimitercommand import DelimiterCommand  # type: ignore[attr-defined]
 
 logger = logging.getLogger(__name__)
 delimiter_command = DelimiterCommand()
diff --git a/mycli/packages/paramiko_stub/__init__.py b/mycli/packages/paramiko_stub/__init__.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """A module to import instead of paramiko when it is not available (to avoid
 checking for paramiko all over the place).
 
diff --git a/mycli/packages/parseutils.py b/mycli/packages/parseutils.py
@@ -1,9 +1,11 @@
+# type: ignore
+
 import re
 
 import sqlglot
-import sqlparse
-from sqlparse.sql import Function, Identifier, IdentifierList
-from sqlparse.tokens import DML, Keyword, Punctuation
+import sqlparse  # type: ignore[import-untyped]
+from sqlparse.sql import Function, Identifier, IdentifierList  # type: ignore[import-untyped]
+from sqlparse.tokens import DML, Keyword, Punctuation  # type: ignore[import-untyped]
 
 cleanup_regex = {
     # This matches only alphanumerics and underscores.
diff --git a/mycli/packages/prompt_utils.py b/mycli/packages/prompt_utils.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import sys
 
 import click
diff --git a/mycli/packages/special/__init__.py b/mycli/packages/special/__init__.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 __all__ = []
 
 
diff --git a/mycli/packages/special/dbcommands.py b/mycli/packages/special/dbcommands.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import logging
 import os
 import platform
diff --git a/mycli/packages/special/delimitercommand.py b/mycli/packages/special/delimitercommand.py
@@ -1,6 +1,8 @@
+# type: ignore
+
 import re
 
-import sqlparse
+import sqlparse  # type: ignore[import-untyped]
 
 
 class DelimiterCommand(object):
diff --git a/mycli/packages/special/favoritequeries.py b/mycli/packages/special/favoritequeries.py
@@ -1,3 +1,6 @@
+# type: ignore
+
+
 class FavoriteQueries(object):
     section_name = "favorite_queries"
 
diff --git a/mycli/packages/special/iocommands.py b/mycli/packages/special/iocommands.py
@@ -1,14 +1,17 @@
+# type: ignore
+
 import locale
 import logging
 import os
 import re
 import shlex
 import subprocess
 from time import sleep
+from typing import Any
 
 import click
-import pyperclip
-import sqlparse
+import pyperclip  # type: ignore[import-untyped]
+import sqlparse  # type: ignore[import-untyped]
 
 from mycli.compat import WIN
 from mycli.packages.prompt_utils import confirm_destructive_query
@@ -25,7 +28,7 @@
 tee_file = None
 once_file = None
 written_to_once_file = False
-PIPE_ONCE = {
+PIPE_ONCE: dict[str, Any] = {
     'process': None,
     'stdin': [],
     'stdout_file': None,
diff --git a/mycli/packages/special/main.py b/mycli/packages/special/main.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from collections import namedtuple
 import logging
 
diff --git a/mycli/packages/special/utils.py b/mycli/packages/special/utils.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 import subprocess
 
diff --git a/mycli/packages/tabular_output/sql_format.py b/mycli/packages/tabular_output/sql_format.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Format adapter for sql."""
 
 from mycli.packages.parseutils import extract_tables_from_complete_statements
diff --git a/mycli/packages/toolkit/fzf.py b/mycli/packages/toolkit/fzf.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import re
 from shutil import which
 
diff --git a/mycli/packages/toolkit/history.py b/mycli/packages/toolkit/history.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 from typing import List, Tuple, Union
 
diff --git a/mycli/shortcuts.py b/mycli/shortcuts.py
@@ -1,3 +1,6 @@
+# type: ignore
+
+
 def server_date(sqlexecute, quoted: bool = False) -> str:
     server_date_str = sqlexecute.now().strftime('%Y-%m-%d')
     if quoted:
diff --git a/mycli/sqlcompleter.py b/mycli/sqlcompleter.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from collections import Counter
 import logging
 import re
diff --git a/mycli/sqlexecute.py b/mycli/sqlexecute.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import enum
 import logging
 import re
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,6 +39,7 @@ ssh = ["paramiko", "sshtunnel"]
 dev = [
     "behave>=1.2.6",
     "coverage>=7.2.7",
+    "mypy>=1.16.1",
     "pexpect>=4.9.0",
     "pytest>=7.4.4",
     "pytest-cov>=4.1.0",
@@ -99,3 +100,17 @@ exclude = [
     'build',
     'mycli_dev',
 ]
+
+[tool.mypy]
+pretty                 = true
+strict_equality        = true
+ignore_missing_imports = true
+warn_unreachable       = true
+warn_redundant_casts   = true
+warn_no_return         = true
+warn_unused_configs    = true
+show_column_numbers    = true
+exclude = [
+    '^build/',
+    '^dist/',
+]
diff --git a/test/conftest.py b/test/conftest.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import pytest
 
 import mycli.sqlexecute
diff --git a/test/features/db_utils.py b/test/features/db_utils.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import pymysql
 
 
diff --git a/test/features/environment.py b/test/features/environment.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 import shutil
 import sys
diff --git a/test/features/fixture_utils.py b/test/features/fixture_utils.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 
 
diff --git a/test/features/steps/auto_vertical.py b/test/features/steps/auto_vertical.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 from textwrap import dedent
 
 from behave import then, when
diff --git a/test/features/steps/basic_commands.py b/test/features/steps/basic_commands.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Steps for behavioral style tests are defined in this module.
 
 Each step is defined by the string decorating it. This string is used
diff --git a/test/features/steps/connection.py b/test/features/steps/connection.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import io
 import os
 
diff --git a/test/features/steps/crud_database.py b/test/features/steps/crud_database.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Steps for behavioral style tests are defined in this module.
 
 Each step is defined by the string decorating it. This string is used
diff --git a/test/features/steps/crud_table.py b/test/features/steps/crud_table.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Steps for behavioral style tests are defined in this module.
 
 Each step is defined by the string decorating it. This string is used
diff --git a/test/features/steps/iocommands.py b/test/features/steps/iocommands.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import os
 from textwrap import dedent
 
diff --git a/test/features/steps/named_queries.py b/test/features/steps/named_queries.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Steps for behavioral style tests are defined in this module.
 
 Each step is defined by the string decorating it. This string is used
diff --git a/test/features/steps/specials.py b/test/features/steps/specials.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Steps for behavioral style tests are defined in this module.
 
 Each step is defined by the string decorating it. This string is used
diff --git a/test/features/steps/utils.py b/test/features/steps/utils.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import shlex
 
 
diff --git a/test/features/steps/wrappers.py b/test/features/steps/wrappers.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 import re
 import sys
 import textwrap
diff --git a/test/features/wrappager.py b/test/features/wrappager.py
@@ -1,8 +1,9 @@
 #!/usr/bin/env python
+
 import sys
 
 
-def wrappager(boundary):
+def wrappager(boundary: str) -> None:
     print(boundary)
     while 1:
         buf = sys.stdin.read(2048)
diff --git a/test/test_clistyle.py b/test/test_clistyle.py
@@ -1,3 +1,5 @@
+# type: ignore
+
 """Test the mycli.clistyle module."""
 
 from pygments.style import Style
diff --git a/test/test_completion_engine.py b/test/test_completion_engine.py
diff --git a/test/test_completion_refresher.py b/test/test_completion_refresher.py
diff --git a/test/test_config.py b/test/test_config.py
diff --git a/test/test_dbspecial.py b/test/test_dbspecial.py
diff --git a/test/test_main.py b/test/test_main.py
diff --git a/test/test_naive_completion.py b/test/test_naive_completion.py
diff --git a/test/test_parseutils.py b/test/test_parseutils.py
diff --git a/test/test_prompt_utils.py b/test/test_prompt_utils.py
diff --git a/test/test_smart_completion_public_schema_only.py b/test/test_smart_completion_public_schema_only.py
diff --git a/test/test_special_iocommands.py b/test/test_special_iocommands.py
diff --git a/test/test_sqlexecute.py b/test/test_sqlexecute.py
diff --git a/test/test_tabular_output.py b/test/test_tabular_output.py
diff --git a/test/utils.py b/test/utils.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# type: ignore`
	`2`	`+`
`1`	`3`	`from prompt_toolkit.application import get_app`
`2`	`4`	`from prompt_toolkit.enums import DEFAULT_BUFFER`
`3`	`5`	`from prompt_toolkit.filters import Condition`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# type: ignore`
	`2`	`+`
`1`	`3`	`import logging`
`2`	`4`
`3`	`5`	`from prompt_toolkit.styles import Style, merge_styles`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# type: ignore`
	`2`	`+`
`1`	`3`	`"""Platform and Python version compatibility support."""`
`2`	`4`
`3`	`5`	`import sys`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# type: ignore`
	`2`	`+`
`1`	`3`	`from collections import OrderedDict`
`2`	`4`	`import threading`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# type: ignore`
	`2`	`+`
`1`	`3`	`from copy import copy`
`2`	`4`	`from importlib import resources`
`3`	`5`	`from io import BytesIO, TextIOWrapper`