Merge pull request #249 from python-cmd2/arglist

decorator changes for replacing optparse with argparse

Author: tleonhardt

CHANGELOG.md

@@ -2,11 +2,32 @@
 * Bug Fixes
     * Fixed unit tests on Python 3.7 due to changes in how re.escape() behaves in Python 3.7
 * Enhancements
-    * Added new **with_argument_parser** decorator for argparse-based argument parsing of command arguments
-        * This replaces the old **options** decorator for optparse-based argument parsing
-            * The old decorator is still present for now, but should be considered *deprecated* and will eventually be removed
-        * See the **Argument Processing** section of the documentation for more information
-            * Alternatively, see the **argparse_example.py** example
+    * Three new decorators for **do_*** commands to make argument parsing easier
+        * **with_argument_list** decorator to change argument type from str to List[str]
+            * **do_*** commands get a single argument which is a list of strings, as pre-parsed by shlex.split()
+        * **with_argument_parser** decorator for strict argparse-based argument parsing of command arguments
+            * **do_*** commands get a single argument which is the output of argparse.parse_args()
+        * **with_argparser_and_unknown_args** decorator for argparse-based argument parsing, but allowing unknown args
+            * **do_*** commands get two arguments, the output of argparse.parse_known_args()
+    *  See the **Argument Processing** section of the documentation for more information on these decorators
+        * Alternatively, see the **argparse_example.py** and **arg_print.py** examples
+    * The **__relative_load** command is now hidden from the help menu by default
+        * This command is not intended to be called from the command line, only from within scripts
+    * The **set** command now has an additional **-a/--all** option to also display read-only settings
+    * The **history** command can now run, edit, and save prior commands, in addition to the prior behavior of displaying prior commands.
+* Commands Removed
+    * The **cmdenvironment** has been removed and its functionality incorporated into the **-a/--all** argument to **set**
+    * The **show** command has been removed.  Its functionality has always existing within **set** and continues to do so
+    * The **save** command has been removed. The capability to save prior commands is now part of the **history** command.
+    * The **run** command has been removed. The capability to run prior commands is now part of the **history** command.
+* Other changes
+    * The **edit** command no longer allows you to edit prior commands. The capability to edit prior commands is now part of the **history** command. The **edit** command still allows you to edit arbitrary files.
+    * the **autorun_on_edit** setting has been removed.
+* Deprecations
+    * The old **options** decorator for optparse-based argument parsing is now *deprecated*
+        * The old decorator is still present for now, but will eventually be removed in a future release
+        * ``cmd2`` no longer includes **optparse.make_option** so if your app needs it you need to import it directly from optparse
+
 
 ## 0.7.9 (January 4, 2018)
 

README.md

@@ -70,13 +70,13 @@ Instructions for implementing each feature follow.
 - Searchable command history
 
     All commands will automatically be tracked in the session's history, unless the command is listed in Cmd's excludeFromHistory attribute.
-    The history is accessed through the `history`, `list`, and `run` commands.
+    The history is accessed through the `history` command.
     If you wish to exclude some of your custom commands from the history, append their names
     to the list at `Cmd.ExcludeFromHistory`.
 
 - Load commands from file, save to file, edit commands in file
 
-    Type `help load`, `help save`, `help edit` for details.
+    Type `help load`, `help history` for details.
 
 - Multi-line commands
 
@@ -105,7 +105,7 @@ Instructions for implementing each feature follow.
     argparser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')
     argparser.add_argument('words', nargs='+', help='words to say')
     @with_argument_parser(argparser)
-    def do_speak(self, cmdline, args=None):
+    def do_speak(self, args):
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -175,7 +175,7 @@ class CmdLineApp(Cmd):
     argparser.add_argument('-r', '--repeat', type=int, help='output [n] times')
     argparser.add_argument('words', nargs='+', help='words to say')
     @with_argument_parser(argparser)
-    def do_speak(self, cmdline, opts=None):
+    def do_speak(self, args):
         """Repeats what you tell me to."""
         words = []
         for word in args.words:
@@ -196,7 +196,7 @@ class CmdLineApp(Cmd):
     argparser.add_argument('-r', '--repeat', type=int, help='how many times to repeat')
     argparser.add_argument('words', nargs='+', help='words to say')
     @with_argument_parser(argparser)
-    def do_mumble(self, cmdline, args=None):
+    def do_mumble(self, args):
         """Mumbles what you tell me to."""
         repetitions = args.repeat or 1
         for i in range(min(repetitions, self.maxrepeats)):
@@ -236,7 +236,6 @@ example/transcript_regex.txt:
 # regexes on prompts just make the trailing space obvious
 (Cmd) set
 abbrev: True
-autorun_on_edit: False
 colors: /(True|False)/
 continuation_prompt: >/ /
 debug: False