Mypy: static type checker for Python

cclauss · cclauss · commit e3d48a504ac3 · 2025-03-18T19:47:48.000+01:00
diff --git a/cpplint.py b/cpplint.py
@@ -41,6 +41,8 @@
 same line, but it is far from perfect (in either direction).
 """
 
+from __future__ import annotations
+
 import codecs
 import collections
 import copy
@@ -57,7 +59,7 @@
 import xml.etree.ElementTree
 
 # if empty, use defaults
-_valid_extensions = set()
+_valid_extensions: set[str] = set()
 
 __VERSION__ = "2.0.1"
 
@@ -830,7 +832,7 @@
 ]
 
 # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE
-_CHECK_REPLACEMENT = {macro_var: {} for macro_var in _CHECK_MACROS}
+_CHECK_REPLACEMENT: dict[str, dict[str, str]] = {macro_var: {} for macro_var in _CHECK_MACROS}
 
 for op, replacement in [
     ("==", "EQ"),
@@ -934,7 +936,7 @@
 
 # {str, set(int)}: a map from error categories to sets of linenumbers
 # on which those errors are expected and should be suppressed.
-_error_suppressions = {}
+_error_suppressions: dict[str, set[int]] = {}
 
 # The root directory used for deriving header guard CPP variable.
 # This is set by --root flag.
@@ -964,7 +966,7 @@
 
 # Treat all headers starting with 'h' equally: .h, .hpp, .hxx etc.
 # This is set by --headers flag.
-_hpp_headers = set()
+_hpp_headers: set[str] = set()
 
 
 class ErrorSuppressions:
@@ -1034,7 +1036,7 @@ def Clear(self):
         self._open_block_suppression = None
 
 
-_error_suppressions = ErrorSuppressions()
+_error_suppressions = ErrorSuppressions()  # type: ignore[assignment]
 
 
 def ProcessHppHeadersOption(val):
@@ -6609,7 +6611,7 @@ def ExpectingFunctionArgs(clean_lines, linenum):
     )
 
 
-_HEADERS_CONTAINING_TEMPLATES = (
+_HEADERS_CONTAINING_TEMPLATES: tuple[tuple[str, tuple[str, ...]], ...] = (
     ("<deque>", ("deque",)),
     (
         "<functional>",
@@ -6705,7 +6707,7 @@ def ExpectingFunctionArgs(clean_lines, linenum):
     ("<slist>", ("slist",)),
 )
 
-_HEADERS_MAYBE_TEMPLATES = (
+_HEADERS_MAYBE_TEMPLATES: tuple[tuple[str, tuple[str, ...]], ...] = (
     (
         "<algorithm>",
         (
@@ -6721,15 +6723,15 @@ def ExpectingFunctionArgs(clean_lines, linenum):
 )
 
 # Non templated types or global objects
-_HEADERS_TYPES_OR_OBJS = (
+_HEADERS_TYPES_OR_OBJS: tuple[tuple[str, tuple[str, ...]], ...] = (
     # String and others are special -- it is a non-templatized type in STL.
     ("<string>", ("string",)),
     ("<iostream>", ("cin", "cout", "cerr", "clog", "wcin", "wcout", "wcerr", "wclog")),
     ("<cstdio>", ("FILE", "fpos_t")),
 )
 
 # Non templated functions
-_HEADERS_FUNCTIONS = (
+_HEADERS_FUNCTIONS: tuple[tuple[str, tuple[str, ...]], ...] = (
     (
         "<cstdio>",
         (
@@ -6780,7 +6782,7 @@ def ExpectingFunctionArgs(clean_lines, linenum):
     ),
 )
 
-_re_pattern_headers_maybe_templates = []
+_re_pattern_headers_maybe_templates: list[tuple[re.Pattern, str, str]] = []
 for _header, _templates in _HEADERS_MAYBE_TEMPLATES:
     # Match max<type>(..., ...), max(..., ...), but not foo->max, foo.max or
     # 'type::max()'.
@@ -6796,7 +6798,7 @@ def ExpectingFunctionArgs(clean_lines, linenum):
 )
 
 # Other scripts may reach in and modify this pattern.
-_re_pattern_templates = []
+_re_pattern_templates: list[tuple[re.Pattern, str, str]] = []
 for _header, _templates in _HEADERS_CONTAINING_TEMPLATES:
     _re_pattern_templates.extend(
         (
@@ -6807,14 +6809,14 @@ def ExpectingFunctionArgs(clean_lines, linenum):
         for _template in _templates
     )
 
-_re_pattern_types_or_objs = []
+_re_pattern_types_or_objs: list[tuple[re.Pattern, object | type, str]] = []
 for _header, _types_or_objs in _HEADERS_TYPES_OR_OBJS:
     _re_pattern_types_or_objs.extend(
         (re.compile(r"\b" + _type_or_obj + r"\b"), _type_or_obj, _header)
         for _type_or_obj in _types_or_objs
     )
 
-_re_pattern_functions = []
+_re_pattern_functions: list[tuple[re.Pattern, str, str]] = []
 for _header, _functions in _HEADERS_FUNCTIONS:
     # Match printf(..., ...), but not foo->printf, foo.printf or
     # 'type::printf()'.
diff --git a/cpplint_clitest.py b/cpplint_clitest.py
@@ -30,6 +30,8 @@
 
 """Command Line interface integration test for cpplint.py."""
 
+from __future__ import annotations
+
 import contextlib
 import glob
 import os
@@ -39,23 +41,23 @@
 import tempfile
 
 import pytest
-from parameterized import parameterized
-from testfixtures import compare
+from parameterized import parameterized  # type: ignore[import-untyped]
+from testfixtures import compare  # type: ignore[import-untyped]
 
 import cpplint  # noqa: F401
 
 BASE_CMD = sys.executable + " " + os.path.abspath("./cpplint.py ")
 
 
-def run_shell_command(cmd: str, args: str, cwd="."):
+def run_shell_command(cmd: str, args: str, cwd: str = ".") -> tuple[int, bytes, bytes]:
     """Executes a command
 
     Args:
         cmd: A string to execute.
         args: A string with arguments to the command.
         cwd: from which folder to run.
     """
-    cmd, args = cmd.split(), args.split()
+    cmd, args = cmd.split(), args.split()  # type: ignore[assignment]
     proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=False)
     out, err = proc.stdout, proc.stderr
 
diff --git a/cpplint_unittest.py b/cpplint_unittest.py
@@ -32,6 +32,8 @@
 
 # TODO(unknown): Add a good test that tests UpdateIncludeState.
 
+from __future__ import annotations
+
 import codecs
 import os
 import platform
@@ -43,7 +45,7 @@
 import tempfile
 
 import pytest
-from parameterized import parameterized
+from parameterized import parameterized  # type: ignore[import-untyped]
 
 import cpplint
 
@@ -58,7 +60,7 @@ def codecs_latin_encode(x):
 class ErrorCollector:
     # These are a global list, covering all categories seen ever.
     _ERROR_CATEGORIES = cpplint._ERROR_CATEGORIES
-    _SEEN_ERROR_CATEGORIES = {}
+    _SEEN_ERROR_CATEGORIES: dict[str, str] = {}
 
     def __init__(self, assert_fn):
         """assert_fn: a function to call when we notice a problem."""
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ dynamic = [ "version" ]
 dependencies = [  ]
 
 optional-dependencies.dev = [
+  "mypy",
   "parameterized",
   "pylint>=2.11",
   "pytest",
diff --git a/tox.ini b/tox.ini
@@ -2,9 +2,12 @@
 envlist = py38, py39, py3.10, py311, py312, py313, pypy3
 skip_missing_interpreters = true
 
+
 [testenv]
+allowlist_externals = sh
 extras = dev
 
 commands =
   {envpython} -m pytest {posargs:}
   {envpython} -m pylint cpplint.py
+  sh -c 'mypy *.py'
