Merge pull request #353 from python-cmd2/unhackify

Unhackify

Author: kmvanbrunt

.gitignore

@@ -1,11 +1,19 @@
+# Python development, test, and build
 __pycache__
 build
 dist
 cmd2.egg-info
-.idea
 .cache
 *.pyc
-.coverage
 .tox
-htmlcov
 .pytest_cache
+
+# Code Coverage
+.coverage
+htmlcov
+
+# PyCharm
+.idea
+
+# Visual Studio Code
+.vscode

CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.8.5 (April 15, 2018)
+* Bug Fixes
+    * Fixed a bug with all argument decorators where the wrapped function wasn't returning a value and thus couldn't cause the cmd2 app to quit
+
+* Enhancements
+    * Added support for verbose help with -v where it lists a brief summary of what each command does
+    * Added support for categorizing commands into groups within the help menu
+        * See the [Grouping Commands](http://cmd2.readthedocs.io/en/latest/argument_processing.html?highlight=verbose#grouping-commands) section of the docs for more info
+        * See [help_categories.py](https://github.com/python-cmd2/cmd2/blob/master/examples/help_categories.py) for an example
+    * Tab completion of paths now supports ~user user path expansion
+    * Simplified implementation of various tab completion functions so they no longer require ``ctypes``
+    * Expanded documentation of ``display_matches`` list to clarify its purpose. See cmd2.py for this documentation.
+    * Adding opening quote to tab completion if any of the matches have a space.
+
+* **Python 2 EOL notice**
+    * This is the last release where new features will be added to ``cmd2`` for Python 2.7
+    * The 0.9.0 release of ``cmd2`` will support Python 3.4+ only
+    * Additional 0.8.x releases may be created to supply bug fixes for Python 2.7 up until August 31, 2018
+    * After August 31, 2018 not even bug fixes will be provided for Python 2.7
+
 ## 0.8.4 (April 10, 2018)
 * Bug Fixes
     * Fixed conditional dependency issue in setup.py that was in 0.8.3.

cmd2.py

@@ -62,7 +62,7 @@
 # The short X.Y version.
 version = '0.8'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.4'
+release = '0.8.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -8,8 +8,8 @@
 from cmd2 import with_argparser, with_argument_list
 
 # List of strings used with flag and index based completion functions
-food_item_strs = ['Pizza', 'Hamburger', 'Ham', 'Potato']
-sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football']
+food_item_strs = ['Pizza', 'Ham', 'Ham Sandwich', 'Potato']
+sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football', 'Space Ball']
 
 
 class TabCompleteExample(cmd2.Cmd):

examples/tab_completion.py

@@ -8,7 +8,7 @@
 import setuptools
 from setuptools import setup
 
-VERSION = '0.8.4'
+VERSION = '0.8.5'
 DESCRIPTION = "cmd2 - a tool for building interactive command line applications in Python"
 LONG_DESCRIPTION = """cmd2 is a tool for building interactive command line applications in Python. Its goal is to make 
 it quick and easy for developers to build feature-rich and user-friendly interactive command line applications.  It 

setup.py

@@ -26,7 +26,7 @@
 
 
 def test_ver():
-    assert cmd2.__version__ == '0.8.4'
+    assert cmd2.__version__ == '0.8.5'
 
 
 def test_empty_statement(base_app):

tests/test_cmd2.py

@@ -29,16 +29,17 @@
         pass
 
 
-@pytest.fixture
-def cmd2_app():
-    c = cmd2.Cmd()
-    return c
-
-
 # List of strings used with completion functions
-food_item_strs = ['Pizza', 'Hamburger', 'Ham', 'Potato']
+food_item_strs = ['Pizza', 'Ham', 'Ham Sandwich', 'Potato']
 sport_item_strs = ['Bat', 'Basket', 'Basketball', 'Football', 'Space Ball']
-delimited_strs = ['/home/user/file.txt', '/home/user/prog.c', '/home/otheruser/maps']
+delimited_strs = \
+    [
+        '/home/user/file.txt',
+        '/home/user/file space.txt',
+        '/home/user/prog.c',
+        '/home/other user/maps',
+        '/home/other user/tests'
+    ]
 
 # Dictionary used with flag based completion functions
 flag_dict = \
@@ -59,6 +60,33 @@ def cmd2_app():
         2: sport_item_strs,           # Tab-complete sport items at index 2 in command line
     }
 
+
+class CompletionsExample(cmd2.Cmd):
+    """
+    Example cmd2 application used to exercise tab-completion tests
+    """
+    def __init__(self):
+        cmd2.Cmd.__init__(self)
+
+    def do_test_basic(self, args):
+        pass
+
+    def complete_test_basic(self, text, line, begidx, endidx):
+        return self.basic_complete(text, line, begidx, endidx, food_item_strs)
+
+    def do_test_delimited(self, args):
+        pass
+
+    def complete_test_delimited(self, text, line, begidx, endidx):
+        return self.delimiter_complete(text, line, begidx, endidx, delimited_strs, '/')
+
+
+@pytest.fixture
+def cmd2_app():
+    c = CompletionsExample()
+    return c
+
+
 def complete_tester(text, line, begidx, endidx, app):
     """
     This is a convenience function to test cmd2.complete() since
@@ -425,12 +453,12 @@ def test_delimiter_completion(cmd2_app):
 
     cmd2_app.delimiter_complete(text, line, begidx, endidx, delimited_strs, '/')
 
-    # Remove duplicates from display_matches and sort it. This is typically done in the display function.
+    # Remove duplicates from display_matches and sort it. This is typically done in complete().
     display_set = set(cmd2_app.display_matches)
     display_list = list(display_set)
     display_list.sort()
 
-    assert display_list == ['otheruser', 'user']
+    assert display_list == ['other user', 'user']
 
 def test_flag_based_completion_single(cmd2_app):
     text = 'Pi'
@@ -638,6 +666,113 @@ def test_parseline_expands_shortcuts(cmd2_app):
     assert args == 'cat foobar.txt'
     assert line.replace('!', 'shell ') == out_line
 
+def test_add_opening_quote_basic_no_text(cmd2_app):
+    text = ''
+    line = 'test_basic {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    # The whole list will be returned with no opening quotes added
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and cmd2_app.completion_matches == sorted(food_item_strs)
+
+def test_add_opening_quote_basic_nothing_added(cmd2_app):
+    text = 'P'
+    line = 'test_basic {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and cmd2_app.completion_matches == ['Pizza', 'Potato']
+
+def test_add_opening_quote_basic_quote_added(cmd2_app):
+    text = 'Ha'
+    line = 'test_basic {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected = sorted(['"Ham', '"Ham Sandwich'])
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and cmd2_app.completion_matches == expected
+
+def test_add_opening_quote_basic_text_is_common_prefix(cmd2_app):
+    # This tests when the text entered is the same as the common prefix of the matches
+    text = 'Ham'
+    line = 'test_basic {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected = sorted(['"Ham', '"Ham Sandwich'])
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and cmd2_app.completion_matches == expected
+
+def test_add_opening_quote_delimited_no_text(cmd2_app):
+    text = ''
+    line = 'test_delimited {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    # The whole list will be returned with no opening quotes added
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and cmd2_app.completion_matches == sorted(delimited_strs)
+
+def test_add_opening_quote_delimited_nothing_added(cmd2_app):
+    text = '/ho'
+    line = 'test_delimited {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected_matches = sorted(delimited_strs)
+    expected_display = sorted(['other user', 'user'])
+
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and \
+           cmd2_app.completion_matches == expected_matches and \
+           cmd2_app.display_matches == expected_display
+
+def test_add_opening_quote_delimited_quote_added(cmd2_app):
+    text = '/home/user/fi'
+    line = 'test_delimited {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected_common_prefix = '"/home/user/file'
+    expected_display = sorted(['file.txt', 'file space.txt'])
+
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and \
+           os.path.commonprefix(cmd2_app.completion_matches) == expected_common_prefix and \
+           cmd2_app.display_matches == expected_display
+
+def test_add_opening_quote_delimited_text_is_common_prefix(cmd2_app):
+    # This tests when the text entered is the same as the common prefix of the matches
+    text = '/home/user/file'
+    line = 'test_delimited {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected_common_prefix = '"/home/user/file'
+    expected_display = sorted(['file.txt', 'file space.txt'])
+
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and \
+           os.path.commonprefix(cmd2_app.completion_matches) == expected_common_prefix and \
+           cmd2_app.display_matches == expected_display
+
+def test_add_opening_quote_delimited_space_in_prefix(cmd2_app):
+    # This test when a space appears before the part of the string that is the display match
+    text = '/home/oth'
+    line = 'test_delimited {}'.format(text)
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    expected_common_prefix = '"/home/other user/'
+    expected_display = ['maps', 'tests']
+
+    first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
+    assert first_match is not None and \
+           os.path.commonprefix(cmd2_app.completion_matches) == expected_common_prefix and \
+           cmd2_app.display_matches == expected_display
 
 class SubcommandsExample(cmd2.Cmd):
     """
@@ -787,19 +922,6 @@ def test_subcommand_tab_completion_with_no_completer(sc_app):
     first_match = complete_tester(text, line, begidx, endidx, sc_app)
     assert first_match is None
 
-def test_subcommand_tab_completion_add_quote(sc_app):
-    # This makes sure an opening quote is added to the readline line buffer
-    text = 'Space'
-    line = 'base sport {}'.format(text)
-    endidx = len(line)
-    begidx = endidx - len(text)
-
-    first_match = complete_tester(text, line, begidx, endidx, sc_app)
-
-    # No matches are returned when an opening quote is added to the screen
-    assert first_match is None
-    assert readline.get_line_buffer() == 'base sport "Space Ball" '
-
 def test_subcommand_tab_completion_space_in_text(sc_app):
     text = 'B'
     line = 'base sport "Space {}'.format(text)