2.2.0 (September 14, 2021)

• Bug Fixes
  • Fixed extra space appended to each alias by "alias list" command
• Enhancements
  • New function set_default_ap_completer_type() allows developer to extend and modify the
    behavior of ArgparseCompleter.
  • Added ArgumentParser.get_ap_completer_type() and ArgumentParser.set_ap_completer_type(). These
    methods allow developers to enable custom tab completion behavior for a given parser by using a custom
    ArgparseCompleter-based class.
  • Added ap_completer_type keyword arg to Cmd2ArgumentParser.__init__() which saves a call
    to set_ap_completer_type(). This keyword will also work with add_parser() when creating subcommands
    if the base command's parser is a Cmd2ArgumentParser.
  • New function register_argparse_argument_parameter() allows developers to specify custom
    parameters to be passed to the argparse parser's add_argument() method. These parameters will
    become accessible in the resulting argparse Action object when modifying ArgparseCompleter behavior.
  • Using SimpleTable in the output for the following commands to improve appearance.
    • help
    • set (command and tab completion of Settables)
    • alias tab completion
    • macro tab completion
  • Tab completion of CompletionItems now includes divider row comprised of Cmd.ruler character.
  • Removed --verbose flag from set command since descriptions always show now.
  • All cmd2 built-in commands now populate self.last_result.
  • Argparse tab completer will complete remaining flag names if there are no more positionals to complete.
  • Updated async_alert() to account for self.prompt not matching Readline's current prompt.
• Deletions (potentially breaking changes)
  • Deleted set_choices_provider() and set_completer() which were deprecated in 2.1.2
• Breaking Changes
  • Renamed set_default_argument_parser() to set_default_argument_parser_type()

2.1.2 (July 5, 2021)

• Enhancements
  • Added the following accessor methods for cmd2-specific attributes to the argparse.Action class
    • get_choices_callable()
    • set_choices_provider()
    • set_completer()
    • get_descriptive_header()
    • set_descriptive_header()
    • get_nargs_range()
    • set_nargs_range()
    • get_suppress_tab_hint()
    • set_suppress_tab_hint()
• Deprecations
  • Now that set_choices_provider() and set_completer() have been added as methods to the
    argparse.Action class, the standalone functions of the same name will be removed in version
    2.2.0. To update to the new convention, do the following:
    • Change set_choices_provider(action, provider) to action.set_choices_provider(provider)
    • Change set_completer(action, completer) to action.set_completer(completer)

2.1.1 (June 17, 2021)

• Bug Fixes
  • Fixed handling of argparse's default options group name which was changed in Python 3.10
• Enhancements
  • Restored plugins and tests_isolated directories to tarball published to PyPI for cmd2 release

2.1.0 (June 14, 2021)

• Enhancements
  • Converted persistent history files from pickle to compressed JSON

2.0.1 (June 7, 2021)

• Bug Fixes
  • Exclude plugins and tests_isolated directories from tarball published to PyPI for cmd2 release

2.0.0 (June 6, 2021)

• Bug Fixes
  • Fixed issue where history indexes could get repeated
  • Fixed issue where TableCreator was tossing blank last line
  • Corrected help text for alias command
• Breaking Changes
  • cmd2 2.0 supports Python 3.6+ (removed support for Python 3.5)
  • Argparse Completion / Settables
    • Replaced choices_function / choices_method with choices_provider.
    • Replaced completer_function / completer_method with completer.
    • ArgparseCompleter now always passes cmd2.Cmd or CommandSet instance as the first positional
      argument to choices_provider and completer functions.
  • Moved basic_complete from utils into cmd2.Cmd class.
  • Moved CompletionError to exceptions.py
  • Namespace.__statement__ has been removed. Use Namespace.cmd2_statement.get() instead.
  • Removed --silent flag from alias/macro create since startup scripts can be run silently.
  • Removed --with_silent flag from alias/macro list since startup scripts can be run silently.
  • Removed with_argparser_and_unknown_args since it was deprecated in 1.3.0.
  • Renamed silent_startup_script to silence_startup_script for clarity.
  • Replaced cmd2.Cmd.completion_header with cmd2.Cmd.formatted_completions. See Enhancements
    for description of this new class member.
  • Settables now have new initialization parameters. It is now a required parameter to supply the reference to the
    object that holds the settable attribute. cmd2.Cmd.settables is no longer a public dict attribute - it is now a
    property that aggregates all Settables across all registered CommandSets.
  • Failed transcript testing now sets self.exit_code to 1 instead of -1.
  • Renamed use_ipython keyword parameter of cmd2.Cmd.__init__() to include_ipy.
  • py command is only enabled if include_py parameter is True. See Enhancements for a description
    of this parameter.
  • Removed ability to run Python commands from the command line with py. Now py takes no arguments
    and just opens an interactive Python shell.
  • Changed default behavior of runcmds_plus_hooks() to not stop when Ctrl-C is pressed and instead
    run the next command in its list.
  • Removed cmd2.Cmd.quit_on_sigint flag, which when True, quit the application when Ctrl-C was pressed at the prompt.
  • The history bug fix resulted in structure changes to the classes in cmd2.history. Therefore, persistent history
    files created with versions older than 2.0.0 are not compatible.
• Enhancements
  • Added support for custom tab completion and up-arrow input history to cmd2.Cmd2.read_input.
    See read_input.py for an example.
  • Added cmd2.exceptions.PassThroughException to raise unhandled command exceptions instead of printing them.
  • Added support for ANSI styles and newlines in tab completion results using cmd2.Cmd.formatted_completions.
    cmd2 provides this capability automatically if you return argparse completion matches as CompletionItems.
  • Settables enhancements:
    • Settables may be optionally scoped to a CommandSet. Settables added to CommandSets will appear when a
      CommandSet is registered and disappear when a CommandSet is unregistered. Optionally, scoped Settables
      may have a prepended prefix.
    • Settables now allow changes to be applied to any arbitrary object attribute. It no longer needs to match an
      attribute added to the cmd2 instance itself.
  • Raising SystemExit or calling sys.exit() in a command or hook function will set self.exit_code
    to the exit code used in those calls. It will also result in the command loop stopping.
  • ipy command now includes all of self.py_locals in the IPython environment
  • Added include_py keyword parameter to cmd2.Cmd.__init__(). If False, then the py command will
    not be available. Defaults to False. run_pyscript is not affected by this parameter.
  • Made the amount of space between columns in a SimpleTable configurable
  • On POSIX systems, shell commands and processes being piped to are now run in the user's preferred shell
    instead of /bin/sh. The preferred shell is obtained by reading the SHELL environment variable. If that
    doesn't exist or is empty, then /bin/sh is used.
  • Changed cmd2.Cmd._run_editor() to the public method cmd2.Cmd.run_editor()

Plugin: External Test 2.0.0 (June 7, 2021)

Version update to match Cmd2 2.0 release.
No changes to plugin.

1.5.0 (January 31, 2021)

• Bug Fixes
  • Fixed bug where setting always_show_hint=True did not show a hint when completing Settables
  • Fixed bug in editor detection logic on Linux systems that do not have which
  • Fixed bug in table creator where column headers with tabs would result in an incorrect width calculation
  • Fixed FileNotFoundError which occurred when running history --clear and no history file existed.
• Enhancements
  • Added silent_startup_script option to cmd2.Cmd.__init__(). If True, then the startup script's
    output will be suppressed. Anything written to stderr will still display.
  • cmd2 now uses pyreadline3 when running Python 3.8 or greater on Windows
• Notes
  • This is the last release planned to support Python 3.5

1.4.0 (November 11, 2020)

• 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 (October 1, 2020)

• 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.