Update click to 8.4.1

[pyup-bot]

This PR updates click from 8.1.3 to 8.4.1.

Changelog

8.4.1

-------------

Released 2026-05-21

-   ``get_parameter_source()`` is available during eager callbacks and type
 conversion again. :issue:`3458` :issue:`3484`
-   Zsh completion scripts parse correctly on Windows. :issue:`3277` :pr:`3466`
-   Shell completion of `Choice` `Enum` values produces a valid completion
 result. :issue:`3015`
-   Fix empty byte-string handling in echo. :issue:`3487`
-   Fix closed file error with `echo_via_pager`. :issue:`3449`

8.4.0

-------------

Released 2026-05-17

-   :class:`ParamType` typing improvements. :pr:`3371`

 -   :class:`ParamType` is now a generic abstract base class,
     parameterized by its converted value type.
 -   :meth:`~ParamType.convert` return types are narrowed on all
     concrete types (``str`` for :class:`STRING`, ``int`` for
     :class:`INT`, etc.).
 -   :meth:`~ParamType.to_info_dict` returns specific
     :class:`~typing.TypedDict` subclasses instead of
     ``dict[str, Any]``.
 -   :class:`CompositeParamType` and the number-range base are now
     generic with abstract methods.
-   Refactor ``convert_type`` to extract type inference into a private
 ``_guess_type`` helper, and add :func:`typing.overload` signatures.
 :pr:`3372`
-   :class:`Parameter` typing improvements. :pr:`2805`

 -   :class:`Parameter` is now an abstract base class, making explicit
     that it cannot be instantiated directly.
 -   :attr:`Parameter.name` is now ``str`` instead of ``str | None``.
     When ``expose_value=False``, the name is set to ``""`` instead
     of ``None``.
 -   The ``ctx`` parameter of :meth:`Parameter.get_error_hint` is now
     typed as ``Context | None``, matching the runtime behavior.
-   Split string values from ``default_map`` for parameters with ``nargs > 1``
 or :class:`Tuple` type, matching environment variable behavior.
 :issue:`2745` :pr:`3364`
-   Auto-detect ``type=UNPROCESSED`` for ``flag_value`` of non-basic types
 (not ``str``, ``int``, ``float``, or ``bool``), so programmer-provided
 Python objects like classes and enum members are passed through unchanged
 instead of being stringified. Previously ``type=click.UNPROCESSED`` had
 to be set explicitly. :issue:`2012` :pr:`3363`
-   The error hint now uses :meth:`Command.get_help_option_names` to pick
 non-shadowed help option names, so ``Try '... -h'`` no longer points to a
 subcommand option that shadows ``-h``. The longest surviving name is
 shown (``--help`` over ``-h``) for readability. :issue:`2790` :pr:`3208`
-   Fix readline functionality on non-Windows platforms. Prompt text is now
 passed directly to readline instead of being printed separately, allowing
 proper backspace, line editing, and line wrapping behavior. :issue:`2968`
 :pr:`2969`
-   Use :func:`os.startfile` on Windows to open URLs in :func:`open_url`,
 replacing the ``start`` built-in which cannot be invoked without
 ``shell=True``. :issue:`3164` :pr:`3186`
-   Fix Fish shell completion errors when option help text contains newlines.
 :issue:`3043` :pr:`3126`
-   Add :class:`NoSuchCommand` exception with suggestions for misspelled
 commands. :issue:`3107` :pr:`3228`
-   Use :class:`ValueError` message when conversion in :class:`FuncParamType` would
 fail. :issue:`3105` :pr:`3211`
-   Add ``click.get_pager_file`` for file-like access to an output
 pager. :pr:`1572` :pr:`3405`
-   :func:`~click.formatting.wrap_text` now measures line width in visible
 characters, ignoring ANSI escape sequences. :pr:`3420`
-   Fix :meth:`HelpFormatter.write_usage` emitting only a blank line when
 called without ``args``. The usage prefix and program name are now
 written even when no arguments follow, and the trailing separator
 space is stripped so the line ends at the program name.
 :issue:`3360` :pr:`3434`
-   Show custom error messages from types when :func:`prompt` with
 ``hide_input=True`` fails validation, instead of always showing a
 generic message. Built-in type messages mask the input value.
 :issue:`2809` :pr:`3256`
-   Add ``capture`` parameter to :class:`CliRunner` with two modes: ``sys``
 (default) and ``fd``. ``fd`` redirects file descriptors ``1`` and ``2``
 via :func:`os.dup2` so output that bypasses ``sys.stdout`` (stale stream
 references, C extensions, subprocesses, ``faulthandler``) is captured
 with proper isolation. :issue:`854` :issue:`2412` :issue:`2468`
 :issue:`2497` :issue:`2761` :issue:`2827` :issue:`2865` :pr:`3391`
-   Revert the ``8.3.3`` change that exposed the original file descriptor
 via ``fileno()`` on the redirected ``CliRunner`` streams in the default
 capture mode. ``os.dup2(w, sys.stdout.fileno())`` calls inside a CLI no
 longer mutate the host runner's stdout, which broke Pytest's ``fd``-level
 capture teardown. C-level consumers that need a real ``fd`` should use
 ``capture="fd"``. :issue:`3384` :pr:`3391`
-   Mark additional built-in strings with ``gettext()`` to extend translation
 coverage. :pr:`2902`
-   Fix feature switch groups (several ``flag_value`` options sharing one
 parameter name) silently dropping an explicit ``default`` when a sibling
 option without an explicit default was declared first. Arbitration is now
 source-aware: a more explicit :class:`ParameterSource` always wins, and
 within ``ParameterSource.DEFAULT``, an option that received an explicit
 ``default=`` keyword wins over a sibling whose default was auto-derived.
 The 8.3.x first-wins fallback for remaining ties was reverted to the
 pre-8.3.x last-wins fallback. :issue:`3403` :pr:`3404`
-   Fix missing space between option help text and the ``(DEPRECATED)``
 label, and localize the option label so it matches the command label.
 The label and the ``DeprecationWarning`` reason suffix are now produced
 by shared helpers. :pr:`3423`
-   Document short option stacking (``-abc`` is parsed as ``-a -b -c``) and
 clarify that multi-character short option names are not supported.
 :issue:`2779` :pr:`3431`

8.3.3

-------------

Released 2026-04-20

-   Use :func:`shlex.split` to split pager and editor commands into ``argv``
 lists for :class:`subprocess.Popen`, removing ``shell=True``.
 :issue:`1026` :pr:`1477` :pr:`2775`
-   Fix ``TypeError`` when rendering help for an option whose default value is
 an object that doesn't support equality comparison with strings, such as
 ``semver.Version``. :issue:`3298` :pr:`3299`
-   Fix pager test pollution under parallel execution by using pytest's
 ``tmp_path`` fixture instead of a shared temporary file path. :pr:`3238`
-   Treat ``Sentinel.UNSET`` values in a ``default_map`` as absent, so they fall
 through to the next default source instead of being used as the value.
 :issue:`3224` :pr:`3240`
-   Patch ``pdb.Pdb`` in ``CliRunner`` isolation so ``pdb.set_trace()``,
 ``breakpoint()``, and debuggers subclassing ``pdb.Pdb`` (ipdb, pdbpp) can
 interact with the real terminal instead of the captured I/O streams.
 :issue:`654` :issue:`824` :issue:`843` :pr:`951` :pr:`3235`
-   Add optional randomized parallel test execution using ``pytest-randomly`` and
 ``pytest-xdist`` to detect test pollution and race conditions. :pr:`3151`
-   Add contributor documentation for running stress tests, randomized
 parallel tests, and Flask smoke tests. :pr:`3151` :pr:`3177`
-   Show custom ``show_default`` string in prompts, matching the existing
 help text behavior. :issue:`2836` :pr:`2837` :pr:`3165` :pr:`3262` :pr:`3280`
 :pr:`3328`
-   Fix ``default=True`` with boolean ``flag_value`` always returning the
 ``flag_value`` instead of ``True``. The ``default=True`` to ``flag_value``
 substitution now only applies to non-boolean flags, where ``True`` acts as a
 sentinel meaning "activate this flag by default". For boolean flags,
 ``default=True`` is returned as a literal value. :issue:`3111` :pr:`3239`
-   Mark ``make_default_short_help`` as private API. :issue:`3189` :pr:`3250`
-   ``CliRunner``'s redirected streams now expose the original file descriptor
 via ``fileno()``, so that ``faulthandler``, ``subprocess``, and other
 C-level consumers no longer crash with ``io.UnsupportedOperation``.
 :issue:`2865`
-   Change :class:`ParameterSource` to an :class:`~enum.IntEnum` and reorder
 its members from most to least explicit, so values can be compared to
 check whether a parameter was explicitly provided. :issue:`2879` :pr:`3248`

8.3.2

-------------

Released 2026-04-02

-   Fix handling of ``flag_value`` when ``is_flag=False`` to allow such options to be
 used without an explicit value. :issue:`3084` :pr:`3152`
-   Hide ``Sentinel.UNSET`` values as ``None`` when using ``lookup_default()``.
 :issue:`3136` :pr:`3199` :pr:`3202` :pr:`3209` :pr:`3212` :pr:`3224`
-   Prevent ``_NamedTextIOWrapper`` from closing streams owned by ``StreamMixer``.
 :issue:`824` :issue:`2991` :issue:`2993` :issue:`3110` :pr:`3139` :pr:`3140`
-   Add comprehensive tests for ``CliRunner`` stream lifecycle, covering
 logging interaction, multi-threaded safety, and sequential invocation
 isolation. Add high-iteration stress tests behind a ``stress`` marker
 with a dedicated CI job. :pr:`3139`
-   Fix callable ``flag_value`` being instantiated when used as a default via
 ``default=True``. :issue:`3121` :pr:`3201` :pr:`3213` :pr:`3225`

8.3.1

-------------

Released 2025-11-15

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

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`

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`

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`

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`

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`

8.1.7

-------------

Released 2023-08-17

-   Fix issue with regex flags in shell completion. :issue:`2581`
-   Bash version detection issues a warning instead of an error. :issue:`2574`
-   Fix issue with completion script for Fish shell. :issue:`2567`

8.1.6

-------------

Released 2023-07-18

-   Fix an issue with type hints for ``click.group()``. :issue:`2558`

8.1.5

-------------

Released 2023-07-13

-   Fix an issue with type hints for ``click.command()``, ``click.option()``, and
 other decorators. Introduce typing tests. :issue:`2558`

8.1.4

-------------

Released 2023-07-06

-   Replace all ``typing.Dict`` occurrences to ``typing.MutableMapping`` for
 parameter hints. :issue:`2255`
-   Improve type hinting for decorators and give all generic types parameters.
 :issue:`2398`
-   Fix return value and type signature of `shell_completion.add_completion_class`
 function. :pr:`2421`
-   Bash version detection doesn't fail on Windows. :issue:`2461`
-   Completion works if there is a dot (``.``) in the program name. :issue:`2166`
-   Improve type annotations for pyright type checker. :issue:`2268`
-   Improve responsiveness of ``click.clear()``. :issue:`2284`
-   Improve command name detection when using Shiv or PEX. :issue:`2332`
-   Avoid showing empty lines if command help text is empty. :issue:`2368`
-   ZSH completion script works when loaded from ``fpath``. :issue:`2344`.
-   ``EOFError`` and ``KeyboardInterrupt`` tracebacks are not suppressed when
 ``standalone_mode`` is disabled. :issue:`2380`
-   ``group.command`` does not fail if the group was created with a custom
 ``command_class``. :issue:`2416`
-   ``multiple=True`` is allowed for flag options again and does not require
 setting ``default=()``. :issue:`2246, 2292, 2295`
-   Make the decorators returned by ``argument()`` and ``option()`` reusable when the
 ``cls`` parameter is used. :issue:`2294`
-   Don't fail when writing filenames to streams with strict errors. Replace invalid
 bytes with the replacement character (``�``). :issue:`2395`
-   Remove unnecessary attempt to detect MSYS2 environment. :issue:`2355`
-   Remove outdated and unnecessary detection of App Engine environment. :pr:`2554`
-   ``echo()`` does not fail when no streams are attached, such as with ``pythonw`` on
 Windows. :issue:`2415`
-   Argument with ``expose_value=False`` do not cause completion to fail. :issue:`2336`

Links

• PyPI: https://pypi.org/project/click
• Changelog: https://data.safetycli.com/changelogs/click/

[pyup-bot]

Closing this in favor of #504

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud