Merge pull request #737 from python-cmd2/renames

Changes made while preparing for PyOhio presentation

Author: tleonhardt

CHANGELOG.md

@@ -4,6 +4,7 @@
     * Fixed bug where `history -v` was sometimes showing raw and expanded commands when they weren't different
     * Fixed bug where multiline commands were having leading and ending spaces stripped. This would mess up quoted
     strings that crossed multiple lines.
+    * Fixed a bug when appending to the clipboard where contents were in reverse order
 * Enhancements
     * Greatly simplified using argparse-based tab completion. The new interface is a complete overhaul that breaks
     the previous way of specifying completion and choices functions. See header of [argparse_custom.py](https://github.com/python-cmd2/cmd2/blob/master/cmd2/argparse_custom.py)
@@ -31,6 +32,9 @@
     sort, but it can be changed to a natural sort by setting the value to NATURAL_SORT_KEY.
     * `StatementParser` now expects shortcuts to be passed in as dictionary. This eliminates the step of converting the
     shortcuts dictionary into a tuple before creating `StatementParser`.
+    * Renamed `Cmd.pyscript_name` to `Cmd.py_bridge_name`
+    * Renamed `Cmd.pystate` to `Cmd.py_locals`
+    * Renamed `PyscriptBridge` to `PyBridge`
 
 ## 0.9.14 (June 29, 2019)
 * Enhancements
@@ -122,7 +126,7 @@
     of a `cmd2` based app, you will need to update your code to use `.history.get(1).statement.raw` instead.
     * Removed internally used `eos` command that was used to keep track of when a text script's commands ended
     * Removed `cmd2` member called `_STOP_AND_EXIT` since it was just a boolean value that should always be True
-    * Removed `cmd2` member called `_should_quit` since `PyscriptBridge` now handles this logic
+    * Removed `cmd2` member called `_should_quit` since `PyBridge` now handles this logic
     * Removed support for `cmd.cmdqueue`
     * `allow_cli_args` is now an argument to __init__ instead of a `cmd2` class member
 * **Python 3.4 EOL notice**

cmd2/__init__.py

@@ -15,4 +15,4 @@
 from .cmd2 import Cmd, Statement, EmptyStatement, categorize
 from .cmd2 import with_argument_list, with_argparser, with_argparser_and_unknown_args, with_category
 from .constants import DEFAULT_SHORTCUTS
-from .pyscript_bridge import CommandResult
+from .py_bridge import CommandResult

cmd2/argparse_completer.py

@@ -7,6 +7,7 @@
 """
 
 import argparse
+import numbers
 import shutil
 from typing import List, Union
 
@@ -499,6 +500,11 @@ def _resolve_choices_for_arg(self, arg: argparse.Action, used_values=()) -> List
         # Since arg_choices can be any iterable type, convert to a list
         arg_choices = list(arg_choices)
 
+        # If these choices are numbers, and have not yet been sorted, then sort them now
+        if not self._cmd2_app.matches_sorted and all(isinstance(x, numbers.Number) for x in arg_choices):
+            arg_choices.sort()
+            self._cmd2_app.matches_sorted = True
+
         # Since choices can be various types like int, we must convert them to strings
         for index, choice in enumerate(arg_choices):
             if not isinstance(choice, str):

cmd2/argparse_custom.py

@@ -154,13 +154,13 @@ def my_completer_function(text, line, begidx, endidx):
 
 from .ansi import ansi_aware_write, style_error
 
+# Used in nargs ranges to signify there is no maximum
+INFINITY = float('inf')
+
 ############################################################################################################
 # The following are names of custom argparse argument attributes added by cmd2
 ############################################################################################################
 
-# Used in nargs ranges to signify there is no maximum
-INFINITY = float('inf')
-
 # A tuple specifying nargs as a range (min, max)
 ATTR_NARGS_RANGE = 'nargs_range'
 

cmd2/cmd2.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 """
-Bridges calls made inside of a pyscript with the Cmd2 host app while maintaining a reasonable
+Bridges calls made inside of a Python environment to the Cmd2 host app while maintaining a reasonable
 degree of isolation between the two
 """
 
@@ -53,7 +53,7 @@ def __bool__(self) -> bool:
             return not self.stderr
 
 
-class PyscriptBridge(object):
+class PyBridge(object):
     """Provides a Python API wrapper for application commands."""
     def __init__(self, cmd2_app):
         self._cmd2_app = cmd2_app
@@ -70,7 +70,7 @@ def __dir__(self):
 
     def __call__(self, command: str, echo: Optional[bool] = None) -> CommandResult:
         """
-        Provide functionality to call application commands by calling PyscriptBridge
+        Provide functionality to call application commands by calling PyBridge
         ex: app('help')
         :param command: command line being run
         :param echo: if True, output will be echoed to stdout/stderr while the command runs
@@ -95,7 +95,7 @@ def __call__(self, command: str, echo: Optional[bool] = None) -> CommandResult:
             self._cmd2_app.stdout = copy_cmd_stdout
             with redirect_stdout(copy_cmd_stdout):
                 with redirect_stderr(copy_stderr):
-                    stop = self._cmd2_app.onecmd_plus_hooks(command, pyscript_bridge_call=True)
+                    stop = self._cmd2_app.onecmd_plus_hooks(command, py_bridge_call=True)
         finally:
             with self._cmd2_app.sigint_protection:
                 self._cmd2_app.stdout = copy_cmd_stdout.inner_stream

cmd2/pyscript_bridge.py cmd2/py_bridge.pycmd2/pyscript_bridge.py renamed to cmd2/py_bridge.py

@@ -2,7 +2,7 @@
 app.cmd_echo = True
 app('help')
 
-# This will set stop to True in the PyscriptBridge
+# This will set stop to True in the PyBridge
 app('quit')
 
 # Exercise py_quit() in unit test

tests/pyscript/stop.py

@@ -13,8 +13,8 @@
 from cmd2.utils import StdSim, basic_complete
 from .conftest import run_cmd, complete_tester
 
-# Lists used in our tests
-static_int_choices_list = [-12, -1, -2, 0, 1, 2]
+# Lists used in our tests (there is a mix of sorted and unsorted on purpose)
+static_int_choices_list = [-1, 1, -2, 2, 0, -12]
 static_choices_list = ['static', 'choices', 'stop', 'here']
 choices_from_function = ['choices', 'function', 'chatty', 'smith']
 choices_from_method = ['choices', 'method', 'most', 'improved']
@@ -353,12 +353,14 @@ def test_autcomp_flag_completion(ac_app, command_and_args, text, completions):
     ('--function', 'ch', ['choices', 'chatty']),
     ('-m', '', choices_from_method),
     ('--method', 'm', ['method', 'most']),
-    ('-i', '', [str(i) for i in static_int_choices_list]),
+    ('-i', '', static_int_choices_list),
     ('--int', '1', ['1 ']),
-    ('--int', '-', ['-12', '-1', '-2']),
-    ('--int', '-1', ['-12', '-1'])
+    ('--int', '-', [-1, -2, -12]),
+    ('--int', '-1', [-1, -12])
 ])
 def test_autocomp_flag_choices_completion(ac_app, flag, text, completions):
+    import numbers
+
     line = 'choices {} {}'.format(flag, text)
     endidx = len(line)
     begidx = endidx - len(text)
@@ -369,7 +371,14 @@ def test_autocomp_flag_choices_completion(ac_app, flag, text, completions):
     else:
         assert first_match is None
 
-    assert ac_app.completion_matches == sorted(completions, key=ac_app.default_sort_key)
+    # Numbers will be sorted in ascending order and then converted to strings by AutoCompleter
+    if all(isinstance(x, numbers.Number) for x in completions):
+        completions.sort()
+        completions = [str(x) for x in completions]
+    else:
+        completions.sort(key=ac_app.default_sort_key)
+
+    assert ac_app.completion_matches == completions
 
 
 @pytest.mark.parametrize('pos, text, completions', [

tests/test_argparse_completer.py

@@ -331,6 +331,15 @@ def test_run_script_with_binary_file(base_app, request):
     out, err = run_cmd(base_app, 'run_script {}'.format(filename))
     assert "is not an ASCII or UTF-8 encoded text file" in err[0]
 
+def test_run_script_with_python_file(base_app, request):
+    m = mock.MagicMock(name='input', return_value='2')
+    builtins.input = m
+
+    test_dir = os.path.dirname(request.module.__file__)
+    filename = os.path.join(test_dir, 'pyscript', 'stop.py')
+    out, err = run_cmd(base_app, 'run_script {}'.format(filename))
+    assert "appears to be a Python file" in err[0]
+
 def test_run_script_with_utf8_file(base_app, request):
     test_dir = os.path.dirname(request.module.__file__)
     filename = os.path.join(test_dir, 'scripts', 'utf8.txt')

tests/test_cmd2.py

@@ -3,11 +3,18 @@
 """
 Unit/functional testing for run_pytest in cmd2
 """
+import builtins
 import os
-from cmd2 import plugin
 
+from cmd2 import plugin
 from .conftest import run_cmd
 
+# Python 3.5 had some regressions in the unitest.mock module, so use 3rd party mock if available
+try:
+    import mock
+except ImportError:
+    from unittest import mock
+
 HOOK_OUTPUT = "TEST_OUTPUT"
 
 def cmdfinalization_hook(data: plugin.CommandFinalizationData) -> plugin.CommandFinalizationData:
@@ -36,6 +43,15 @@ def test_run_pyscript_with_nonexist_file(base_app):
     out, err = run_cmd(base_app, "run_pyscript {}".format(python_script))
     assert "Error opening script file" in err[0]
 
+def test_run_pyscript_with_non_python_file(base_app, request):
+    m = mock.MagicMock(name='input', return_value='2')
+    builtins.input = m
+
+    test_dir = os.path.dirname(request.module.__file__)
+    filename = os.path.join(test_dir, 'scripts', 'help.txt')
+    out, err = run_cmd(base_app, 'run_pyscript {}'.format(filename))
+    assert "does not have a .py extension" in err[0]
+
 def test_run_pyscript_with_exception(base_app, request):
     test_dir = os.path.dirname(request.module.__file__)
     python_script = os.path.join(test_dir, 'scripts', 'raises_exception.py')