feat: Add complete typing annotations (#1657)

Co-authored-by: Mikko Leppänen <[email protected]>

Author: bhirsz

.github/workflows/release-please.yml

@@ -1,9 +1,10 @@
 name: Release Please
 
-#on:  # temporarily disable before 8.0
-#  push:
+on:
+#  push: temporarily disable before 8.0
 #    branches:
 #      - main
+  workflow_dispatch:
 
 permissions:
   contents: write

noxfile.py

@@ -22,7 +22,7 @@
 
 @nox.session(python=PYTHON_VERSIONS)  # , reuse_venv=False
 @nox.parametrize("robot_ver", ROBOT_VERSIONS)
-def tests(session, robot_ver):
+def tests(session: nox.Session, robot_ver: str) -> None:
     """
     Run tests with a given Python version and dependency version.
 
@@ -48,13 +48,13 @@ def tests(session, robot_ver):
     session.run("pytest", "-v")
 
 
-def install_doc_deps(session, robot_version):
+def install_doc_deps(session: nox.Session, robot_version: str) -> None:
     session.install(f"robotframework=={robot_version}")
     session.run(*["uv", "sync", "--frozen", "--group", "doc"])
 
 
 @nox.session()
-def docs(session):
+def docs(session: nox.Session) -> None:
     install_doc_deps(session, "7.2.2")
     # session.run("sphinx-build", "-a", "-E", "-b", "html", "docs", "docs/_build/")
     command = ["sphinx-build", "-a", "-E", "--verbose", "-b", "html", "docs/source", "docs/_build/"]

pyproject.toml

@@ -50,7 +50,7 @@ robocop-mcp = "robocop.mcp.server:main"
 
 [project.optional-dependencies]
 mcp = [
-    "fastmcp>=2.13.0; python_version >= '3.10'",
+    "fastmcp>=2.13.0"
 ]
 
 [project.urls]
@@ -74,13 +74,18 @@ default-groups = ["dev", "doc"]
 
 [dependency-groups]
 dev = [
+    "robotframework-robocop[mcp]",
     "coverage>=7.6.4",
     "pytest>=8.3.3",
     "pytest-xdist>=3.6.1",
     "ruff==0.14.8",
     "pysonar",
     "nox>=2025.11.12",
     "packaging>=25.0",
+    "mypy>=1.19.1",
+    "types-jinja2",
+    "types-pytz",
+    "msgpack-types"
 ]
 doc = [
     "mkdocs",
@@ -132,7 +137,7 @@ lint.ignore = [
     "T201",  # print in code
     #### Fix or decrease
     "ERA001",  # commented-out code
-    "ANN204", # missing type annotation for __init__
+    #"ANN204", # missing type annotation for __init__
     "FIX002", # code with to do - check all of them later
     "PERF203", # try except in for loop - check all of them for possible refactors
     "C901", # code too complex (duplicate with other rules)
@@ -141,16 +146,16 @@ lint.ignore = [
     "FIX001",  # line with fixme
     "TD001",  # invalid todo tag fixme
     "TD004",  # missing colon in TODO
-    "ANN001",  # annotations in method
-    "ANN002",  # annotations in return type
-    "ANN201",  # annotations in return type
-    "ANN205",  # annotations in return type
+    #"ANN001",  # annotations in method
+    #"ANN002",  # annotations in return type
+    #"ANN201",  # annotations in return type
+    #"ANN205",  # annotations in return type
     "RUF012",  # mutable class attributes should be annotated with `typing.ClassVar`
     "PLR0913",  # too many arguments in function definition
     "PLW2901",  # for loop variable overwritten
     "INP001",  # part of namespace package
     "PLR0912",  # too many branches TODO
-    "ANN003",  # missing type kwargs
+    #"ANN003",  # missing type kwargs
     "SIM105",  # contexlib.supress
     "ANN401",  # typing.Any
     "B028",  # no implicit stacklevel
@@ -188,6 +193,9 @@ extend-exclude = [
 # bug in typer where | None can't be used
 "src/robocop/run.py" = ["RUF013"]
 
+[tool.ty.src]
+include = ["src"]
+
 [tool.coverage.run]
 omit = ["*tests*"]
 source = ["robocop"]
@@ -199,3 +207,41 @@ exclude_lines = [
         "raise NotImplementedError"
 ]
 fail_under = 5
+
+[tool.mypy]
+python_version = "3.10"
+
+strict = true
+
+warn_return_any = true
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_unreachable = true
+
+# Error output formatting
+show_error_codes = true
+show_column_numbers = true
+pretty = true
+color_output = true
+
+# Module discovery
+mypy_path = "src"
+packages = ["robocop"]
+exclude = ["tests/", "docs/"]
+
+# Robot Framework - no type stubs available for all supported versions
+[[tool.mypy.overrides]]
+module = "robot.*"
+ignore_missing_imports = true
+
+# External libraries that may have incomplete stubs or no stubs at all
+[[tool.mypy.overrides]]
+module = ["typer.*", "click.*", "rich.*", "rich_click.*", "platformdirs.*", "tomli.*", "tomli_w.*", "jinja2.*"]
+ignore_missing_imports = true
+
+# CLI module - intentionally passes None values to dataclasses which are handled by overwrite()
+# Also uses untyped decorators from typer/click and subclasses from Any-typed base classes
+[[tool.mypy.overrides]]
+module = "robocop.run"
+disable_error_code = ["arg-type", "attr-defined", "unused-ignore", "misc"]

src/robocop/cache.py

@@ -418,28 +418,6 @@ def _get_entry(
 
         return entry
 
-    def _set_entry(
-        self,
-        cache_dict: dict[str, LinterCacheEntry] | dict[str, FormatterCacheEntry],
-        path: Path,
-        entry: LinterCacheEntry | FormatterCacheEntry,
-    ) -> None:
-        """
-        Store a cache entry.
-
-        Args:
-            cache_dict: Dictionary to store cache entries (linter or formatter).
-            path: Absolute path to the file.
-            entry: Cache entry to store.
-
-        """
-        if not self.enabled:
-            return
-
-        str_path = self._normalize_path(path)
-        cache_dict[str_path] = entry
-        self._dirty = True
-
     # Linter cache methods
 
     def get_linter_entry(self, path: Path, config_hash: str) -> LinterCacheEntry | None:
@@ -483,8 +461,9 @@ def set_linter_entry(
             config_hash=config_hash,
             diagnostics=tuple(CachedDiagnostic.from_diagnostic(d) for d in diagnostics),
         )
-
-        self._set_entry(self.data.linter, path, entry)
+        str_path = self._normalize_path(path)
+        self.data.linter[str_path] = entry
+        self._dirty = True
 
     # Formatter cache methods
 
@@ -517,6 +496,8 @@ def set_formatter_entry(
             needs_formatting: Whether the file needed formatting.
 
         """
+        if not self.enabled:
+            return
         try:
             metadata = FileMetadata.from_path(path)
         except OSError:
@@ -527,8 +508,9 @@ def set_formatter_entry(
             config_hash=config_hash,
             needs_formatting=needs_formatting,
         )
-
-        self._set_entry(self.data.formatter, path, entry)
+        str_path = self._normalize_path(path)
+        self.data.formatter[str_path] = entry
+        self._dirty = True
 
 
 def restore_diagnostics(