Changelog History
Page 2
-
v8.0.0.a1 Changes
November 29, 2020 -
v7.1.2 Changes
April 27, 2020๐ Released 2020-04-27
- Revert applying shell quoting to commands for
echo_with_pager
andedit
. This was intended to allows spaces in commands, but caused issues if the string was actually a command and arguments, or on Windows. Instead, the string must be quoted manually as it should appear on the command line. :issue:1514
- Revert applying shell quoting to commands for
-
v7.1.1 Changes
March 09, 2020 -
v7.1 Changes
March 09, 2020๐ Released 2020-03-09
- ๐ฆ Fix PyPI package name, "click" is lowercase again.
- Fix link in
unicode_literals
error message. :pr:1151
- ๐ Add support for colored output on UNIX Jupyter notebooks.
:issue:
1185
- Operations that strip ANSI controls will strip the cursor hide/show
sequences. :issue:
1216
- ๐ Remove unused compat shim for
bytes
. :pr:1195
- ๐ Expand testing around termui, especially getchar on Windows.
:issue:
1116
- ๐ Fix output on Windows Python 2.7 built with MSVC 14. :pr:
1342
- Fix
OSError
when running in MSYS2. :issue:1338
- ๐ Fix
OSError
when redirecting toNUL
stream on Windows. :issue:1065
- ๐ Fix memory leak when parsing Unicode arguments on Windows.
:issue:
1136
- Fix error in new AppEngine environments. :issue:
1462
- Always return one of the passed choices for
click.Choice
:issue:1277
, :pr:1318
- Add
no_args_is_help
option toclick.Command
, defaults to False :pr:1167
- 0๏ธโฃ Add
show_defaults
parameter toContext
to enable showing defaults globally. :issue:1018
- Handle
env MYPATH=''
as though the option were not passed. :issue:1196
- It is once again possible to call
next(bar)
on an active progress bar instance. :issue:1125
-
open_file
withatomic=True
retains permissions of existing files and respects the current umask for new files. :issue:1376
- โ
When using the test
CliRunner
withmix_stderr=False
, ifresult.stderr
is empty it will not raise aValueError
. :issue:1193
- ๐ Remove the unused
mix_stderr
parameter fromCliRunner.invoke
. :issue:1435
- Fix
TypeError
raised when using bool flags and specifyingtype=bool
. :issue:1287
- Newlines in option help text are replaced with spaces before
re-wrapping to avoid uneven line breaks. :issue:
834
- ๐จ
MissingParameter
exceptions are printable in the Python interpreter. :issue:1139
- 0๏ธโฃ Fix how default values for file-type options are shown during
prompts. :issue:
914
- Fix environment variable automatic generation for commands
containing
-
. :issue:1253
- Option help text replaces newlines with spaces when rewrapping, but
preserves paragraph breaks, fixing multiline formatting.
:issue:
834, 1066, 1397
- Option help text that is wrapped adds an extra newline at the end to
distinguish it from the next option. :issue:
1075
- Consider
sensible-editor
when determining the editor to use forclick.edit()
. :pr:1469
- Arguments to system calls such as the executable path passed to
click.edit
can contains spaces. :pr:1470
- Add ZSH completion autoloading and error handling. :issue:
1348
- Add a repr to
Command
,Group
,Option
, andArgument
, showing the name for friendlier debugging. :issue:1267
- Completion doesn't consider option names if a value starts with
-
after the--
separator. :issue:1247
- ZSH completion escapes special characters in values. :pr:
1418
- ๐ Add completion support for Fish shell. :pr:
1423
- Decoding bytes option values falls back to UTF-8 in more cases.
:pr:
1468
- ๐ Make the warning about old 2-arg parameter callbacks a deprecation
warning, to be removed in 8.0. This has been a warning since Click
2.0. :pr:
1492
- Adjust error messages to standardize the types of quotes used so they match error messages from Python.
-
v7.0 Changes
September 25, 2018๐ Released 2018-09-25
- Drop support for Python 2.6 and 3.3. (
#967
,#976
) - Wrap
click.Choice
's missing message. (#202
,#1000
) - Add native ZSH autocompletion support. (
#323
,#865
) - ๐ Document that ANSI color info isn't parsed from bytearrays in
Python 2. (
#334
_) - Document byte-stripping behavior of
CliRunner
. (#334
,#1010
) - Usage errors now hint at the
--help
option. (#393
,#557
) - Implement streaming pager. (
#409
,#889
) - Extract bar formatting to its own method. (
#414
_) - Add
DateTime
type for converting input in given date time formats. (#423
_) -
secho
's first argument can now beNone
, like inecho
. (#424
_) - ๐ Fixes a
ZeroDivisionError
inProgressBar.make_step
, when the arg passed to the first call ofProgressBar.update
is 0. (#447
,#1012
) - Show progressbar only if total execution time is visible. (
#487
_) - Added the ability to hide commands and options from help. (
#500
_) - Document that options can be
required=True
. (#514
,#1022
) - Non-standalone calls to
Context.exit
return the exit code, rather than callingsys.exit
. (#533
,#667
,#1098
_) - ๐
click.getchar()
returns Unicode in Python 3 on Windows, consistent with other platforms. (#537
,#821
,#822
,#1088
,#1108
_) - Added
FloatRange
type. (#538
,#553
) - ๐ Added support for bash completion of
type=click.Choice
forOptions
andArguments
. (#535
,#681
) - Only allow one positional arg for
Argument
parameter declaration. (#568
,#574
,#1014
_) - Add
case_sensitive=False
as an option to Choice. (#569
_) -
click.getchar()
correctly raisesKeyboardInterrupt
on "C" andEOFError
on "D" on Linux. (#583
,#1115
) - ๐ง Fix encoding issue with
click.getchar(echo=True)
on Linux. (#1115
_) -
param_hint
in errors now derived from param itself. (#598
,#704
,#709
_) - โ
Add a test that ensures that when an argument is formatted into a
usage error, its metavar is used, not its name. (
#612
_) - Allow setting
prog_name
as extra inCliRunner.invoke
. (#616
,#999
) - ๐ Help text taken from docstrings truncates at the
\f
form feed character, useful for hiding Sphinx-style parameter documentation. (#629
,#1091
) -
launch
now works properly under Cygwin. (#650
_) - Update progress after iteration. (
#651
,#706
) -
CliRunner.invoke
now may receiveargs
as a string representing a Unix shell command. (#664
_) - 0๏ธโฃ Make
Argument.make_metavar()
default to type metavar. (#675
_) - Add documentation for
ignore_unknown_options
. (#684
_) - ๐
Add bright colors support for
click.style
and fix the reset option for parametersfg
andbg
. (#703
,#809
) - Add
show_envvar
for showing environment variables in help. (#710
_) - Avoid
BrokenPipeError
during interpreter shutdown when stdout or stderr is a closed pipe. (#712
,#1106
) - Document customizing option names. (
#725
,#1016
) - Disable
sys._getframes()
on Python interpreters that don't support it. (#728
_) - โ
Fix bug in test runner when calling
sys.exit
withNone
. (#739
_) - Clarify documentation on command line options. (
#741
,#1003
) - ๐ Fix crash on Windows console. (
#744
_) - Fix bug that caused bash completion to give improper completions on
chained commands. (
#754
,#774
) - ๐ Added support for dynamic bash completion from a user-supplied
callback. (
#755
_) - ๐ Added support for bash completions containing spaces. (
#773
_) - Allow autocompletion function to determine whether or not to return
completions that start with the incomplete argument. (
#790
,#806
) - ๐ Fix option naming routine to match documentation and be
deterministic. (
#793
,#794
) - Fix path validation bug. (
#795
,#1020
) - ๐ Add test and documentation for
Option
naming: functionality. (#799
_) - Update doc to match arg name for
path_type
. (#801
_) - Raw strings added so correct escaping occurs. (
#807
_) - ๐ Fix 16k character limit of
click.echo
on Windows. (#816
,#819
) - Overcome 64k character limit when writing to binary stream on
Windows 7. (
#825
,#830
) - Add bool conversion for "t" and "f". (
#842
_) -
NoSuchOption
errors takectx
so that--help
hint gets printed in error output. (#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.
(
#862
_) - 0๏ธโฃ Progress bar now uses stderr by default. (
#863
_) - Add support for auto-completion documentation. (
#866
,#869
) - Allow
CliRunner
to separate stdout and stderr. (#868
_) - Fix variable precedence. (
#873
,#874
) - Fix invalid escape sequences. (
#877
_) - โ
Fix
ResourceWarning
that occurs during some tests. (#878
_) - When detecting a misconfigured locale, don't fail if the
locale
command fails. (#880
_) - Add
case_sensitive=False
as an option toChoice
types. (#887
_) - Force stdout/stderr writable. This works around issues with badly
patched standard streams like those from Jupyter. (
#918
_) - Fix completion of subcommand options after last argument (
#919
,#930
) -
_AtomicFile
now uses therealpath
of the original filename so that changing the working directory does not affect it. (#920
_) - 0๏ธโฃ Fix incorrect completions when defaults are present (
#925
,#930
) - Add copy option attrs so that custom classes can be re-used.
(
#926
,#994
) - "x" and "a" file modes now use stdout when file is
"-"
. (#929
_) - Fix missing comma in
__all__
list. (#935
_) - Clarify how parameters are named. (
#949
,#1009
) - Stdout is now automatically set to non blocking. (
#954
_) - Do not set options twice. (
#962
_) - ๐ Move
fcntl
import. (#965
_) - Fix Google App Engine
ImportError
. (#995
_) - 0๏ธโฃ Better handling of help text for dynamic default option values.
(
#996
_) - Fix
get_winter_size()
so it correctly returns(0,0)
. (#997
_) - โ
Add test case checking for custom param type. (
#1001
_) - Allow short width to address cmd formatting. (
#1002
_) - ๐ Add details about Python version support. (
#1004
_) - ๐ Added deprecation flag to commands. (
#1005
_) - ๐ Fixed issues where
fd
was undefined. (#1007
_) - Fix formatting for short help. (
#1008
_) - Document how
auto_envvar_prefix
works with command groups. (#1011
_) - 0๏ธโฃ Don't add newlines by default for progress bars. (
#1013
_) - Use Python sorting order for ZSH completions. (
#1047
,#1059
) - 0๏ธโฃ Document that parameter names are converted to lowercase by default.
(
#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 becomesmy-command
in the command line interface. - Hide hidden commands and options from completion. (
#1058
,#1061
) - Fix absolute import blocking Click from being vendored into a
project on Windows. (
#1068
,#1069
) - Fix issue where a lowercase
auto_envvar_prefix
would not be converted to uppercase. (#1105
_)
.. _#202: https://github.com/pallets/click/issues/202 .. _#323: https://github.com/pallets/click/issues/323 .. _#334: https://github.com/pallets/click/issues/334 .. _#393: https://github.com/pallets/click/issues/393 .. _#409: https://github.com/pallets/click/issues/409 .. _#414: https://github.com/pallets/click/pull/414 .. _#423: https://github.com/pallets/click/pull/423 .. _#424: https://github.com/pallets/click/pull/424 .. _#447: https://github.com/pallets/click/issues/447 .. _#487: https://github.com/pallets/click/pull/487 .. _#500: https://github.com/pallets/click/pull/500 .. _#514: https://github.com/pallets/click/issues/514 .. _#533: https://github.com/pallets/click/pull/533 .. _#535: https://github.com/pallets/click/issues/535 .. _#537: https://github.com/pallets/click/issues/537 .. _#538: https://github.com/pallets/click/pull/538 .. _#553: https://github.com/pallets/click/pull/553 .. _#557: https://github.com/pallets/click/pull/557 .. _#568: https://github.com/pallets/click/issues/568 .. _#569: https://github.com/pallets/click/issues/569 .. _#574: https://github.com/pallets/click/issues/574 .. _#583: https://github.com/pallets/click/issues/583 .. _#598: https://github.com/pallets/click/issues/598 .. _#612: https://github.com/pallets/click/pull/612 .. _#616: https://github.com/pallets/click/issues/616 .. _#629: https://github.com/pallets/click/pull/629 .. _#650: https://github.com/pallets/click/pull/650 .. _#651: https://github.com/pallets/click/issues/651 .. _#664: https://github.com/pallets/click/pull/664 .. _#667: https://github.com/pallets/click/issues/667 .. _#675: https://github.com/pallets/click/pull/675 .. _#681: https://github.com/pallets/click/pull/681 .. _#684: https://github.com/pallets/click/pull/684 .. _#703: https://github.com/pallets/click/issues/703 .. _#704: https://github.com/pallets/click/issues/704 .. _#706: https://github.com/pallets/click/pull/706 .. _#709: https://github.com/pallets/click/pull/709 .. _#710: https://github.com/pallets/click/pull/710 .. _#712: https://github.com/pallets/click/pull/712 .. _#719: https://github.com/pallets/click/issues/719 .. _#725: https://github.com/pallets/click/issues/725 .. _#728: https://github.com/pallets/click/pull/728 .. _#739: https://github.com/pallets/click/pull/739 .. _#741: https://github.com/pallets/click/issues/741 .. _#744: https://github.com/pallets/click/issues/744 .. _#754: https://github.com/pallets/click/issues/754 .. _#755: https://github.com/pallets/click/pull/755 .. _#773: https://github.com/pallets/click/pull/773 .. _#774: https://github.com/pallets/click/pull/774 .. _#790: https://github.com/pallets/click/issues/790 .. _#793: https://github.com/pallets/click/issues/793 .. _#794: https://github.com/pallets/click/pull/794 .. _#795: https://github.com/pallets/click/issues/795 .. _#799: https://github.com/pallets/click/pull/799 .. _#801: https://github.com/pallets/click/pull/801 .. _#806: https://github.com/pallets/click/pull/806 .. _#807: https://github.com/pallets/click/pull/807 .. _#809: https://github.com/pallets/click/pull/809 .. _#816: https://github.com/pallets/click/pull/816 .. _#819: https://github.com/pallets/click/pull/819 .. _#821: https://github.com/pallets/click/issues/821 .. _#822: https://github.com/pallets/click/issues/822 .. _#825: https://github.com/pallets/click/issues/825 .. _#830: https://github.com/pallets/click/pull/830 .. _#842: https://github.com/pallets/click/pull/842 .. _#860: https://github.com/pallets/click/issues/860 .. _#862: https://github.com/pallets/click/issues/862 .. _#863: https://github.com/pallets/click/pull/863 .. _#865: https://github.com/pallets/click/pull/865 .. _#866: https://github.com/pallets/click/issues/866 .. _#868: https://github.com/pallets/click/pull/868 .. _#869: https://github.com/pallets/click/pull/869 .. _#873: https://github.com/pallets/click/issues/873 .. _#874: https://github.com/pallets/click/pull/874 .. _#877: https://github.com/pallets/click/pull/877 .. _#878: https://github.com/pallets/click/pull/878 .. _#880: https://github.com/pallets/click/pull/880 .. _#883: https://github.com/pallets/click/pull/883 .. _#887: https://github.com/pallets/click/pull/887 .. _#889: https://github.com/pallets/click/pull/889 .. _#918: https://github.com/pallets/click/pull/918 .. _#919: https://github.com/pallets/click/issues/919 .. _#920: https://github.com/pallets/click/pull/920 .. _#925: https://github.com/pallets/click/issues/925 .. _#926: https://github.com/pallets/click/issues/926 .. _#929: https://github.com/pallets/click/pull/929 .. _#930: https://github.com/pallets/click/pull/930 .. _#935: https://github.com/pallets/click/pull/935 .. _#949: https://github.com/pallets/click/issues/949 .. _#954: https://github.com/pallets/click/pull/954 .. _#962: https://github.com/pallets/click/pull/962 .. _#965: https://github.com/pallets/click/pull/965 .. _#967: https://github.com/pallets/click/pull/967 .. _#976: https://github.com/pallets/click/pull/976 .. _#990: https://github.com/pallets/click/pull/990 .. _#991: https://github.com/pallets/click/pull/991 .. _#993: https://github.com/pallets/click/pull/993 .. _#994: https://github.com/pallets/click/pull/994 .. _#995: https://github.com/pallets/click/pull/995 .. _#996: https://github.com/pallets/click/pull/996 .. _#997: https://github.com/pallets/click/pull/997 .. _#999: https://github.com/pallets/click/pull/999 .. _#1000: https://github.com/pallets/click/pull/1000 .. _#1001: https://github.com/pallets/click/pull/1001 .. _#1002: https://github.com/pallets/click/pull/1002 .. _#1003: https://github.com/pallets/click/pull/1003 .. _#1004: https://github.com/pallets/click/pull/1004 .. _#1005: https://github.com/pallets/click/pull/1005 .. _#1007: https://github.com/pallets/click/pull/1007 .. _#1008: https://github.com/pallets/click/pull/1008 .. _#1009: https://github.com/pallets/click/pull/1009 .. _#1010: https://github.com/pallets/click/pull/1010 .. _#1011: https://github.com/pallets/click/pull/1011 .. _#1012: https://github.com/pallets/click/pull/1012 .. _#1013: https://github.com/pallets/click/pull/1013 .. _#1014: https://github.com/pallets/click/pull/1014 .. _#1016: https://github.com/pallets/click/pull/1016 .. _#1020: https://github.com/pallets/click/pull/1020 .. _#1022: https://github.com/pallets/click/pull/1022 .. _#1027: https://github.com/pallets/click/pull/1027 .. _#1047: https://github.com/pallets/click/pull/1047 .. _#1055: https://github.com/pallets/click/pull/1055 .. _#1058: https://github.com/pallets/click/pull/1058 .. _#1059: https://github.com/pallets/click/pull/1059 .. _#1061: https://github.com/pallets/click/pull/1061 .. _#1068: https://github.com/pallets/click/issues/1068 .. _#1069: https://github.com/pallets/click/pull/1069 .. _#1088: https://github.com/pallets/click/issues/1088 .. _#1091: https://github.com/pallets/click/pull/1091 .. _#1098: https://github.com/pallets/click/pull/1098 .. _#1105: https://github.com/pallets/click/pull/1105 .. _#1106: https://github.com/pallets/click/pull/1106 .. _#1108: https://github.com/pallets/click/pull/1108 .. _#1115: https://github.com/pallets/click/pull/1115
- Drop support for Python 2.6 and 3.3. (
-
v6.7 Changes
January 06, 2017๐ (bugfix release; released on January 6th 2017)
- ๐ Make
click.progressbar
work withcodecs.open
files. See #637. - ๐ Fix bug in bash completion with nested subcommands. See #639.
- ๐ Fix test runner not saving caller env correctly. See #644.
- ๐ Fix handling of SIGPIPE. See #626
- ๐ Deal with broken Windows environments such as Google App Engine's. See #711.
- ๐ Make
-
v6.6 Changes
April 04, 2016๐ (bugfix release; released on April 4th 2016)
- ๐ Fix bug in
click.Path
where it would crash when passed a-
. See #551.
- ๐ Fix bug in
-
v6.5
April 04, 2016 -
v6.4 Changes
March 23, 2016๐ (bugfix release; released on March 24th 2016)
- ๐ Fix bug in bash completion where click would discard one or more trailing arguments. See #471.
-
v6.3 Changes
February 22, 2016๐ (bugfix release; released on February 22 2016)
- ๐ 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.
- ๐ Fix argument checks for interpreter invoke with