Releases: pallets/click
8.2.1
This is the Click 8.2.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.2.1/
Changes: https://click.palletsprojects.com/page/changes/#version-8-2-1
Milestone: https://github.com/pallets/click/milestone/24?closed=1
8.2.0
This is the Click 8.2.0 feature release. A feature release may include new features, remove previously deprecated code, add new deprecation, or introduce potentially breaking changes.
We encourage everyone to upgrade. You can read more about our Version Support Policy on our website.
PyPI: https://pypi.org/project/click/8.2.0/
Changes: https://click.palletsprojects.com/en/stable/changes/
Milestone https://github.com/pallets/click/milestone/15
- Drop support for Python 3.7, 3.8,and 3.9. #2588, #2893
- Use modern packaging metadata with
pyproject.tomlinstead ofsetup.cfg. #2438 - Use
flit_coreinstead ofsetuptoolsas build backend. #2543 - Deprecate the
__version__attribute. Use feature detection, orimportlib.metadata.version("click"), instead. #2598 BaseCommandis deprecated.Commandis the base class for all commands. #2589MultiCommandis deprecated.Groupis the base class for all group commands. #2590- The current parser and related classes and methods, are deprecated.
#2205OptionParserand theparsermodule, which is a modified copy ofoptparsein the standard library.Context.protected_argsis unneeded.Context.argscontains any remaining arguments while parsing.Parameter.add_to_parser(on bothArgumentandOption) is unneeded. Parsing works directly without building a separate parser.split_arg_stringis moved fromparsertoshell_completion.
- Enable deferred evaluation of annotations with
from __future__ import annotations. #2270 - When generating a command's name from a decorated function's name, the suffixes
_command,_cmd,_group, and_grpare removed. #2322 - Show the
types.ParamType.namefortypes.Choiceoptions within--helpmessage ifshow_choices=Falseis specified. #2356 - Do not display default values in prompts when
Option.show_defaultisFalse. #2509 - Add
get_help_extramethod onOptionto fetch the generated extra items used inget_help_recordto render help text. #2516 #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 themix_stderrparameter inCliRunner. #2522 #2523 Option.show_envvarnow also shows environment variable in error messages. #2695 #2696Context.closewill be called on exit. This results in allContext.call_on_closecallbacks and context managers added viaContext.with_resourceto be closed on exit as well. #2680- Add
ProgressBar(hidden: bool)to allow hiding the progressbar. #2609 - A
UserWarningwill be shown when multiple parameters attempt to use the same name. #2396 - When using
Option.envvarwithOption.flag_value, theflag_valuewill always be used instead of the value of the environment variable. #2746 #2788 - Add
Choice.get_invalid_choice_messagemethod for customizing the invalid choice message. #2621 #2622 - If help is shown because
no_args_is_helpis enabled (defaults toTruefor groups,Falsefor commands), the exit code is 2 instead of 0. #1489 #1489 - Contexts created during shell completion are closed properly, fixing a
ResourceWarningwhen usingclick.File. #2644 #2800 #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:AnyStriftextis passed, otherwiseNone. #2067 #2068- Specialized typing of
progressbar(length=...)asProgressBar[int]. #2630 - Improve
echo_via_pagerbehaviour in face of errors. #2674- Terminate the pager in case a generator passed to
echo_via_pagerraises an exception. - Ensure to always close the pipe to the pager process and wait for it to terminate.
echo_via_pagerwill not ignoreKeyboardInterruptanymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c.
- Terminate the pager in case a generator passed to
deprecated: bool | strcan now be used on options and arguments. This previously was only available forCommand. The message can now also be customised by using astrinstead of abool. #2263 #2271Command.deprecatedformatting in--helpchanged from(Deprecated) helptohelp (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_exceptionsparameter toCliRunner. Ifcatch_exceptionsis not passed toCliRunner.invoke, the value fromCliRunneris used. #2817 #2818 Option.flag_valuewill no longer have a default value set based onOption.defaultifOption.is_flagisFalse. This results inOption.defaultnot needing to implement__bool__. #2829- Incorrect
click.edittyping has been corrected. #2804 Choiceis now generic and supports any iterable value. This allows you to use enums and other non-strvalues. #2796 #605- Remove
click.HelpOptionthat was introduced in 8.1.8 due to api incompatibility. #2832
Please remember, applications must lock their full dependency tree to control when updates are installed and ensure reproducible deployments. Use one of the various project management or lock tools available in the Python ecosystem. Test with warnings treated as errors to be able to adapt to deprecation warnings early.
8.1.8
934813eThis is the Click 8.1.8 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.1.8/
Changes: https://click.palletsprojects.com/en/stable/changes/#version-8-1-8
Milestone https://github.com/pallets/click/milestones/23?closed=1
- Fix an issue with type hints for
click.open_file(). #2717 - Fix issue where error message for invalid
click.Pathdisplays on
multiple lines. #2697 - Fixed issue that prevented a default value of
""from being displayed in
the help for an option. #2500 - The test runner handles stripping color consistently on Windows. #2705
- Show correct value for flag default when using
default_map. #2632 - Fix
click.echo(color=...)passingcolorto coloroma so it can be
forced on Windows. #2606. - More robust bash version check, fixing problem on Windows with git-bash. #2638
- Cache the help option generated by the
help_option_namessetting to
respect its eagerness. #2811 - Replace uses of
os.systemwithsubprocess.Popen. #1476 - Exceptions generated during a command will use the context's
color
setting when being displayed. #2193 - Error message when defining option with invalid name is more descriptive. #2452
- Refactor code generating default
--helpoption to deduplicate code. #2563 - Test
CLIRunnerresets patched_compat.should_strip_ansi. #2732
8.1.7
This is a fix release for the 8.1.x feature branch.
8.1.6
This is a fix release for the 8.1.x feature branch. If you were having issues with type checking tools like pyright or mypy not accepting uses of Click's decorators, this should fix that.
8.1.5
This is a fix release for the 8.1.x feature branch. This fixes an issue with decorator type annotations that caused type checkers to fail for valid code. There are no runtime behavior changes.
8.1.4
This is a fix release for the 8.1.x feature branch.
8.1.3
This is a fix release for the 8.1.0 feature release.
8.1.2
This is a fix release for the 8.1.0 feature release.
8.1.1
This is a fix release for the 8.1.0 feature release.