Changelog
### 1.4.0
```
* Bug Fixes
* Fixed tab completion crash on Windows
* Enhancements
* Changed how multiline doc string help is formatted to match style of other help messages
```
### 1.3.11
```
* Bug Fixes
* Fixed issue where quoted redirectors and terminators in aliases and macros were not being
restored when read from a startup script.
* Fixed issue where instantiating more than one cmd2-based class which uses the `as_subcommand_to`
decorator resulted in duplicated help text in the base command the subcommands belong to.
```
### 1.3.10
```
* Enhancements
* Added user-settable option called `always_show_hint`. If True, then tab completion hints will always
display even when tab completion suggestions print. Arguments whose help or hint text is suppressed will
not display hints even when this setting is True.
* argparse tab completion now groups flag names which run the same action. Optional flags are wrapped
in brackets like it is done in argparse usage text.
* default category decorators are now heritable by default and will propagate the category down the
class hierarchy until overridden. There's a new optional flag to set heritable to false.
* Added `--silent` flag to `alias/macro create`. If used, then no confirmation message will be printed
when aliases and macros are created or overwritten.
* Added `--with_silent` flag to `alias/macro list`. Use this option when saving to a startup script
that should silently create aliases and macros.
* Bug Fixes
* Fixed issue where flag names weren't always sorted correctly in argparse tab completion
```
### 1.3.9
```
* Breaking Changes
* `CommandSet.on_unregister()` is now called as first step in unregistering a `CommandSet` and not
the last. `CommandSet.on_unregistered()` is now the last step.
* Enhancements
* Added `CommandSet.on_registered()`. This is called by `cmd2.Cmd` after a `CommandSet` is registered
and all its commands have been added to the CLI.
* Added `CommandSet.on_unregistered()`. This is called by `cmd2.Cmd` after a `CommandSet` is unregistered
and all its commands have been removed from the CLI.
```
### 1.3.8
```
* Bug Fixes
* Fixed issue where subcommand added with `as_subcommand_to` decorator did not display help
when called with `-h/--help`.
* Enhancements
* `add_help=False` no longer has to be passed to parsers used in `as_subcommand_to` decorator.
Only pass this if your subcommand should not have the `-h/--help` help option (as stated in
argparse documentation).
```
### 1.3.7
```
* Bug Fixes
* Fixes an issue introduced in 1.3.0 with processing command strings containing terminator/separator
character(s) that are manually passed to a command that uses argparse.
```
### 1.3.6
```
* Breaking changes
* The functions cmd2 adds to Namespaces (`get_statement()` and `get_handler()`) are now
`Cmd2AttributeWrapper` objects named `cmd2_statement` and `cmd2_handler`. This makes it
easy to filter out which attributes in an `argparse.Namespace` were added by `cmd2`.
* Deprecations
* ``Namespace.__statement__`` will be removed in `cmd2` 2.0.0. Use `Namespace.cmd2_statement.get()`
going forward.
```
### 1.3.5
```
* Bug Fixes
* Fixed `RecursionError` when printing an `argparse.Namespace` caused by custom attribute cmd2 was adding
* Enhancements
* Added `get_statement()` function to `argparse.Namespace` which returns `__statement__` attribute
```
### 1.3.4
```
* Bug Fixes
* Fixed `AttributeError` when `CommandSet` that uses `as_subcommand_to` decorator is loaded during
`cmd2.Cmd.__init__()`.
* Enhancements
* Improved exception messages when using mock without `spec=True`.
See [testing](https://cmd2.readthedocs.io/en/latest/testing.html) documentation for more details on testing
cmd2-based applications with mock.
```
### 1.3.3
```
* Breaking changes
* CommandSet command functions (do_, complete_, help_) will no longer have the cmd2 app
passed in as the first parameter after `self` since this is already a class member.
* Renamed `install_command_set()` and `uninstall_command_set()` to `register_command_set()` and
`unregister_command_set()` for better name consistency.
* Bug Fixes
* Fixed help formatting bug in `Cmd2ArgumentParser` when `metavar` is a tuple
* Fixed tab completion bug when using `CompletionItem` on an argument whose `metavar` is a tuple
* Added explicit testing against python 3.5.2 for Ubuntu 16.04, and 3.5.3 for Debian 9
* Added fallback definition of typing.Deque (taken from 3.5.4)
* Removed explicit type hints that fail due to a bug in 3.5.2 favoring comment-based hints instead
* When passing a ns_provider to an argparse command, will now attempt to resolve the correct
CommandSet instance for self. If not, it'll fall back and pass in the cmd2 app
* Other
* Added missing doc-string for new cmd2.Cmd __init__ parameters
introduced by CommandSet enhancement
```
### 1.3.2
```
* Bug Fixes
* Fixed `prog` value of subcommands added with `as_subcommand_to()` decorator.
* Fixed missing settings in subcommand parsers created with `as_subcommand_to()` decorator. These settings
include things like description and epilog text.
* Fixed issue with CommandSet auto-discovery only searching direct sub-classes
* Enhancements
* Added functions to fetch registered CommandSets by type and command name
```
### 1.3.1
```
* Bug Fixes
* Fixed issue determining whether an argparse completer function required a reference to a containing
CommandSet. Also resolves issues determining the correct CommandSet instance when calling the argparse
argument completer function. Manifested as a TypeError when using `cmd2.Cmd.path_complete` as a completer
for an argparse-based command defined in a CommandSet
```
### 1.3.0
```
* Enhancements
* Added CommandSet - Enables defining a separate loadable module of commands to register/unregister
with your cmd2 application.
* Other
* Marked with_argparser_and_unknown_args pending deprecation and consolidated implementation into
with_argparser
```
Links
- PyPI: https://pypi.org/project/cmd2
- Changelog: https://pyup.io/changelogs/cmd2/
- Repo: https://github.com/python-cmd2/cmd2
This PR updates cmd2 from 1.2.1 to 1.4.0.
Changelog
### 1.4.0 ``` * Bug Fixes * Fixed tab completion crash on Windows * Enhancements * Changed how multiline doc string help is formatted to match style of other help messages ``` ### 1.3.11 ``` * Bug Fixes * Fixed issue where quoted redirectors and terminators in aliases and macros were not being restored when read from a startup script. * Fixed issue where instantiating more than one cmd2-based class which uses the `as_subcommand_to` decorator resulted in duplicated help text in the base command the subcommands belong to. ``` ### 1.3.10 ``` * Enhancements * Added user-settable option called `always_show_hint`. If True, then tab completion hints will always display even when tab completion suggestions print. Arguments whose help or hint text is suppressed will not display hints even when this setting is True. * argparse tab completion now groups flag names which run the same action. Optional flags are wrapped in brackets like it is done in argparse usage text. * default category decorators are now heritable by default and will propagate the category down the class hierarchy until overridden. There's a new optional flag to set heritable to false. * Added `--silent` flag to `alias/macro create`. If used, then no confirmation message will be printed when aliases and macros are created or overwritten. * Added `--with_silent` flag to `alias/macro list`. Use this option when saving to a startup script that should silently create aliases and macros. * Bug Fixes * Fixed issue where flag names weren't always sorted correctly in argparse tab completion ``` ### 1.3.9 ``` * Breaking Changes * `CommandSet.on_unregister()` is now called as first step in unregistering a `CommandSet` and not the last. `CommandSet.on_unregistered()` is now the last step. * Enhancements * Added `CommandSet.on_registered()`. This is called by `cmd2.Cmd` after a `CommandSet` is registered and all its commands have been added to the CLI. * Added `CommandSet.on_unregistered()`. This is called by `cmd2.Cmd` after a `CommandSet` is unregistered and all its commands have been removed from the CLI. ``` ### 1.3.8 ``` * Bug Fixes * Fixed issue where subcommand added with `as_subcommand_to` decorator did not display help when called with `-h/--help`. * Enhancements * `add_help=False` no longer has to be passed to parsers used in `as_subcommand_to` decorator. Only pass this if your subcommand should not have the `-h/--help` help option (as stated in argparse documentation). ``` ### 1.3.7 ``` * Bug Fixes * Fixes an issue introduced in 1.3.0 with processing command strings containing terminator/separator character(s) that are manually passed to a command that uses argparse. ``` ### 1.3.6 ``` * Breaking changes * The functions cmd2 adds to Namespaces (`get_statement()` and `get_handler()`) are now `Cmd2AttributeWrapper` objects named `cmd2_statement` and `cmd2_handler`. This makes it easy to filter out which attributes in an `argparse.Namespace` were added by `cmd2`. * Deprecations * ``Namespace.__statement__`` will be removed in `cmd2` 2.0.0. Use `Namespace.cmd2_statement.get()` going forward. ``` ### 1.3.5 ``` * Bug Fixes * Fixed `RecursionError` when printing an `argparse.Namespace` caused by custom attribute cmd2 was adding * Enhancements * Added `get_statement()` function to `argparse.Namespace` which returns `__statement__` attribute ``` ### 1.3.4 ``` * Bug Fixes * Fixed `AttributeError` when `CommandSet` that uses `as_subcommand_to` decorator is loaded during `cmd2.Cmd.__init__()`. * Enhancements * Improved exception messages when using mock without `spec=True`. See [testing](https://cmd2.readthedocs.io/en/latest/testing.html) documentation for more details on testing cmd2-based applications with mock. ``` ### 1.3.3 ``` * Breaking changes * CommandSet command functions (do_, complete_, help_) will no longer have the cmd2 app passed in as the first parameter after `self` since this is already a class member. * Renamed `install_command_set()` and `uninstall_command_set()` to `register_command_set()` and `unregister_command_set()` for better name consistency. * Bug Fixes * Fixed help formatting bug in `Cmd2ArgumentParser` when `metavar` is a tuple * Fixed tab completion bug when using `CompletionItem` on an argument whose `metavar` is a tuple * Added explicit testing against python 3.5.2 for Ubuntu 16.04, and 3.5.3 for Debian 9 * Added fallback definition of typing.Deque (taken from 3.5.4) * Removed explicit type hints that fail due to a bug in 3.5.2 favoring comment-based hints instead * When passing a ns_provider to an argparse command, will now attempt to resolve the correct CommandSet instance for self. If not, it'll fall back and pass in the cmd2 app * Other * Added missing doc-string for new cmd2.Cmd __init__ parameters introduced by CommandSet enhancement ``` ### 1.3.2 ``` * Bug Fixes * Fixed `prog` value of subcommands added with `as_subcommand_to()` decorator. * Fixed missing settings in subcommand parsers created with `as_subcommand_to()` decorator. These settings include things like description and epilog text. * Fixed issue with CommandSet auto-discovery only searching direct sub-classes * Enhancements * Added functions to fetch registered CommandSets by type and command name ``` ### 1.3.1 ``` * Bug Fixes * Fixed issue determining whether an argparse completer function required a reference to a containing CommandSet. Also resolves issues determining the correct CommandSet instance when calling the argparse argument completer function. Manifested as a TypeError when using `cmd2.Cmd.path_complete` as a completer for an argparse-based command defined in a CommandSet ``` ### 1.3.0 ``` * Enhancements * Added CommandSet - Enables defining a separate loadable module of commands to register/unregister with your cmd2 application. * Other * Marked with_argparser_and_unknown_args pending deprecation and consolidated implementation into with_argparser ```Links
- PyPI: https://pypi.org/project/cmd2 - Changelog: https://pyup.io/changelogs/cmd2/ - Repo: https://github.com/python-cmd2/cmd2