chore(deps): update dependency click to v8.2.1 #23
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==8.0.3
->==8.2.1
Warning
Some dependencies could not be looked up. Check the warning logs for more information.
Release Notes
pallets/click (Click)
v8.2.1
Compare Source
Released 2025-05-20
2894
:issue:
2897
:pr:2930
2906
:pr:2907
sys.stderr
at the end ofCliRunner.invoke
. :issue:2682
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 ofsetup.cfg
.:pr:
2438
Use
flit_core
instead ofsetuptools
as build backend. :pr:2543
Deprecate the
__version__
attribute. Use feature detection, orimportlib.metadata.version("click")
, instead. :issue:2598
BaseCommand
is deprecated.Command
is the base class for allcommands. :issue:
2589
MultiCommand
is deprecated.Group
is the base class for all groupcommands. :issue:
2590
The current parser and related classes and methods, are deprecated.
:issue:
2205
OptionParser
and theparser
module, which is a modified copy ofoptparse
in the standard library.Context.protected_args
is unneeded.Context.args
contains anyremaining arguments while parsing.
Parameter.add_to_parser
(on bothArgument
andOption
) isunneeded. Parsing works directly without building a separate parser.
split_arg_string
is moved fromparser
toshell_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
fortypes.Choice
options within--help
message ifshow_choices=False
is specified.:issue:
2356
Do not display default values in prompts when
Option.show_default
isFalse
. :pr:2509
Add
get_help_extra
method onOption
to fetch the generated extraitems used in
get_help_record
to render help text. :issue:2516
:pr:
2517
Keep stdout and stderr streams independent in
CliRunner
. Alwayscollect 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 inCliRunner
. :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 allContext.call_on_close
callbacks and context managers added viaContext.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 thesame name. :issue:
2396
When using
Option.envvar
withOption.flag_value
, theflag_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 theinvalid choice message. :issue:
2621
:pr:2622
If help is shown because
no_args_is_help
is enabled (defaults toTrue
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 usingclick.File
. :issue:2644
:pr:2800
:pr:
2767
click.edit(filename)
now supports passing an iterable of filenames incase the editor supports editing multiple files at once. Its return type
is now also typed:
AnyStr
iftext
is passed, otherwiseNone
.:issue:
2067
:pr:2068
Specialized typing of
progressbar(length=...)
asProgressBar[int]
.:pr:
2630
Improve
echo_via_pager
behaviour in face of errors.:issue:
2674
echo_via_pager
raises an exception.
to terminate.
echo_via_pager
will not ignoreKeyboardInterrupt
anymore. Thisallows 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. Thispreviously was only available for
Command
. The message can now also becustomised by using a
str
instead of abool
. :issue:2263
:pr:2271
Command.deprecated
formatting in--help
changed from(Deprecated) help
tohelp (DEPRECATED)
.Add a
catch_exceptions
parameter toCliRunner
. Ifcatch_exceptions
is not passed toCliRunner.invoke
, the valuefrom
CliRunner
is used. :issue:2817
:pr:2818
Option.flag_value
will no longer have a default value set based onOption.default
ifOption.is_flag
isFalse
. This results inOption.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
click.open_file()
. :issue:2717
click.Path
displays onmultiple lines. :issue:
2697
""
from being displayed inthe help for an option. :issue:
2500
:issue:
2705
default_map
.:issue:
2632
click.echo(color=...)
passingcolor
to coloroma so it can beforced on Windows. :issue:
2606
.:issue:
2638
help_option_names
setting torespect its eagerness. :pr:
2811
os.system
withsubprocess.Popen
. :issue:1476
color
setting when being displayed. :issue:
2193
:issue:
2452
--help
option to deduplicate code.:pr:
2563
CLIRunner
resets patched_compat.should_strip_ansi
.:issue:
2732
v8.1.7
Compare Source
Released 2023-08-17
2581
2574
2567
v8.1.6
Compare Source
Released 2023-07-18
@click.group()
. :issue:2558
v8.1.5
Compare Source
Released 2023-07-13
@click.command()
,@click.option()
, andother decorators. Introduce typing tests. :issue:
2558
v8.1.4
Compare Source
Released 2023-07-06
typing.Dict
occurrences totyping.MutableMapping
forparameter hints. :issue:
2255
:issue:
2398
shell_completion.add_completion_class
function. :pr:
2421
2461
.
) in the program name. :issue:2166
2268
click.clear()
. :issue:2284
2332
2368
fpath
. :issue:2344
.EOFError
andKeyboardInterrupt
tracebacks are not suppressed whenstandalone_mode
is disabled. :issue:2380
@group.command
does not fail if the group was created with a customcommand_class
. :issue:2416
multiple=True
is allowed for flag options again and does not requiresetting
default=()
. :issue:2246, 2292, 2295
@argument()
and@option()
reusable when thecls
parameter is used. :issue:2294
bytes with the replacement character (
�
). :issue:2395
2355
2554
echo()
does not fail when no streams are attached, such as withpythonw
onWindows. :issue:
2415
expose_value=False
do not cause completion to fail. :issue:2336
v8.1.3
Compare Source
Released 2022-04-28
typing.Callable
for@command
and@group
. :issue:2255
multiple=True, is_flag=True
. Usecount
instead.:issue:
2246
v8.1.2
Compare Source
Released 2022-03-31
executable check. :pr:
2236
Path
, placing theexecutable
parameter at the end. It is recommended to use keyword arguments
instead of positional arguments. :issue:
2235
v8.1.1
Compare Source
Released 2022-03-30
report that a command was not callable. :issue:
2227
v8.1.0
Compare Source
Released 2022-03-28
Drop support for Python 3.6. :pr:
2129
Remove previously deprecated code. :pr:
2130
Group.resultcallback
is renamed toresult_callback
.autocompletion
parameter toCommand
is renamed toshell_complete
.get_terminal_size
is removed, useshutil.get_terminal_size
instead.get_os_args
is removed, usesys.argv[1:]
instead.Rely on :pep:
538
and :pep:540
to handle selecting UTF-8 encodinginstead of ASCII. Click's locale encoding detection is removed.
:issue:
2198
Single options boolean flags with
show_default=True
only showthe default if it is
True
. :issue:1971
The
command
andgroup
decorators can be applied with orwithout parentheses. :issue:
1359
The
Path
type can check whether the target is executable.:issue:
1961
Command.show_default
overridesContext.show_default
, insteadof the other way around. :issue:
1963
Parameter decorators and
@group
handlescls=None
the same asnot passing
cls
.@option
handleshelp=None
the same asnot passing
help
. :issue:#1959
A flag option with
required=True
requires that the flag ispassed instead of choosing the implicit default value. :issue:
1978
Indentation in help text passed to
Option
andCommand
iscleaned the same as using the
@option
and@command
decorators does. A command's
epilog
andshort_help
are alsoprocessed. :issue:
1985
Store unprocessed
Command.help
,epilog
andshort_help
strings. Processing is only done when formatting help text for
output. :issue:
2149
Allow empty str input for
prompt()
whenconfirmation_prompt=True
anddefault=""
. :issue:2157
Windows glob pattern expansion doesn't fail if a value is an invalid
pattern. :issue:
2195
It's possible to pass a list of
params
to@command
. Anyparams defined with decorators are appended to the passed params.
:issue:
2131
.@command
decorator is annotated as returning the correct type ifa
cls
argument is used. :issue:2211
A
Group
withinvoke_without_command=True
andchain=False
will invoke its result callback with the group function's return
value. :issue:
2124
to_info_dict
will not fail if aParamType
doesn't define aname
. :issue:2168
Shell completion prioritizes option values with option prefixes over
new options. :issue:
2040
Options that get an environment variable value using
autoenvvar_prefix
treat an empty value asNone
, consistentwith a direct
envvar
. :issue:2146
v8.0.4
Compare Source
Released 2022-02-18
open_file
recognizesPath("-")
as a standard stream, thesame as the string
"-"
. :issue:2106
option
andargument
decorators preserve the typeannotation of the decorated function. :pr:
2155
__str__
instead of always showing(dynamic)
. :issue:2099
directory completion. If this script was generated by a previous
version, it should be regenerated. :issue:
2163
echo
andsecho
file argument.:issue:
2174, 2185
Configuration
📅 Schedule: Branch creation - "after 5am on saturday" (UTC), 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.
To execute skipped test pipelines write comment
/ok-to-test
.This PR has been generated by MintMaker (powered by Renovate Bot).