Merge pull request #128 from python-cmd2/use_arg_list

Changed default value of USE_ARG_LIST and bumped version

Author: tleonhardt

CHANGES.md

@@ -7,11 +7,16 @@ News
 *Release date: TBD*
 
 * Bug fixes
-    * Fixed a bug in display a span of history items when only an end index is supplied
+    * Fixed a bug in displaying a span of history items when only an end index is supplied
 * Enhancements
     * Added the ability to exclude commands from the help menu (**eof** included by default)
-    * Redundant list command removed and features merged into history command
-    * Added **pyscript** command which supports running Python scripts with arguments
+    * Redundant **list** command removed and features merged into **history** command
+    * Added **pyscript** command which supports tab-completion and running Python scripts with arguments
+    * Changed default value of USE_ARG_LIST to True - this affects the beavhior of all **@options** commands
+        * **WARNING**: This breaks backwards compatibility, to restore backwards compatibility, add this to the
+          **__init__()** method in your custom class derived from cmd2.Cmd:
+            * set_use_arg_list(False)
+        * This change improves argument parsing for all new applications
 
 0.7.2
 -----

cmd2.py

@@ -87,7 +87,7 @@
 except ImportError:
     pass
 
-__version__ = '0.7.3a'
+__version__ = '0.7.3'
 
 # Pyparsing enablePackrat() can greatly speed up parsing, but problems have been seen in Python 3 in the past
 pyparsing.ParserElement.enablePackrat()
@@ -97,8 +97,8 @@
 
 
 # The next 3 variables and associated setter functions effect how arguments are parsed for commands using @options.
-# The defaults are "sane" and maximize backward compatibility with cmd and previous versions of cmd2.
-# But depending on your particular application, you may wish to tweak them so you get the desired parsing behavior.
+# The defaults are "sane" and maximize ease of use for new applications based on cmd2.
+# To maximize backwards compatibility, we recommend setting USE_ARG_LIST to "False"
 
 # Use POSIX or Non-POSIX (Windows) rules for splitting a command-line string into a list of arguments via shlex.split()
 POSIX_SHLEX = False
@@ -107,7 +107,7 @@
 STRIP_QUOTES_FOR_NON_POSIX = True
 
 # For option commands, pass a list of argument strings instead of a single argument string to the do_* methods
-USE_ARG_LIST = False
+USE_ARG_LIST = True
 
 
 def set_posix_shlex(val):

examples/example.py

@@ -9,7 +9,7 @@
 verifying that the output produced matches the transcript.
 """
 
-from cmd2 import Cmd, make_option, options
+from cmd2 import Cmd, make_option, options, set_use_arg_list
 
 
 class CmdLineApp(Cmd):
@@ -26,6 +26,9 @@ def __init__(self):
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         Cmd.__init__(self, use_ipython=False)
 
+        # For option commands, pass a single argument string instead of a list of argument strings to the do_* methods
+        set_use_arg_list(False)
+
     @options([make_option('-p', '--piglatin', action="store_true", help="atinLay"),
               make_option('-s', '--shout', action="store_true", help="N00B EMULATION MODE"),
               make_option('-r', '--repeat', type="int", help="output [n] times")

examples/python_scripting.py

@@ -19,9 +19,6 @@
 
 from cmd2 import Cmd, options, make_option, CmdResult, set_use_arg_list
 
-# For option commands, pass a list of argument strings instead of a single argument string to the do_* methods
-set_use_arg_list(True)
-
 
 class CmdLineApp(Cmd):
     """ Example cmd2 application to showcase conditional control flow in Python scripting within cmd2 aps. """
@@ -33,6 +30,9 @@ def __init__(self):
         self.autorun_on_edit = False
         self.intro = 'Happy 𝛑 Day.  Note the full Unicode support:  😇  (Python 3 only)  💩'
 
+        # For option commands, pass a list of argument strings instead of a single argument string to the do_* methods
+        set_use_arg_list(True)
+
     def _set_prompt(self):
         """Set prompt so it displays the current working directory."""
         self.cwd = os.getcwd()

setup.py

@@ -5,7 +5,7 @@
 """
 from setuptools import setup
 
-VERSION = '0.7.3a'
+VERSION = '0.7.3'
 DESCRIPTION = "Extra features for standard library's cmd module"
 
 LONG_DESCRIPTION = """cmd2 is an enhancement to the standard library's cmd module for Python 2.7

tests/test_cmd2.py

@@ -22,7 +22,7 @@
 
 
 def test_ver():
-    assert cmd2.__version__ == '0.7.3a'
+    assert cmd2.__version__ == '0.7.3'
 
 
 def test_base_help(base_app):
@@ -227,11 +227,11 @@ def test_base_cmdenvironment(base_app):
         Command-line arguments allowed: True
         Output redirection and pipes allowed: True
         Parsing of @options commands:
-            Use POSIX-style argument parser (vs Windows): False
-            Strip Quotes when using Windows-style argument parser: True
-            Use a list of arguments instead of a single argument string: False
+            Use POSIX-style argument parser (vs Windows): {}
+            Strip Quotes when using Windows-style argument parser: {}
+            Use a list of arguments instead of a single argument string: {}
             
-""")
+""".format(cmd2.POSIX_SHLEX, cmd2.STRIP_QUOTES_FOR_NON_POSIX, cmd2.USE_ARG_LIST))
     assert out == expected
 
 def test_base_load(base_app, request):

tests/test_transcript.py

@@ -15,7 +15,7 @@
 # Used for sm.input: raw_input() for Python 2 or input() for Python 3
 import six.moves as sm
 
-from cmd2 import Cmd, make_option, options, Cmd2TestCase
+from cmd2 import Cmd, make_option, options, Cmd2TestCase, set_use_arg_list
 from conftest import run_cmd, StdOut, normalize
 
 
@@ -28,6 +28,7 @@ def __init__(self, *args, **kwargs):
         # Need to use this older form of invoking super class constructor to support Python 2.x and Python 3.x
         Cmd.__init__(self, *args, **kwargs)
         self.settable.append('maxrepeats   Max number of `--repeat`s allowed')
+        set_use_arg_list(False)
 
     opts = [make_option('-p', '--piglatin', action="store_true", help="atinLay"),
             make_option('-s', '--shout', action="store_true", help="N00B EMULATION MODE"),