Bug Fixes

• negative_iterable with an empty string shouldn't appear in the help screen by @nachocab in #530

Documentation

• Improve contributing docs and .gitignore by @nachocab in #531

Full Changelog: v3.23.0...v3.23.1

Features

• NonExistent* convenience types by @BrianPugh in #522

Bug Fixes

• When performing command-similarity search, do not recommend commands that have show=False. by @BrianPugh in #521

Documentation

• Improve consume_multiple documentation by @nachocab in #517

New Contributors

• @nachocab made their first contribution in #517

Full Changelog: v3.22.5...v3.23.0

Bug Fixes

• Fix broken command alias when name is also specified. by @BrianPugh in #509

Full Changelog: v3.22.4...v3.22.5

Bug Fixes

• Fix parameter alias resolution in dataclass attributes. by @BrianPugh in #506

Full Changelog: v3.22.3...v3.22.4

Bug Fixes

• Fix DivideByZero error when counting tuple[bool, ...] by @BrianPugh in #498
• Fix interpreting collections.abc.Sequence[bool] as multiple boolean flags. by @BrianPugh in #499
• Include root import module in automatic version detection by @whatever60 in #495

New Contributors

• @whatever60 made their first contribution in #495

Full Changelog: v3.22.2...v3.22.3

Bug Fixes

• Fix erroneous MissingArgumentError if an empty iterable value is provided in a config file. by @BrianPugh in #492

Full Changelog: v3.22.1...v3.22.2

Bug Fixes

• Fix generating help for annotated enums with typealias by @Rubikoid in #487

New Contributors

• @Rubikoid made their first contribution in #487

Full Changelog: v3.22.0...v3.22.1

Features

• Add App.alias to conveniently assign additional names to commands. by @BrianPugh in #486

Full Changelog: v3.21.0...v3.22.0

Features

• cyclopts.validators.LimitedChoice improvements (by @BrianPugh in #483):
  • If LimitedChoice min value is negative, then all parameters in the group must be specified.
  • New LimitedChoice argument allow_none=False. If True, then also allow 0 CLI parameters (even if min is greater than 0).
• New group validator all_or_none, which is just the instantiated object LimitedChoice(-1, allow_none=True).
• Mutually exclusive object cyclopts.validators.mutually_exclusive for convenience by @BrianPugh in #482

Bug Fixes

• Fix multiple anonymous groups resolving to the same group. by @BrianPugh in #481

Documentation

• Add User-Specified Config File example. by @BrianPugh in #480

Full Changelog: v3.20.0...v3.21.0

This release contains changes that may change some behavior for some users, but is mostly benign. If using custom Group Validators, please give this release more attention.

Features

• Give Commands/Arguments/Parameters higher priority (in that order) on the help-page. This places "Commands" at the top, and "Arguments" next to "Parameters":

  ╭─ Commands ────────────────────────────────────────────────────────────╮
  │ --help -h  Display this message and exit.                             │
  │ --version  Display application version.                               │
  ╰───────────────────────────────────────────────────────────────────────╯
  ╭─ Arguments ───────────────────────────────────────────────────────────╮
  │ *  FOO  [required]                                                    │
  ╰───────────────────────────────────────────────────────────────────────╯
  ╭─ Parameters ──────────────────────────────────────────────────────────╮
  │ *  BAR --bar  [required]                                              │
  ╰───────────────────────────────────────────────────────────────────────╯
  

  See Group.sort_key for more details.
  By @BrianPugh in #476

Bug Fixes

• config.Env: recombine remaining_keys into a single key if the found argument doesn't have any sub-arguments. by @BrianPugh in #472
• Always call all group-validators; provide all arguments within the group. by @BrianPugh in #473
  • Previously, only validators of groups that were provided arguments were executed. Also, only arguments that had parsed tokens were supplied. This was as bug and went against documented behavior.

Full Changelog: v3.19.0...v3.20.0