Type-check package sources with Pyrefly strict mode

hatch.toml

@@ -34,7 +34,8 @@ typing-mypy = [
   "mypy tests examples",
 ]
 typing-pyrefly = [
-  "pyrefly check",
+  "pyrefly check --preset strict src/cloup",
+  "pyrefly check tests examples",
 ]
 typing = [
   "click-version",

pyproject.toml

@@ -36,7 +36,7 @@ classifiers = [
 ]
 dependencies = [
   "click >= 8.5.0, < 9.0",
-  'typing_extensions; python_version <= "3.10"',
+  'typing_extensions; python_version < "3.12"',
 ]
 dynamic = [
   "readme",

src/cloup/_commands.py

@@ -21,6 +21,7 @@
 """
 
 import inspect
+import sys
 from collections.abc import Callable, Iterable, Mapping, MutableMapping, Sequence
 from typing import (
     Any,
@@ -32,6 +33,11 @@
 
 import click
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 import cloup
 
 from ._context import Context
@@ -90,13 +96,15 @@ def get_normalized_epilog(self) -> str:
         return self.epilog or ""
 
     # Differently from Click, this doesn't indent the epilog.
+    @override
     def format_epilog(self, ctx: click.Context, formatter: click.HelpFormatter) -> None:
         if self.epilog:
             assert isinstance(formatter, cloup.HelpFormatter)
             epilog = self.get_normalized_epilog()
             formatter.write_paragraph()
             formatter.write_epilog(epilog)
 
+    @override
     def format_help_text(
         self, ctx: click.Context, formatter: click.HelpFormatter
     ) -> None:
@@ -109,6 +117,7 @@ def format_aliases(self, ctx: click.Context, formatter: click.HelpFormatter) ->
         assert isinstance(formatter, cloup.HelpFormatter)
         formatter.write_aliases(self.aliases)
 
+    @override
     def format_help(self, ctx: click.Context, formatter: click.HelpFormatter) -> None:
         self.format_usage(ctx, formatter)
         self.format_aliases(ctx, formatter)
@@ -180,6 +189,7 @@ def add_multiple_commands(
             for cmd in commands:
                 self.add_command(cmd)
 
+    @override
     def add_command(
         self,
         cmd: click.Command,
@@ -202,6 +212,7 @@ def resolve_command_name(self, ctx: click.Context, name: str) -> str | None:
             return name
         return self.alias2name.get(name)
 
+    @override
     def resolve_command(
         self, ctx: click.Context, args: list[str]
     ) -> tuple[str | None, click.Command | None, list[str]]:
@@ -248,6 +259,7 @@ def must_show_subcommand_aliases(self, ctx: click.Context) -> bool:
             Group.SHOW_SUBCOMMAND_ALIASES,
         )
 
+    @override
     def format_subcommand_name(
         self, ctx: click.Context, name: str, cmd: click.Command
     ) -> str:
@@ -320,6 +332,7 @@ def command(  # Why overloading? Refer to module docstring.
         **kwargs: Any,
     ) -> Callable[[AnyCallable], C]: ...
 
+    @override
     def command(
         self,
         name: str | None = None,
@@ -409,6 +422,7 @@ def group(  # Why overloading? Refer to module docstring.
         **kwargs: Any,
     ) -> Callable[[AnyCallable], G]: ...
 
+    @override
     def group(
         self,
         name: str | None = None,

src/cloup/_context.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 import warnings
 from collections.abc import Callable
 from functools import update_wrapper
@@ -15,6 +16,11 @@
 
 import click
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 import cloup
 from cloup._util import coalesce, pick_non_missing
 from cloup.formatting import HelpFormatter
@@ -173,6 +179,7 @@ def get_formatter_settings(self) -> dict[str, Any]:
             **getattr(self.command, "formatter_settings", {}),
         }
 
+    @override
     def make_formatter(self) -> HelpFormatter:
         opts = self.get_formatter_settings()
         return self.formatter_class(**opts)

src/cloup/_params.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Any
 
 import click
 from click.decorators import _param_memo
 
+from .typing import F
+
 if TYPE_CHECKING:
     from ._option_groups import OptionGroup
 
@@ -14,7 +17,12 @@ class Option(click.Option):
 
     group: OptionGroup | None
 
-    def __init__(self, *args, group=None, **attrs):
+    def __init__(
+        self,
+        *args: Any,
+        group: OptionGroup | None = None,
+        **attrs: Any,
+    ) -> None:
         super().__init__(*args, **attrs)
         self.group = group
 
@@ -23,17 +31,26 @@ def __init__(self, *args, group=None, **attrs):
 """Alias of ``Option``."""
 
 
-def argument(*param_decls, cls=None, **attrs):
+def argument(
+    *param_decls: str,
+    cls: type[click.Argument] | None = None,
+    **attrs: Any,
+) -> Callable[[F], F]:
     cls = cls or click.Argument
 
-    def decorator(f):
+    def decorator(f: F) -> F:
         _param_memo(f, cls(param_decls, **attrs))
         return f
 
     return decorator
 
 
-def option(*param_decls, cls=None, group=None, **attrs):
+def option(
+    *param_decls: str,
+    cls: type[click.Option] | None = None,
+    group: OptionGroup | None = None,
+    **attrs: Any,
+) -> Callable[[F], F]:
     """Attach an ``Option`` to the command.
     Refer to :class:`click.Option` and :class:`click.Parameter` for more info
     about the accepted parameters.
@@ -43,10 +60,10 @@ def option(*param_decls, cls=None, group=None, **attrs):
     """
     OptionClass = cls or Option
 
-    def decorator(f):
-        _param_memo(f, OptionClass(param_decls, **attrs))
-        new_option = f.__click_params__[-1]
-        new_option.group = group
+    def decorator(f: F) -> F:
+        new_option = OptionClass(param_decls, **attrs)
+        _param_memo(f, new_option)
+        setattr(new_option, "group", group)
         if group and group.hidden:
             new_option.hidden = True
         return f

src/cloup/constraints/_conditional.py

@@ -2,10 +2,16 @@
 This modules contains classes for creating conditional constraints.
 """
 
+import sys
 from collections.abc import Sequence
 
 from click import Context, Parameter
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 from .._util import make_repr
 from ._core import Constraint
 from .conditions import AllSet, IsSet, Predicate
@@ -60,6 +66,7 @@ def help(self, ctx: Context) -> str:
         else:
             return f"{then_help} if {condition}, otherwise {else_help}"
 
+    @override
     def check_consistency(self, params: Sequence[Parameter]) -> None:
         self._then.check_consistency(params)
         if self._else:
@@ -83,6 +90,7 @@ def check_values(self, params: Sequence[Parameter], ctx: Context) -> None:
                 f"when {desc}, {err}", ctx=ctx, constraint=self, params=params
             )
 
+    @override
     def __repr__(self) -> str:
         if self._else:
             return make_repr(self, self._condition, then=self._then, else_=self._else)

src/cloup/constraints/_core.py

@@ -1,4 +1,5 @@
 import abc
+import sys
 from collections.abc import Callable, Sequence
 from typing import (
     Any,
@@ -9,6 +10,11 @@
 
 import click
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 from cloup._util import (
     FrozenSpace,
     check_arg,
@@ -260,6 +266,7 @@ def help(self, ctx: click.Context) -> str:
             for c in self.constraints
         )
 
+    @override
     def check_consistency(self, params: Sequence[click.Parameter]) -> None:
         for c in self.constraints:
             c.check_consistency(params)
@@ -277,6 +284,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
         for c in self.constraints:
             c.check_values(params, ctx)
 
+    @override
     def __and__(self, other: Constraint) -> "And":
         if isinstance(other, And):
             return And(*self.constraints, *other.constraints)
@@ -299,6 +307,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
             self.help(ctx), ctx=ctx, constraint=self, params=params
         )
 
+    @override
     def __or__(self, other: Constraint) -> "Or":
         if isinstance(other, Or):
             return Or(*self.constraints, *other.constraints)
@@ -370,6 +379,7 @@ def _get_rephrased_error(self, err: ConstraintViolated) -> str | None:
         else:
             return self._error(err)
 
+    @override
     def check_consistency(self, params: Sequence[click.Parameter]) -> None:
         try:
             self.constraint.check_consistency(params)
@@ -387,6 +397,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
                 )
             raise
 
+    @override
     def __repr__(self) -> str:
         return make_one_line_repr(self, help=self._help)
 
@@ -412,6 +423,7 @@ def __init__(self, constraint: Constraint, **attrs: Any):
     def help(self, ctx: click.Context) -> str:
         return self._constraint.help(ctx)
 
+    @override
     def check_consistency(self, params: Sequence[click.Parameter]) -> None:
         try:
             self._constraint.check_consistency(params)
@@ -421,6 +433,7 @@ def check_consistency(self, params: Sequence[click.Parameter]) -> None:
     def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) -> None:
         self._constraint.check_values(params, ctx)
 
+    @override
     def __repr__(self) -> str:
         return make_repr(self, **self._attrs)
 
@@ -462,6 +475,7 @@ def __init__(self, n: int):
     def help(self, ctx: click.Context) -> str:
         return f"at least {self.min_num_params} required"
 
+    @override
     def check_consistency(self, params: Sequence[click.Parameter]) -> None:
         n = self.min_num_params
         if len(params) < n:
@@ -483,6 +497,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
                 params=params,
             )
 
+    @override
     def __repr__(self) -> str:
         return make_repr(self, self.min_num_params)
 
@@ -497,6 +512,7 @@ def __init__(self, n: int):
     def help(self, ctx: click.Context) -> str:
         return f"at most {self.max_num_params} accepted"
 
+    @override
     def check_consistency(self, params: Sequence[click.Parameter]) -> None:
         num_required_params = len(get_required_params(params))
         if num_required_params > self.max_num_params:
@@ -515,6 +531,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
                 params=params,
             )
 
+    @override
     def __repr__(self) -> str:
         return make_repr(self, self.max_num_params)
 
@@ -528,9 +545,11 @@ def __init__(self, n: int):
         super().__init__(RequireAtLeast(n) & AcceptAtMost(n))
         self.num_params = n
 
+    @override
     def help(self, ctx: click.Context) -> str:
         return f"exactly {self.num_params} required"
 
+    @override
     def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) -> None:
         n = self.num_params
         given_params = get_params_whose_value_is_set(params, ctx.params)
@@ -542,6 +561,7 @@ def check_values(self, params: Sequence[click.Parameter], ctx: click.Context) ->
             ) + format_param_list(params)
             raise ConstraintViolated(reason, ctx=ctx, constraint=self, params=params)
 
+    @override
     def __repr__(self) -> str:
         return make_repr(self, self.num_params)
 
@@ -561,6 +581,7 @@ def __init__(self, min: int, max: int):  # noqa
         self.min_num_params = min
         self.max_num_params = max
 
+    @override
     def help(self, ctx: click.Context) -> str:
         return (
             f"at least {self.min_num_params} required, "

src/cloup/constraints/_support.py

@@ -32,7 +32,8 @@ def _constraint_memo(
     f: Any, constr: Union[BoundConstraintSpec, "BoundConstraint"]
 ) -> None:
     if not hasattr(f, "__cloup_constraints__"):
-        f.__cloup_constraints__ = []
+        constraints: list[BoundConstraintSpec | BoundConstraint] = []
+        f.__cloup_constraints__ = constraints
     f.__cloup_constraints__.append(constr)