chore(deps): update dependency click to v8.3.1 #13

Open
renovate-bot wants to merge 1 commit from renovate/click-8.x into master
Member

This PR contains the following updates:

Package Change Age Confidence
click (changelog) ==8.1.7 -> ==8.3.1 age confidence

Release Notes

pallets/click (click)

v8.3.1

Compare Source

This is the Click 8.3.1 fix release, which fixes bugs but does not otherwise change behavior and should not result in breaking changes compared to the latest feature release.

PyPI: https://pypi.org/project/click/8.3.1/
Changes: https://click.palletsprojects.com/page/changes/#version-8-3-1
Milestone: https://github.com/pallets/click/milestone/28

  • Don't discard pager arguments by correctly using subprocess.Popen. #​3039 #​3055
  • Replace Sentinel.UNSET default values by None as they're passed through the Context.invoke() method. #​3066 #​3065 #​3068
  • Fix conversion of Sentinel.UNSET happening too early, which caused incorrect behavior for multiple parameters using the same name. #​3071 #​3079
  • Fix rendering when prompt and confirm parameter prompt_suffix is empty. #​3019 #​3021
  • When Sentinel.UNSET is found during parsing, it will skip calls to type_cast_value. #​3069 #​3090
  • Hide Sentinel.UNSET values as None when looking up for other parameters through the context inside parameter callbacks. #​3136 #​3137

v8.3.0

Compare Source

Released 2025-09-17

  • Improved flag option handling: Reworked the relationship between flag_value
    and default parameters for better consistency:

    • The default parameter value is now preserved as-is and passed directly
      to CLI functions (no more unexpected transformations)
    • Exception: flag options with default=True maintain backward compatibility
      by defaulting to their flag_value
    • The default parameter can now be any type (bool, None, etc.)
    • Fixes inconsistencies reported in: :issue:1992 :issue:2514 :issue:2610
      :issue:3024 :pr:3030
  • Allow default to be set on Argument for nargs = -1. :issue:2164
    :pr:3030

  • Show correct auto complete value for nargs option in combination with flag
    option :issue:2813

  • Fix handling of quoted and escaped parameters in Fish autocompletion. :issue:2995 :pr:3013

  • Lazily import shutil. :pr:3023

  • Properly forward exception information to resources registered with
    click.core.Context.with_resource(). :issue:2447 :pr:3058

  • Fix regression related to EOF handling in CliRunner. :issue:2939 :pr:2940

v8.2.2

Compare Source

Released 2025-07-31

  • Fix reconciliation of default, flag_value and type parameters for
    flag options, as well as parsing and normalization of environment variables.
    :issue:2952 :pr:2956
  • Fix typing issue in BadParameter and MissingParameter exceptions for the
    parameter param_hint that did not allow for a sequence of string where the
    underlying function _join_param_hints allows for it. :issue:2777 :pr:2990
  • Use the value of Enum choices to render their default value in help
    screen. Refs :issue:2911 :pr:3004
  • Fix completion for the Z shell (zsh) for completion items containing
    colons. :issue:2703 :pr:2846
  • Don't include envvar in error hint when not configured. :issue:2971 :pr:2972
  • Fix a rare race in click.testing.StreamMixer's finalization that manifested
    as a ValueError on close in a multi-threaded test session.
    :issue:2993 :pr:2991

v8.2.1

Compare Source

Released 2025-05-20

  • Fix flag value handling for flag options with a provided type. :issue:2894
    :issue:2897 :pr:2930
  • Fix shell completion for nested groups. :issue:2906 :pr:2907
  • Flush sys.stderr at the end of CliRunner.invoke. :issue:2682
  • Fix EOF handling for stdin input in CliRunner. :issue:2787

v8.2.0

Compare Source

Released 2025-05-10

  • Drop support for Python 3.7, 3.8, and 3.9. :pr:2588 :pr:2893

  • Use modern packaging metadata with pyproject.toml instead of setup.cfg.
    :pr:2438

  • Use flit_core instead of setuptools as build backend. :pr:2543

  • Deprecate the __version__ attribute. Use feature detection, or
    importlib.metadata.version("click"), instead. :issue:2598

  • BaseCommand is deprecated. Command is the base class for all
    commands. :issue:2589

  • MultiCommand is deprecated. Group is the base class for all group
    commands. :issue:2590

  • The current parser and related classes and methods, are deprecated.
    :issue:2205

    • OptionParser and the parser module, which is a modified copy of
      optparse in the standard library.
    • Context.protected_args is unneeded. Context.args contains any
      remaining arguments while parsing.
    • Parameter.add_to_parser (on both Argument and Option) is
      unneeded. Parsing works directly without building a separate parser.
    • split_arg_string is moved from parser to shell_completion.
  • Enable deferred evaluation of annotations with
    from __future__ import annotations. :pr:2270

  • When generating a command's name from a decorated function's name, the
    suffixes _command, _cmd, _group, and _grp are removed.
    :issue:2322

  • Show the types.ParamType.name for types.Choice options within
    --help message if show_choices=False is specified.
    :issue:2356

  • Do not display default values in prompts when Option.show_default is
    False. :pr:2509

  • Add get_help_extra method on Option to fetch the generated extra
    items used in get_help_record to render help text. :issue:2516
    :pr:2517

  • Keep stdout and stderr streams independent in CliRunner. Always
    collect stderr output and never raise an exception. Add a new
    output stream to simulate what the user sees in its terminal. Removes
    the mix_stderr parameter in CliRunner. :issue:2522 :pr:2523

  • Option.show_envvar now also shows environment variable in error messages.
    :issue:2695 :pr:2696

  • Context.close will be called on exit. This results in all
    Context.call_on_close callbacks and context managers added via
    Context.with_resource to be closed on exit as well. :pr:2680

  • Add ProgressBar(hidden: bool) to allow hiding the progressbar. :issue:2609

  • A UserWarning will be shown when multiple parameters attempt to use the
    same name. :issue:2396

  • When using Option.envvar with Option.flag_value, the flag_value
    will always be used instead of the value of the environment variable.
    :issue:2746 :pr:2788

  • Add Choice.get_invalid_choice_message method for customizing the
    invalid choice message. :issue:2621 :pr:2622

  • If help is shown because no_args_is_help is enabled (defaults to True
    for groups, False for commands), the exit code is 2 instead of 0.
    :issue:1489 :pr:1489

  • Contexts created during shell completion are closed properly, fixing
    a ResourceWarning when using click.File. :issue:2644 :pr:2800
    :pr:2767

  • click.edit(filename) now supports passing an iterable of filenames in
    case the editor supports editing multiple files at once. Its return type
    is now also typed: AnyStr if text is passed, otherwise None.
    :issue:2067 :pr:2068

  • Specialized typing of progressbar(length=...) as ProgressBar[int].
    :pr:2630

  • Improve echo_via_pager behaviour in face of errors.
    :issue:2674

    • Terminate the pager in case a generator passed to echo_via_pager
      raises an exception.
    • Ensure to always close the pipe to the pager process and wait for it
      to terminate.
    • echo_via_pager will not ignore KeyboardInterrupt anymore. This
      allows the user to search for future output of the generator when
      using less and then aborting the program using ctrl-c.
  • deprecated: bool | str can now be used on options and arguments. This
    previously was only available for Command. The message can now also be
    customised by using a str instead of a bool. :issue:2263 :pr:2271

    • Command.deprecated formatting in --help changed from
      (Deprecated) help to help (DEPRECATED).
    • Parameters cannot be required nor prompted or an error is raised.
    • A warning will be printed when something deprecated is used.
  • Add a catch_exceptions parameter to CliRunner. If
    catch_exceptions is not passed to CliRunner.invoke, the value
    from CliRunner is used. :issue:2817 :pr:2818

  • Option.flag_value will no longer have a default value set based on
    Option.default if Option.is_flag is False. This results in
    Option.default not needing to implement __bool__. :pr:2829

  • Incorrect click.edit typing has been corrected. :pr:2804

  • Choice is now generic and supports any iterable value.
    This allows you to use enums and other non-str values. :pr:2796
    :issue:605

  • Fix setup of help option's defaults when using a custom class on its
    decorator. Removes HelpOption. :issue:2832 :pr:2840

v8.1.8

Compare Source

Released 2024-12-19

  • Fix an issue with type hints for click.open_file(). :issue:2717
  • Fix issue where error message for invalid click.Path displays on
    multiple lines. :issue:2697
  • Fixed issue that prevented a default value of "" from being displayed in
    the help for an option. :issue:2500
  • The test runner handles stripping color consistently on Windows.
    :issue:2705
  • Show correct value for flag default when using default_map.
    :issue:2632
  • Fix click.echo(color=...) passing color to coloroma so it can be
    forced on Windows. :issue:2606.
  • More robust bash version check, fixing problem on Windows with git-bash.
    :issue:2638
  • Cache the help option generated by the help_option_names setting to
    respect its eagerness. :pr:2811
  • Replace uses of os.system with subprocess.Popen. :issue:1476
  • Exceptions generated during a command will use the context's color
    setting when being displayed. :issue:2193
  • Error message when defining option with invalid name is more descriptive.
    :issue:2452
  • Refactor code generating default --help option to deduplicate code.
    :pr:2563
  • Test CLIRunner resets patched _compat.should_strip_ansi.
    :issue:2732

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [click](https://github.com/pallets/click) ([changelog](https://click.palletsprojects.com/page/changes/)) | `==8.1.7` -> `==8.3.1` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/click/8.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/click/8.1.7/8.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pallets/click (click)</summary> ### [`v8.3.1`](https://github.com/pallets/click/releases/tag/8.3.1) [Compare Source](https://github.com/pallets/click/compare/8.3.0...8.3.1) This is the Click 8.3.1 fix release, which fixes bugs but does not otherwise change behavior and should not result in breaking changes compared to the latest feature release. PyPI: <https://pypi.org/project/click/8.3.1/> Changes: <https://click.palletsprojects.com/page/changes/#version-8-3-1> Milestone: <https://github.com/pallets/click/milestone/28> - Don't discard pager arguments by correctly using `subprocess.Popen`. [#&#8203;3039](https://github.com/pallets/click/issues/3039) [#&#8203;3055](https://github.com/pallets/click/issues/3055) - Replace `Sentinel.UNSET` default values by `None` as they're passed through the `Context.invoke()` method. [#&#8203;3066](https://github.com/pallets/click/issues/3066) [#&#8203;3065](https://github.com/pallets/click/issues/3065) [#&#8203;3068](https://github.com/pallets/click/issues/3068) - Fix conversion of `Sentinel.UNSET` happening too early, which caused incorrect behavior for multiple parameters using the same name. [#&#8203;3071](https://github.com/pallets/click/issues/3071) [#&#8203;3079](https://github.com/pallets/click/issues/3079) - Fix rendering when `prompt` and `confirm` parameter `prompt_suffix` is empty. [#&#8203;3019](https://github.com/pallets/click/issues/3019) [#&#8203;3021](https://github.com/pallets/click/issues/3021) - When `Sentinel.UNSET` is found during parsing, it will skip calls to `type_cast_value`. [#&#8203;3069](https://github.com/pallets/click/issues/3069) [#&#8203;3090](https://github.com/pallets/click/issues/3090) - Hide `Sentinel.UNSET` values as `None` when looking up for other parameters through the context inside parameter callbacks. [#&#8203;3136](https://github.com/pallets/click/issues/3136) [#&#8203;3137](https://github.com/pallets/click/issues/3137) ### [`v8.3.0`](https://github.com/pallets/click/blob/HEAD/CHANGES.rst#Version-830) [Compare Source](https://github.com/pallets/click/compare/8.2.2...8.3.0) Released 2025-09-17 - **Improved flag option handling**: Reworked the relationship between `flag_value` and `default` parameters for better consistency: - The `default` parameter value is now preserved as-is and passed directly to CLI functions (no more unexpected transformations) - Exception: flag options with `default=True` maintain backward compatibility by defaulting to their `flag_value` - The `default` parameter can now be any type (`bool`, `None`, etc.) - Fixes inconsistencies reported in: :issue:`1992` :issue:`2514` :issue:`2610` :issue:`3024` :pr:`3030` - Allow `default` to be set on `Argument` for `nargs = -1`. :issue:`2164` :pr:`3030` - Show correct auto complete value for `nargs` option in combination with flag option :issue:`2813` - Fix handling of quoted and escaped parameters in Fish autocompletion. :issue:`2995` :pr:`3013` - Lazily import `shutil`. :pr:`3023` - Properly forward exception information to resources registered with `click.core.Context.with_resource()`. :issue:`2447` :pr:`3058` - Fix regression related to EOF handling in `CliRunner`. :issue:`2939` :pr:`2940` ### [`v8.2.2`](https://github.com/pallets/click/blob/HEAD/CHANGES.rst#Version-822) [Compare Source](https://github.com/pallets/click/compare/8.2.1...8.2.2) Released 2025-07-31 - Fix reconciliation of `default`, `flag_value` and `type` parameters for flag options, as well as parsing and normalization of environment variables. :issue:`2952` :pr:`2956` - Fix typing issue in `BadParameter` and `MissingParameter` exceptions for the parameter `param_hint` that did not allow for a sequence of string where the underlying function `_join_param_hints` allows for it. :issue:`2777` :pr:`2990` - Use the value of `Enum` choices to render their default value in help screen. Refs :issue:`2911` :pr:`3004` - Fix completion for the Z shell (`zsh`) for completion items containing colons. :issue:`2703` :pr:`2846` - Don't include envvar in error hint when not configured. :issue:`2971` :pr:`2972` - Fix a rare race in `click.testing.StreamMixer`'s finalization that manifested as a `ValueError` on close in a multi-threaded test session. :issue:`2993` :pr:`2991` ### [`v8.2.1`](https://github.com/pallets/click/blob/HEAD/CHANGES.rst#Version-821) [Compare Source](https://github.com/pallets/click/compare/8.2.0...8.2.1) Released 2025-05-20 - Fix flag value handling for flag options with a provided type. :issue:`2894` :issue:`2897` :pr:`2930` - Fix shell completion for nested groups. :issue:`2906` :pr:`2907` - Flush `sys.stderr` at the end of `CliRunner.invoke`. :issue:`2682` - Fix EOF handling for stdin input in CliRunner. :issue:`2787` ### [`v8.2.0`](https://github.com/pallets/click/blob/HEAD/CHANGES.rst#Version-820) [Compare Source](https://github.com/pallets/click/compare/8.1.8...8.2.0) Released 2025-05-10 - Drop support for Python 3.7, 3.8, and 3.9. :pr:`2588` :pr:`2893` - Use modern packaging metadata with `pyproject.toml` instead of `setup.cfg`. :pr:`2438` - Use `flit_core` instead of `setuptools` as build backend. :pr:`2543` - Deprecate the `__version__` attribute. Use feature detection, or `importlib.metadata.version("click")`, instead. :issue:`2598` - `BaseCommand` is deprecated. `Command` is the base class for all commands. :issue:`2589` - `MultiCommand` is deprecated. `Group` is the base class for all group commands. :issue:`2590` - The current parser and related classes and methods, are deprecated. :issue:`2205` - `OptionParser` and the `parser` module, which is a modified copy of `optparse` in the standard library. - `Context.protected_args` is unneeded. `Context.args` contains any remaining arguments while parsing. - `Parameter.add_to_parser` (on both `Argument` and `Option`) is unneeded. Parsing works directly without building a separate parser. - `split_arg_string` is moved from `parser` to `shell_completion`. - Enable deferred evaluation of annotations with `from __future__ import annotations`. :pr:`2270` - When generating a command's name from a decorated function's name, the suffixes `_command`, `_cmd`, `_group`, and `_grp` are removed. :issue:`2322` - Show the `types.ParamType.name` for `types.Choice` options within `--help` message if `show_choices=False` is specified. :issue:`2356` - Do not display default values in prompts when `Option.show_default` is `False`. :pr:`2509` - Add `get_help_extra` method on `Option` to fetch the generated extra items used in `get_help_record` to render help text. :issue:`2516` :pr:`2517` - Keep stdout and stderr streams independent in `CliRunner`. Always collect stderr output and never raise an exception. Add a new output stream to simulate what the user sees in its terminal. Removes the `mix_stderr` parameter in `CliRunner`. :issue:`2522` :pr:`2523` - `Option.show_envvar` now also shows environment variable in error messages. :issue:`2695` :pr:`2696` - `Context.close` will be called on exit. This results in all `Context.call_on_close` callbacks and context managers added via `Context.with_resource` to be closed on exit as well. :pr:`2680` - Add `ProgressBar(hidden: bool)` to allow hiding the progressbar. :issue:`2609` - A `UserWarning` will be shown when multiple parameters attempt to use the same name. :issue:`2396` - When using `Option.envvar` with `Option.flag_value`, the `flag_value` will always be used instead of the value of the environment variable. :issue:`2746` :pr:`2788` - Add `Choice.get_invalid_choice_message` method for customizing the invalid choice message. :issue:`2621` :pr:`2622` - If help is shown because `no_args_is_help` is enabled (defaults to `True` for groups, `False` for commands), the exit code is 2 instead of 0. :issue:`1489` :pr:`1489` - Contexts created during shell completion are closed properly, fixing a `ResourceWarning` when using `click.File`. :issue:`2644` :pr:`2800` :pr:`2767` - `click.edit(filename)` now supports passing an iterable of filenames in case the editor supports editing multiple files at once. Its return type is now also typed: `AnyStr` if `text` is passed, otherwise `None`. :issue:`2067` :pr:`2068` - Specialized typing of `progressbar(length=...)` as `ProgressBar[int]`. :pr:`2630` - Improve `echo_via_pager` behaviour in face of errors. :issue:`2674` - Terminate the pager in case a generator passed to `echo_via_pager` raises an exception. - Ensure to always close the pipe to the pager process and wait for it to terminate. - `echo_via_pager` will not ignore `KeyboardInterrupt` anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - `deprecated: bool | str` can now be used on options and arguments. This previously was only available for `Command`. The message can now also be customised by using a `str` instead of a `bool`. :issue:`2263` :pr:`2271` - `Command.deprecated` formatting in `--help` changed from `(Deprecated) help` to `help (DEPRECATED)`. - Parameters cannot be required nor prompted or an error is raised. - A warning will be printed when something deprecated is used. - Add a `catch_exceptions` parameter to `CliRunner`. If `catch_exceptions` is not passed to `CliRunner.invoke`, the value from `CliRunner` is used. :issue:`2817` :pr:`2818` - `Option.flag_value` will no longer have a default value set based on `Option.default` if `Option.is_flag` is `False`. This results in `Option.default` not needing to implement `__bool__`. :pr:`2829` - Incorrect `click.edit` typing has been corrected. :pr:`2804` - `Choice` is now generic and supports any iterable value. This allows you to use enums and other non-`str` values. :pr:`2796` :issue:`605` - Fix setup of help option's defaults when using a custom class on its decorator. Removes `HelpOption`. :issue:`2832` :pr:`2840` ### [`v8.1.8`](https://github.com/pallets/click/blob/HEAD/CHANGES.rst#Version-818) [Compare Source](https://github.com/pallets/click/compare/8.1.7...8.1.8) Released 2024-12-19 - Fix an issue with type hints for `click.open_file()`. :issue:`2717` - Fix issue where error message for invalid `click.Path` displays on multiple lines. :issue:`2697` - Fixed issue that prevented a default value of `""` from being displayed in the help for an option. :issue:`2500` - The test runner handles stripping color consistently on Windows. :issue:`2705` - Show correct value for flag default when using `default_map`. :issue:`2632` - Fix `click.echo(color=...)` passing `color` to coloroma so it can be forced on Windows. :issue:`2606`. - More robust bash version check, fixing problem on Windows with git-bash. :issue:`2638` - Cache the help option generated by the `help_option_names` setting to respect its eagerness. :pr:`2811` - Replace uses of `os.system` with `subprocess.Popen`. :issue:`1476` - Exceptions generated during a command will use the context's `color` setting when being displayed. :issue:`2193` - Error message when defining option with invalid name is more descriptive. :issue:`2452` - Refactor code generating default `--help` option to deduplicate code. :pr:`2563` - Test `CLIRunner` resets patched `_compat.should_strip_ansi`. :issue:`2732` </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNzEuMiIsInVwZGF0ZWRJblZlciI6IjQyLjExLjAiLCJ0YXJnZXRCcmFuY2giOiJtYXN0ZXIiLCJsYWJlbHMiOlsicmVub3ZhdGUtYm90Il19-->
renovate-bot changed title from chore(deps): update dependency click to v8.1.8 to chore(deps): update dependency click to v8.2.0 2025-05-12 05:24:17 +05:30
renovate-bot force-pushed renovate/click-8.x from 336ea31a3b to f68f087ace 2025-05-12 05:24:18 +05:30 Compare
renovate-bot changed title from chore(deps): update dependency click to v8.2.0 to chore(deps): update dependency click to v8.2.1 2025-05-26 05:18:14 +05:30
renovate-bot force-pushed renovate/click-8.x from f68f087ace to 69c483b623 2025-05-26 05:18:14 +05:30 Compare
renovate-bot changed title from chore(deps): update dependency click to v8.2.1 to chore(deps): update dependency click to v8.3.0 2025-09-22 05:15:30 +05:30
renovate-bot force-pushed renovate/click-8.x from 69c483b623 to a0ec873b8c 2025-09-22 05:15:32 +05:30 Compare
renovate-bot changed title from chore(deps): update dependency click to v8.3.0 to chore(deps): update dependency click to v8.3.1 2025-11-17 05:28:49 +05:30
renovate-bot force-pushed renovate/click-8.x from a0ec873b8c to a4480a7e42 2025-11-17 05:28:51 +05:30 Compare
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin renovate/click-8.x:renovate/click-8.x
git switch renovate/click-8.x

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch master
git merge --no-ff renovate/click-8.x
git switch renovate/click-8.x
git rebase master
git switch master
git merge --ff-only renovate/click-8.x
git switch renovate/click-8.x
git rebase master
git switch master
git merge --no-ff renovate/click-8.x
git switch master
git merge --squash renovate/click-8.x
git switch master
git merge --ff-only renovate/click-8.x
git switch master
git merge renovate/click-8.x
git push origin master
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
mCaptcha/examples!13
No description provided.