Change Log¶
v0.7.1 (2021-05-02)¶
Fixed a bug with
&
and|
Predicate
operators givingAttributeError
when used.Fixed the error message of
accept_none
which didn’t include{param_list}
.Improved
all_or_none
error message.Minor docs fixes.
v0.7.0 (2021-03-24)¶
Compatible changes and features
In constraint errors, the way the parameter list is formatted has changed. Instead of printing a comma-separated list of single labels:
each parameter is printed on a 2-space indented line and
both the short and long name of options are printed.
See the relevant commit.
Minor improvements to code and docs.
v0.6.1 (2021-03-01)¶
This patch release fixes some problems in the management and releasing of the package.
Add a
py.typed
file to ship the package with type hints (PEP 561).Use
setuptools-scm
to automatically manage the version of the package and the content of the source distribution based on the git repository:the source distribution now matches the git repository, with the only exception of
_version.py
, which is not tracked by git; it’s generated bysetuptools-scm
and included in the package;tox.ini and Makefile were updated to account for the fact that
_version.py
doesn’t exist in the repository before installing the package.
The new attribute
cloup.__version_tuple__
stores the version as a tuple (of at least 3 elements).
v0.6.0 (2021-02-28)¶
Incompatible changes
Removed the deprecated
GroupSection
as previously announced. Use the new name instead:Section
.In
Group.group()
andGroup.command
, the argumentsection
was moved after thecls
argument so that the signatures are now fully compatible with those of the parent class (the Liskov substitution principle is now satisfied). If you (wisely) passedsection
andcls
as keyword arguments in your code, you don’t need to change anything.
Compatible changes
Slightly improved return type (hint) of command decorators.
Minor refactoring of ConstraintMixin.
Improved the documentation.
v0.5.0 (2021-02-10)¶
Requirements
Drop support to Python 3.5.
Deprecated
GroupSection
was renamed asSection
.
Compatible changes and features
Added a subpackage for defining constraints on parameters groups (including
OptionGroup
’s).The code for adding support to option groups was extracted to
OptionGroupMixin
.Most of the code for adding support to subcommand sections was extracted to
SectionMixin
.
Project changes
Migrated from TravisCI to GitHub Actions.
v0.4.0 (2021-01-10)¶
Requirements
This is the last release officially supporting Python 3.5.
Compatible changes and features
Changed the internal (non-public) structure of the package.
Minor code improvements.
Repository-wise:
New documentation (hosted by ReadTheDocs)
Tox, TravisCI, Makefile completely rewritten.
v0.3.0 (2020-03-26)¶
Backward incompatible API changes¶
option_groups
decorator now takes options as positional arguments*options
;Group.section
decorator now takes sections as positional arguments*sections
;align_sections_help
was renamed toalign_sections
;GroupSection.__init__() sorted_
argument was renamed tosorted
.
Other changes¶
Additional signature for
option_group
: you can pass thehelp
argument as 2nd positional argument.Aligned option groups (option
align_option_groups
with defaultTrue
).More refactoring and testing.
v0.2.0 (2020-03-11)¶
[Feature] Add possibility of organizing subcommands of a cloup.Group in multiple help sections.
Various code improvements.
- Backward incompatible change:
rename
CloupCommand
andCloupGroup
resp. to justCommand
andGroup
.
v0.1.0 (2020-02-25)¶
First release on PyPI.