fix behavior of show_default with context_settings #115
Conversation
| @@ -43,7 +43,7 @@ def _get_usage(ctx: click.Context) -> str: | |||
| return formatter.getvalue().rstrip('\n') # type: ignore | |||
|
|
|||
|
|
|||
| def _get_help_record(opt: click.Option) -> ty.Tuple[str, str]: | |||
| def _get_help_record(opt: click.Option, ctx: click.Context) -> ty.Tuple[str, str]: | |||
There was a problem hiding this comment.
Can you pass ctx as the first argument instead, please. Ditto for the other modified functions.
| if opt.show_default is not None: | ||
| show_default = opt.show_default | ||
| else: | ||
| show_default = ctx.show_default |
There was a problem hiding this comment.
This is available in click 7.x so we don't need version-specific logic 👍
However, the click 8.1.x docs state:
Changed in version 8.1: The show_default parameter is overridden by Command.show_default, instead of the other way around.
Should we replicate this behaviour here? It feels like we should? If we don't, we might want to add a note here that we intentionally decided not to.
| @@ -231,6 +231,40 @@ def foobar(bar): | |||
| '\n'.join(output), | |||
| ) | |||
|
|
|||
| def test_show_default(self): | |||
There was a problem hiding this comment.
Thanks for the test. Could you also add a release note? For example:
pip install --user reno
reno new add-show_default-from-context-support
|
Looks like you also need to run the linters. |
|
No activity on this for some time. This is now being addressed in #131. |
Closes #114
Core change
In
_get_help_recordfunction, added an argumentctxand added a variableshow_default.This is almost the same implementation as click's
_get_help_recordfunction