fix: Linting errors resulting from upgrading mypy/pyright.

Author: DanCardin

Makefile

@@ -1,4 +1,4 @@
-.PHONY: install test lint lint-typos lint-examples format
+.PHONY: install test lint lint-base lint-312 lint-typos lint-examples format
 
 install:
 	uv sync --all-extras

examples/test_kitchen_sink/example.py

@@ -41,7 +41,7 @@ class Example:
     subcommand: Annotated[Union[MeowCommand, BarkCommand], cappa.Subcommand]
 
     flags: Annotated[list[str], cappa.Arg(short=True, long=True)] = field(
-        default_factory=list
+        default_factory=lambda: []
     )
     flag: bool = False  # --flag
 

pyproject.toml

@@ -80,12 +80,12 @@ ignore_missing_imports = true
 warn_unused_ignores = true
 incremental = true
 check_untyped_defs = true
+exclude = ["tests/py312"]
 
 [tool.pyright]
 typeCheckingMode = "strict"
 typeCheckingModeOverrides = { "type_lens/**" = "basic" }
 
-
 [tool.typos.default]
 extend-ignore-re = [".*#.*typos: ignore[^\\n]*\\n"]
 

src/cappa/arg.py

@@ -622,7 +622,7 @@ def infer_parse(
 
         literal_type = Literal[tuple(arg.choices)]  # type: ignore
         literal_parse: Parser[Any] = parse_literal(literal_type)  # type: ignore
-        parse = [*parse, literal_parse]
+        parse = cast(Sequence[Parser[Any]], [*parse, literal_parse])
 
     return evaluate_parse(parse, type_view, state=state)
 

src/cappa/argparse.py

@@ -2,7 +2,7 @@
 
 import argparse
 import sys
-from typing import TYPE_CHECKING, Any, Callable, Hashable, TypeVar, cast
+from typing import TYPE_CHECKING, Any, Callable, Hashable, List, TypeVar, cast
 
 from cappa.arg import Arg, ArgAction
 from cappa.command import Command, Subcommand
@@ -227,11 +227,11 @@ def add_argument(
 
     names: list[str] = []
     if arg.short:
-        short: list[str] = assert_type(arg.short, list)
+        short = cast(List[str], arg.short)
         names.extend(short)
 
     if arg.long:
-        long: list[str] = assert_type(arg.long, list)
+        long = cast(List[str], arg.long)
         names.extend(long)
 
     is_positional = not names
@@ -288,7 +288,7 @@ def add_subcommands(
             description=subcommand.description,
             formatter_class=parser.formatter_class,
             add_help=False,
-            command=subcommand,  # type: ignore
+            command=subcommand,
             output=output,
             prog=f"{parser.prog} {subcommand.real_name()}",
             **deprecated_kwarg,

src/cappa/base.py

@@ -2,7 +2,17 @@
 
 import dataclasses
 import inspect
-from typing import TYPE_CHECKING, Any, Protocol, TextIO, Type, TypeVar, Union, overload
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Protocol,
+    TextIO,
+    Type,
+    TypeVar,
+    Union,
+    cast,
+    overload,
+)
 
 from rich.theme import Theme
 from typing_extensions import dataclass_transform
@@ -412,7 +422,7 @@ def wrapper(_decorated_cls: U) -> U:
         # Functions (and in particular class methods, must return a function object in order
         # to be attached as methods) cannot be nested, so we can just directly return it.
         if inspect.isfunction(_decorated_cls):
-            return _decorated_cls  # type: ignore
+            return cast(U, _decorated_cls)
 
         # Whereas classes will **generally** be the **exact** object as `_decorated_cls` was,
         # except in the case of dynamically generated subclasses used for detecting methods.

src/cappa/class_inspect.py

@@ -34,7 +34,7 @@ class Field:
     annotation: type
     default: typing.Any | EmptyType = Empty
     default_factory: typing.Any | EmptyType = Empty
-    metadata: dict[str, Any] = dataclasses.field(default_factory=dict)
+    metadata: dict[str, Any] = dataclasses.field(default_factory=lambda: {})
 
 
 @dataclasses.dataclass
@@ -47,7 +47,7 @@ def collect(cls, typ: type) -> list[Self]:
                 continue
             field = cls(
                 name=f.name,
-                annotation=f.type,  # pyright: ignore
+                annotation=f.type,  # type: ignore
                 default=f.default if f.default is not dataclasses.MISSING else Empty,
                 default_factory=f.default_factory
                 if f.default_factory is not dataclasses.MISSING

src/cappa/command.py

@@ -81,8 +81,10 @@ class Command(Generic[T]):
     """
 
     cmd_cls: type[T]
-    arguments: list[Arg[Any] | Subcommand] = dataclasses.field(default_factory=list)
-    propagated_arguments: list[Arg[Any]] = dataclasses.field(default_factory=list)
+    arguments: list[Arg[Any] | Subcommand] = dataclasses.field(
+        default_factory=lambda: []
+    )
+    propagated_arguments: list[Arg[Any]] = dataclasses.field(default_factory=lambda: [])
 
     name: str | None = None
     help: str | None = None

src/cappa/docstring.py

@@ -90,7 +90,7 @@ def get_attribute_docstrings(command: type) -> dict[str, str]:
             if last_assignment:
                 name = typing.cast(ast.Name, last_assignment.target).id
                 value = typing.cast(ast.Constant, node.value).value
-                result[name] = value
+                result[name] = str(value)
                 continue
 
         last_assignment = node if isinstance(node, ast.AnnAssign) else None

src/cappa/help.py

@@ -4,7 +4,7 @@
 from collections.abc import Iterable
 from dataclasses import dataclass, replace
 from itertools import groupby
-from typing import Any, Sequence, cast
+from typing import Any, Sequence, Tuple, cast
 
 from rich.console import Console, NewLine
 from rich.markdown import Markdown
@@ -31,19 +31,14 @@
 TextComponent = typing.Union[Text, Markdown, str]
 ArgFormat: TypeAlias = typing.Union[
     TextComponent,
-    typing.Sequence[
-        typing.Union[
-            TextComponent,
-            typing.Callable[[Arg[Any]], typing.Union[TextComponent, None]],
-        ]
-    ],
     typing.Callable[[Arg[Any]], typing.Union[TextComponent, None]],
 ]
+ArgFormats: TypeAlias = typing.Sequence[ArgFormat]
 
 
 class HelpFormattable(typing.Protocol):
     left_padding: Dimension
-    arg_format: ArgFormat
+    arg_format: ArgFormat | ArgFormats
     default_format: str
 
     def __call__(
@@ -117,7 +112,7 @@ def create_completion_arg(completion: bool | Arg[bool] = True) -> Arg[bool] | No
 @dataclass(frozen=True)
 class HelpFormatter(HelpFormattable):
     left_padding: Dimension = (0, 0, 0, 2)
-    arg_format: ArgFormat = (
+    arg_format: ArgFormat | ArgFormats = (
         Markdown("{help}"),
         Markdown("{choices}"),
         Markdown("{default}", style="dim italic"),
@@ -143,8 +138,12 @@ def __call__(self, command: Command[Any], prog: str) -> list[Displayable]:
         lines.extend(add_long_args(console, self, arg_groups))
         return lines
 
-    def with_arg_format(self, _format: ArgFormat, *formats: ArgFormat) -> Self:
-        format = _format if isinstance(_format, tuple) else (_format,)
+    def with_arg_format(
+        self, _format: ArgFormat | tuple[ArgFormat, ...], *formats: ArgFormat
+    ) -> Self:
+        format = cast(
+            Tuple[ArgFormat, ...], _format if isinstance(_format, tuple) else (_format,)
+        )
         arg_format = (*format, *formats)
         return replace(self, arg_format=arg_format)
 
@@ -185,9 +184,13 @@ def add_long_args(
 def format_arg(
     console: Console, help_formatter: HelpFormattable, arg: Arg[Any]
 ) -> Displayable:
-    arg_format = help_formatter.arg_format
-    if not isinstance(arg_format, Iterable) or isinstance(arg_format, str):
-        arg_format = (arg_format,)
+    unknown_arg_format = help_formatter.arg_format
+    if isinstance(unknown_arg_format, Iterable) and not isinstance(
+        unknown_arg_format, str
+    ):
+        arg_format = cast(Sequence[ArgFormat], unknown_arg_format)
+    else:
+        arg_format = (unknown_arg_format,)
 
     segments: list[TextComponent] = []
     for format_segment in arg_format: