click

This is the Click 8.4.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.4.2/
Changes: https://click.palletsprojects.com/page/changes/#version-8-4-2
Milestone: https://github.com/pallets/click/milestone/34

• Fix Fish shell completion broken in 8.4.0 by #3126. Newlines and
  tabs in option help text are now escaped, keeping the original completion
  format while still supporting multi-line help. #3502
  #3043 #3504 #3508
• Deprecated commands and options with empty or missing help text no longer
  render a stray leading space before the (DEPRECATED) label. #3509
• A {class}Group with invoke_without_command=True marks its subcommand as
  optional in the usage help, showing [COMMAND] instead of COMMAND.
  #3059 #3507
• echo_via_pager flushes after each write, so passing a generator streams
  output to the pager incrementally instead of staying hidden until the pipe
  buffer fills. #3242 #2542 #3534
• echo_via_pager and get_pager_file no longer close a borrowed stdout
  stream when no external pager runs, completing the partial
  I/O operation on closed file fix from #3482. #3449
  #3533
• Fix CLI usage symopsis for optional arguments producing double square brackets
  [[a|b|c]]... whose type already brackets their metavar. #3578
• {func}version_option resolves a package_name that does not match an
  installed distribution as an import (top-level module) name via
  {func}importlib.metadata.packages_distributions. Packages whose
  top-level module name differs from their distribution name (PIL vs
  Pillow, jwt vs PyJWT) no longer raise RuntimeError out of the
  box. #2331 #1884 #3125 #3582

This is the Click 8.4.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.4.1/
Changes: https://click.palletsprojects.com/page/changes/#version-8-4-1
Milestone: https://github.com/pallets/click/milestone/32

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

This is the Click 8.4.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.4.0/
Changes: https://click.palletsprojects.com/page/changes/#version-8-4-0
Milestone https://github.com/pallets/click/milestone/30

• ParamType typing improvements. #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.
  #3372

• Parameter typing improvements. #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.
  #2745 #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. #2012 #3363

• The error hint now uses 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. All surviving names are shown
  (-h/--help). #2790 #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. #2968
  #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. #3164 #3186

• Fix Fish shell completion errors when option help text contains newlines.
  #3043 #3126

• Add :class:NoSuchCommand exception with suggestions for misspelled
  commands. #3107 #3228

• Use :class:ValueError message when conversion in :class:FuncParamType would
  fail. #3105 #3211

• Add click.get_pager_file for file-like access to an output
  pager. #1572 #3405

• :class:~click.formatting.TextWrapper and
  :func:~click.formatting.wrap_text now measure line width in visible
  characters, ignoring ANSI escape sequences. #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.
  #3360 #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.
  #2809 #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. #854 #2412 #2468
  #2497 #2761 #2827 #2865

• 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". #3384 #3391

• Mark additional built-in strings with gettext() to extend translation
  coverage. #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. #3403 #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. #3423

• Document short option stacking (-abc is parsed as -a -b -c) and
  clarify that multi-character short option names are not supported.
  #2779 #3431

This is the Click 8.3.3 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.3/
Changes: https://click.palletsprojects.com/page/changes/#version-8-3-3
Milestone: https://github.com/pallets/click/milestone/30

• Use :func:shlex.split to split pager and editor commands into argv
  lists for :class:subprocess.Popen, removing shell=True.
  #1026 #1477 #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. #3298 #3299
• Fix pager test pollution under parallel execution by using pytest's
  tmp_path fixture instead of a shared temporary file path. #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.
  #3224 #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.
  #654 #824 #843 #951 #3235
• Add optional randomized parallel test execution using pytest-randomly and
  pytest-xdist to detect test pollution and race conditions. #3151
• Add contributor documentation for running stress tests, randomized
  parallel tests, and Flask smoke tests. #3151 #3177
• Show custom show_default string in prompts, matching the existing
  help text behavior. #2836 #2837 #3165 #3262 #3280
  #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. #3111 #3239
• Mark make_default_short_help as private API. #3189 #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.
  #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. #2879 #3248

This is the Click 8.3.2 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.2/
Changes: https://click.palletsprojects.com/page/changes/#version-8-3-2
Milestone: https://github.com/pallets/click/milestone/29

• Fix handling of flag_value when is_flag=False to allow such options to be
  used without an explicit value. #3084 #3152
• Hide Sentinel.UNSET values as None when using lookup_default().
  #3136 #3199 #3202 #3209 #3212 #3224
• Prevent _NamedTextIOWrapper from closing streams owned by StreamMixer.
  #824 #2991 #2993 #3110 #3139 #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. #3139
• Fix callable flag_value being instantiated when used as a default via
  default=True. #3121 #3201 #3213 #3225

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

This is the Click 8.3.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.3.0/
Changes: https://click.palletsprojects.com/page/changes/#version-8-3-0
Milestone https://github.com/pallets/click/milestone/27

• 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: #1992 #2514 #2610
    #3024 #3030

• Allow default to be set on Argument for nargs = -1. #2164
  #3030

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

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

• Fix handling of quoted and escaped parameters in Fish autocompletion. #2995 #3013

• Lazily import shutil. #3023

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

• Fix regression related to EOF handling in CliRunner. #2939 #2940

This is the Click 8.2.2 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.2/
Changes: https://click.palletsprojects.com/page/changes/#version-8-2-2
Milestone: https://github.com/pallets/click/milestone/25

• Fix reconciliation of default, flag_value and type parameters for
  flag options, as well as parsing and normalization of environment variables.
  #2952 #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 functino _join_param_hints allows for it. #2777 #2990
• Use the value of Enum choices to render their default value in help
  screen. #2911 #3004
• Fix completion for the Z shell (zsh) for completion items containing
  colons. #2703 #2846
• Don't include envvar in error hint when not configured. #2971 #2972
• Fix a rare race in click.testing.StreamMixer's finalization that manifested
  as a ValueError on close in a multi-threaded test session.
  #2993 #2991

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

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

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.toml instead of setup.cfg. #2438
• Use flit_core instead of setuptools as build backend. #2543
• Deprecate the __version__ attribute. Use feature detection, or importlib.metadata.version("click"), instead. #2598
• BaseCommand is deprecated. Command is the base class for all commands. #2589
• MultiCommand is deprecated. Group is the base class for all group commands. #2590
• The current parser and related classes and methods, are deprecated. #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. #2270
• When generating a command's name from a decorated function's name, the suffixes _command, _cmd, _group, and _grp are removed. #2322
• Show the types.ParamType.name for types.Choice options within --help message if show_choices=False is specified. #2356
• Do not display default values in prompts when Option.show_default is False. #2509
• Add get_help_extra method on Option to fetch the generated extra items used in get_help_record to 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 the mix_stderr parameter in CliRunner. #2522 #2523
• Option.show_envvar now also shows environment variable in error messages. #2695 #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. #2680
• Add ProgressBar(hidden: bool) to allow hiding the progressbar. #2609
• A UserWarning will be shown when multiple parameters attempt to use the same name. #2396
• When using Option.envvar with Option.flag_value, the flag_value will always be used instead of the value of the environment variable. #2746 #2788
• Add Choice.get_invalid_choice_message method for customizing the invalid choice message. #2621 #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. #1489 #1489
• Contexts created during shell completion are closed properly, fixing a ResourceWarning when using click.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: AnyStr if text is passed, otherwise None. #2067 #2068
• Specialized typing of progressbar(length=...) as ProgressBar[int]. #2630
• Improve echo_via_pager behaviour in face of errors. #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. #2263 #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. #2817 #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__. #2829
• Incorrect click.edit typing has been corrected. #2804
• Choice is now generic and supports any iterable value. This allows you to use enums and other non-str values. #2796 #605
• Remove click.HelpOption that 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.

This 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.Path displays 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=...) passing color to 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_names setting to respect its eagerness. #2811
• Replace uses of os.system with subprocess.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 --help option to deduplicate code. #2563
• Test CLIRunner resets patched _compat.should_strip_ansi. #2732

This is a fix release for the 8.1.x feature branch.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-7
• Milestone: https://github.com/pallets/click/milestone/22?closed=1

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.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-6
• Milestone: https://github.com/pallets/click/milestone/21?closed=1

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.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-5
• Milestone: https://github.com/pallets/click/milestone/20?closed=1

This is a fix release for the 8.1.x feature branch.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-4
• Milestone: https://github.com/pallets/click/milestone/19?closed=1

This is a fix release for the 8.1.0 feature release.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-3
• Milestone: https://github.com/pallets/click/milestone/18?closed=1

This is a fix release for the 8.1.0 feature release.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-2
• Milestone: https://github.com/pallets/click/milestone/17?closed=1

This is a fix release for the 8.1.0 feature release.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-1
• Milestone: https://github.com/pallets/click/milestone/14?closed=1

This is a feature release, which includes new features and removes previously deprecated features. The 8.1.x branch is now the supported bugfix branch, the 8.0.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades.

• Changes: https://click.palletsprojects.com/en/8.1.x/changes/#version-8-1-0
• Milestone: https://github.com/pallets/click/milestone/9?closed=1

• Changes: https://click.palletsprojects.com/en/8.0.x/changes/#version-8-0-4
• Milestone: https://github.com/pallets/click/milestone/13?closed=1

• Changes: https://click.palletsprojects.com/en/8.0.x/changes/#version-8-0-3

• Changes: https://click.palletsprojects.com/en/8.0.x/changes/#version-8-0-2

• Changes: https://click.palletsprojects.com/en/8.0.x/changes/#version-8-0-1

New major versions of all the core Pallets libraries, including Click 8.0, have been released! :tada:

• Read the announcement on our blog: https://palletsprojects.com/blog/flask-2-0-released/
• Read the full list of changes: https://click.palletsprojects.com/changes/#version-8-0-0
• Retweet the announcement on Twitter: https://twitter.com/PalletsTeam/status/1392266507296514048
• Follow our blog, Twitter, or GitHub to see future announcements.

This represents a significant amount of work, and there are quite a few changes. Be sure to carefully read the changelog, and use tools such as pip-compile and Dependabot to pin your dependencies and control your updates.

• Changes: https://click.palletsprojects.com/en/master/changes/#version-8-0

• Changes: https://click.palletsprojects.com/en/master/changelog/#version-8-0

• Changes: https://click.palletsprojects.com/en/7.x/changelog/#version-7-1-2

• Changes: https://click.palletsprojects.com/en/7.x/changelog/#version-7-1-1
• Blog: https://palletsprojects.com/blog/click-7-1-released/
• Twitter: https://twitter.com/PalletsTeam/status/1237090317838340099

• Changes: https://click.palletsprojects.com/en/7.x/changelog/#version-7-1
• Blog: https://palletsprojects.com/blog/click-7-1-released/
• Twitter: https://twitter.com/PalletsTeam/status/1237090317838340099

Released 2018-09-25

• Drop support for Python 2.6 and 3.3. {pr}967, 976
• Wrap click.Choice's missing message. {issue}202, {pr}1000
• Add native ZSH autocompletion support. {issue}323, {pr}865
• Document that ANSI color info isn't parsed from bytearrays in Python 2. {issue}334
• Document byte-stripping behavior of CliRunner. {issue}334, {pr}1010
• Usage errors now hint at the --help option. {issue}393, {pr}557
• Implement streaming pager. {issue}409, {pr}889
• Extract bar formatting to its own method. {pr}414
• Add DateTime type for converting input in given date time formats. {pr}423
• secho's first argument can now be None, like in echo. {pr}424
• Fixes a ZeroDivisionError in ProgressBar.make_step, when the arg passed to the first call of ProgressBar.update is 0. {issue}447, {pr}1012
• Show progressbar only if total execution time is visible. {pr}487
• Added the ability to hide commands and options from help. {pr}500
• Document that options can be required=True. {issue}514, {pr}1022
• Non-standalone calls to Context.exit return the exit code, rather than calling sys.exit. {issue}667, {pr}533, 1098
• click.getchar() returns Unicode in Python 3 on Windows, consistent with other platforms. {issue}537, 821, 822, 1088, {pr}1108
• Added FloatRange type. {pr}538, 553
• Added support for bash completion of type=click.Choice for Options and Arguments. {issue}535, {pr}681
• Only allow one positional arg for Argument parameter declaration. {issue}568, 574, {pr}1014
• Add case_sensitive=False as an option to Choice. {issue}569
• click.getchar() correctly raises KeyboardInterrupt on "^C" and EOFError on "^D" on Linux. {issue}583, {pr}1115
• Fix encoding issue with click.getchar(echo=True) on Linux. {pr}1115
• param_hint in errors now derived from param itself. {issue}598, 704, {pr}709
• Add a test that ensures that when an argument is formatted into a usage error, its metavar is used, not its name. {pr}612
• Allow setting prog_name as extra in CliRunner.invoke. {issue}616, {pr}999
• Help text taken from docstrings truncates at the \f form feed character, useful for hiding Sphinx-style parameter documentation. {pr}629, 1091
• launch now works properly under Cygwin. {pr}650
• Update progress after iteration. {issue}651, {pr}706
• CliRunner.invoke now may receive args as a string representing a Unix shell command. {pr}664
• Make Argument.make_metavar() default to type metavar. {pr}675
• Add documentation for ignore_unknown_options. {pr}684
• Add bright colors support for click.style and fix the reset option for parameters fg and bg. {issue}703, {pr}809
• Add show_envvar for showing environment variables in help. {pr}710
• Avoid BrokenPipeError during interpreter shutdown when stdout or stderr is a closed pipe. {issue}712, {pr}1106
• Document customizing option names. {issue}725, {pr}1016
• Disable sys._getframes() on Python interpreters that don't support it. {pr}728
• Fix bug in test runner when calling sys.exit with None. {pr}739
• Clarify documentation on command line options. {issue}741, {pr}1003
• Fix crash on Windows console. {issue}744
• Fix bug that caused bash completion to give improper completions on chained commands. {issue}754, {pr}774
• Added support for dynamic bash completion from a user-supplied callback. {pr}755
• Added support for bash completions containing spaces. {pr}773
• Allow autocompletion function to determine whether or not to return completions that start with the incomplete argument. {issue}790, {pr}806
• Fix option naming routine to match documentation and be deterministic. {issue}793, {pr}794
• Fix path validation bug. {issue}795, {pr}1020
• Add test and documentation for Option naming: functionality. {pr}799
• Update doc to match arg name for path_type. {pr}801
• Raw strings added so correct escaping occurs. {pr}807
• Fix 16k character limit of click.echo on Windows. {issue}816, {pr}819
• Overcome 64k character limit when writing to binary stream on Windows 7. {issue}825, {pr}830
• Add bool conversion for "t" and "f". {pr}842
• NoSuchOption errors take ctx so that --help hint gets printed in error output. {pr}860
• Fixed the behavior of Click error messages with regards to Unicode on 2.x and 3.x. Message is now always Unicode and the str and Unicode special methods work as you expect on that platform. {issue}862
• Progress bar now uses stderr by default. {pr}863
• Add support for auto-completion documentation. {issue}866, {pr}869
• Allow CliRunner to separate stdout and stderr. {pr}868
• Fix variable precedence. {issue}873, {pr}874
• Fix invalid escape sequences. {pr}877
• Fix ResourceWarning that occurs during some tests. {pr}878
• When detecting a misconfigured locale, don't fail if the locale command fails. {pr}880
• Add case_sensitive=False as an option to Choice types. {pr}887
• Force stdout/stderr writable. This works around issues with badly patched standard streams like those from Jupyter. {pr}918
• Fix completion of subcommand options after last argument {issue}919, {pr}930
• _AtomicFile now uses the realpath of the original filename so that changing the working directory does not affect it. {pr}920
• Fix incorrect completions when defaults are present {issue}925, {pr}930
• Add copy option attrs so that custom classes can be reused. {issue}926, {pr}994
• "x" and "a" file modes now use stdout when file is "-". {pr}929
• Fix missing comma in __all__ list. {pr}935
• Clarify how parameters are named. {issue}949, {pr}1009
• Stdout is now automatically set to non blocking. {pr}954
• Do not set options twice. {pr}962
• Move fcntl import. {pr}965
• Fix Google App Engine ImportError. {pr}995
• Better handling of help text for dynamic default option values. {pr}996
• Fix get_winter_size() so it correctly returns (0,0). {pr}997
• Add test case checking for custom param type. {pr}1001
• Allow short width to address cmd formatting. {pr}1002
• Add details about Python version support. {pr}1004
• Added deprecation flag to commands. {pr}1005
• Fixed issues where fd was undefined. {pr}1007
• Fix formatting for short help. {pr}1008
• Document how auto_envvar_prefix works with command groups. {pr}1011
• Don't add newlines by default for progress bars. {pr}1013
• Use Python sorting order for ZSH completions. {issue}1047, {pr}1059
• Document that parameter names are converted to lowercase by default. {pr}1055
• Subcommands that are named by the function now automatically have the underscore replaced with a dash. If you register a function named my_command it becomes my-command in the command line interface.
• Hide hidden commands and options from completion. {issue}1058, {pr}1061
• Fix absolute import blocking Click from being vendored into a project on Windows. {issue}1068, {pr}1069
• Fix issue where a lowercase auto_envvar_prefix would not be converted to uppercase. {pr}1105

Released 2017-01-06

• Make click.progressbar work with codecs.open files. {pr}637
• Fix bug in bash completion with nested subcommands. {pr}639
• Fix test runner not saving caller env correctly. {pr}644
• Fix handling of SIGPIPE. {pr}62
• Deal with broken Windows environments such as Google App Engine's. {issue}711

Released 2016-04-04

• Fix bug in click.Path where it would crash when passed a -. {issue}551

Released 2016-03-24

• Fix bug in bash completion where click would discard one or more trailing arguments. {issue}471

Released 2016-02-22

• Fix argument checks for interpreter invoke with -m and -c on Windows.
• Fixed a bug that cased locale detection to error out on Python 3.

Released 2015-11-27

• Correct fix for hidden progress bars.

Released 2015-11-27

• Resolved an issue with invisible progress bars no longer rendering.
• Disable chain commands with subcommands as they were inherently broken.
• Fix MissingParameter not working without parameters passed.

Released 2015-11-24, codename "pow pow"

• Optimized the progressbar rendering to not render when it did not actually change.
• Explicitly disallow nargs=-1 with a set default.
• The context is now closed before it's popped from the stack.
• Added support for short aliases for the false flag on toggles.
• Click will now attempt to aid you with debugging locale errors better by listing with the help of the OS what locales are available.
• Click used to return byte strings on Python 2 in some unit-testing situations. This has been fixed to correctly return unicode strings now.
• For Windows users on Python 2, Click will now handle Unicode more correctly handle Unicode coming in from the system. This also has the disappointing side effect that filenames will now be always unicode by default in the Path type which means that this can introduce small bugs for code not aware of this.
• Added a type parameter to Path to force a specific string type on the value.
• For users running Python on Windows the echo and prompt functions now work with full unicode functionality in the Python windows console by emulating an output stream. This also applies to getting the virtual output and input streams via click.get_text_stream(...).
• Unittests now always force a certain virtual terminal width.
• Added support for allowing dashes to indicate standard streams to the Path type.
• Multi commands in chain mode no longer propagate arguments left over from parsing to the callbacks. It's also now disallowed through an exception when optional arguments are attached to multi commands if chain mode is enabled.
• Relaxed restriction that disallowed chained commands to have other chained commands as child commands.
• Arguments with positive nargs can now have defaults implemented. Previously this configuration would often result in slightly unexpected values be returned.

Released 2015-08-17

• Fix a bug in pass_obj that would accidentally pass the context too.

Released 2015-08-16, codename "tok tok"

• Removed various deprecated functionality.
• Atomic files now only accept the w mode.
• Change the usage part of help output for very long commands to wrap their arguments onto the next line, indented by 4 spaces.
• Fix a bug where return code and error messages were incorrect when using CliRunner.
• Added get_current_context.
• Added a meta dictionary to the context which is shared across the linked list of contexts to allow click utilities to place state there.
• Introduced Context.scope.
• The echo function is now threadsafe: It calls the write method of the underlying object only once.
• prompt(hide_input=True) now prints a newline on ^C.
• Click will now warn if users are using unicode_literals.
• Click will now ignore the PAGER environment variable if it is empty or contains only whitespace.
• The click-contrib GitHub organization was created.

Released 2015-07-14

• Fix a bug where error messages would include a trailing None string.
• Fix a bug where Click would crash on docstrings with trailing newlines.
• Support streams with encoding set to None on Python 3 by barfing with a better error.
• Handle ^C in less-pager properly.
• Handle return value of None from sys.getfilesystemencoding
• Fix crash when writing to unicode files with click.echo.
• Fix type inference with multiple options.

Released 2015-03-31, codename "zoom zoom"

• Added color parameters to lots of interfaces that directly or indirectly call into echoing. This previously was always autodetection (with the exception of the echo_via_pager function). Now you can forcefully enable or disable it, overriding the auto detection of Click.
• Added an UNPROCESSED type which does not perform any type changes which simplifies text handling on 2.x / 3.x in some special advanced usecases.
• Added NoSuchOption and BadOptionUsage exceptions for more generic handling of errors.
• Added support for handling of unprocessed options which can be useful in situations where arguments are forwarded to underlying tools.
• Added max_content_width parameter to the context which can be used to change the maximum width of help output. By default Click will not format content for more than 80 characters width.
• Added support for writing prompts to stderr.
• Fix a bug when showing the default for multiple arguments.
• Added support for custom subclasses to option and argument.
• Fix bug in clear() on Windows when colorama is installed.
• Reject nargs=-1 for options properly. Options cannot be variadic.
• Fixed an issue with bash completion not working properly for commands with non ASCII characters or dashes.
• Added a way to manually update the progressbar.
• Changed the formatting of missing arguments. Previously the internal argument name was shown in error messages, now the metavar is shown if passed. In case an automated metavar is selected, it's stripped of extra formatting first.

Released 2014-09-08

• Fixed an issue with error reporting on Python 3 for invalid forwarding of commands.

Released 2014-08-22

• Added missing err parameter forwarding to the secho function.
• Fixed default parameters not being handled properly by the context invoke method. This is a backwards incompatible change if the function was used improperly.
• Removed the invoked_subcommands attribute largely. It is not possible to provide it to work error free due to how the parsing works so this API has been deprecated.
• Restored the functionality of invoked_subcommand which was broken as a regression in 3.1.

Released 2014-08-13

• Fixed a regression that caused contexts of subcommands to be created before the parent command was invoked which was a regression from earlier Click versions.

Released 2014-08-12, codename "clonk clonk"

• Formatter now no longer attempts to accommodate for terminals smaller than 50 characters. If that happens it just assumes a minimal width.
• Added a way to not swallow exceptions in the test system.
• Added better support for colors with pagers and ways to override the autodetection.
• The CLI runner's result object now has a traceback attached.
• Improved automatic short help detection to work better with dots that do not terminate sentences.
• When defining options without actual valid option strings now, Click will give an error message instead of silently passing. This should catch situations where users wanted to created arguments instead of options.
• Restructured Click internally to support vendoring.
• Added support for multi command chaining.
• Added support for defaults on options with multiple and options and arguments with nargs != 1.
• Label passed to progressbar is no longer rendered with whitespace stripped.
• Added a way to disable the standalone mode of the main method on a Click command to be able to handle errors better.
• Added support for returning values from command callbacks.
• Added simplifications for printing to stderr from echo.
• Added result callbacks for groups.
• Entering a context multiple times defers the cleanup until the last exit occurs.
• Added open_file.

Released 2014-08-11

• Fixed an issue where the wrapped streams on Python 3 would be reporting incorrect values for seekable.

Released 2014-07-28

• Fixed a bug with text wrapping on Python 3.

Released 2014-07-04

• Corrected a bug in the change of the help option in 2.3.

Released 2014-07-03

• Fixed an incorrectly formatted help record for count options.
• Add support for ansi code stripping on Windows if colorama is not available.
• Restored the Click 1.0 handling of the help parameter for certain edge cases.

Released 2014-06-26

• Fixed tty detection on PyPy.
• Fixed an issue that progress bars were not rendered when the context manager was entered.

Released 2014-06-14

• Fixed the {func}launch function on windows.
• Improved the colorama support on windows to try hard to not screw up the console if the application is interrupted.
• Fixed windows terminals incorrectly being reported to be 80 characters wide instead of 79
• Use colorama win32 bindings if available to get the correct dimensions of a windows terminal.
• Fixed an issue with custom function types on Python 3.
• Fixed an issue with unknown options being incorrectly reported in error messages.

Released 2014-06-06, codename "tap tap tap"

• Added support for opening stdin/stdout on Windows in binary mode correctly.
• Added support for atomic writes to files by going through a temporary file.
• Introduced {exc}BadParameter which can be used to easily perform custom validation with the same error messages as in the type system.
• Added {func}progressbar; a function to show progress bars.
• Added {func}get_app_dir; a function to calculate the home folder for configs.
• Added transparent handling for ANSI codes into the {func}echo function through colorama.
• Added {func}clear function.
• Breaking change: parameter callbacks now get the parameter object passed as second argument. There is legacy support for old callbacks which will warn but still execute the script.
• Added {func}style, {func}unstyle and {func}secho for ANSI styles.
• Added an {func}edit function that invokes the default editor.
• Added an {func}launch function that launches browsers and applications.
• Nargs of -1 for arguments can now be forced to be a single item through the required flag. It defaults to not required.
• Setting a default for arguments now implicitly makes it non required.
• Changed "yN" / "Yn" to "y/N" and "Y/n" in confirmation prompts.
• Added basic support for bash completion.
• Added {func}getchar to fetch a single character from the terminal.
• Errors now go to stderr as intended.
• Fixed various issues with more exotic parameter formats like DOS/Windows style arguments.
• Added {func}pause which works similar to the Windows pause cmd built-in but becomes an automatic noop if the application is not run through a terminal.
• Added a bit of extra information about missing choice parameters.
• Changed how the help function is implemented to allow global overriding of the help option.
• Added support for token normalization to implement case insensitive handling.
• Added support for providing defaults for context settings.

Released 2014-05-23

• Fixed a bug that caused text files in Python 2 to not accept native strings.

Released 2014-05-21

• Initial release.