Skip to content

Fix show_default type in click.option signatures#3385

Merged
srittau merged 1 commit intopython:masterfrom
dmtucker:master
Oct 18, 2019
Merged

Fix show_default type in click.option signatures#3385
srittau merged 1 commit intopython:masterfrom
dmtucker:master

Conversation

@dmtucker
Copy link
Contributor

Similar to #1693 / #1699, but for show_default...

Using show_default='not a bool' should be permitted according to the Click documentation; however, Mypy trips on it:

error: No overload variant of "option" matches argument types "str", "str", "int", "Path", "str", "str"
note: Possible overload variants:
note:     def option(*param_decls: str, cls: Type[Option] = ..., show_default: bool = ..., prompt: Union[bool, str] = ..., confirmation_prompt: bool = ..., hide_input: bool = ..., is_flag: Optional[bool] = ..., flag_value: Optional[Any] = ..., multiple: bool = ..., count: bool = ..., allow_from_autoenv: bool = ..., type: Union[type, _ParamType, Tuple[type, ...], Callable[[str], Any], Callable[[Optional[str]], Any], None] = ..., help: Optional[str] = ..., show_choices: bool = ..., default: Optional[Any] = ..., required: bool = ..., callback: Optional[Callable[[Context, Union[Option, Parameter], Any], Any]] = ..., nargs: Optional[int] = ..., metavar: Optional[str] = ..., expose_value: bool = ..., is_eager: bool = ..., envvar: Union[str, List[str], None] = ..., **kwargs: Any) -> Callable[[_F], _F]
note:     def [_T] option(*param_decls: str, cls: Type[Option] = ..., show_default: bool = ..., prompt: Union[bool, str] = ..., confirmation_prompt: bool = ..., hide_input: bool = ..., is_flag: Optional[bool] = ..., flag_value: Optional[Any] = ..., multiple: bool = ..., count: bool = ..., allow_from_autoenv: bool = ..., type: _T = ..., help: Optional[str] = ..., show_choices: bool = ..., default: Optional[Any] = ..., required: bool = ..., callback: Optional[Callable[[Context, Union[Option, Parameter], Union[bool, int, str]], _T]] = ..., nargs: Optional[int] = ..., metavar: Optional[str] = ..., expose_value: bool = ..., is_eager: bool = ..., envvar: Union[str, List[str], None] = ..., **kwargs: Any) -> Callable[[_F], _F]
note:     <2 more similar overloads not shown, out of 4 total overloads>

Copy link
Collaborator

@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@srittau srittau merged commit 38fbdc9 into python:master Oct 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants