Merge pull request #739 from python-cmd2/presentation_stuff

Presentation stuff

Author: kmvanbrunt

CHANGELOG.md

@@ -5,6 +5,8 @@
     * 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
+    * Fixed issue where run_pyscript failed if the script's filename had 2 or more consecutive spaces
+    * Fixed issue where completer function of disabled command would still run
 * 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)

CONTRIBUTING.md

@@ -192,7 +192,7 @@ $ git push origin [name_of_your_new_branch]
 
 
 ### Setting up for cmd2 development
-For doing cmd2 development, it is recommended you create a virutal environment using Conda or Virtualenv and install the 
+For doing cmd2 development, it is recommended you create a virtual environment using Conda or Virtualenv and install the 
 package from the source.
 
 #### Create a new environment for cmd2 using Pipenv
@@ -234,7 +234,7 @@ pyenv versions
 # Install python version defined
 pyenv install 3.6.3
 ```
-With the Python version installed, you can set the virutalenv properly. 
+With the Python version installed, you can set the virtualenv properly. 
 
 ```sh
 $ cd ~/src/cmd2

cmd2/cmd2.py

@@ -359,15 +359,13 @@ def is_valid_command(self, word: str) -> Tuple[bool, str]:
                 errmsg = ''
         return valid, errmsg
 
-    def tokenize(self, line: str, expand: bool = True) -> List[str]:
+    def tokenize(self, line: str, *, expand: bool = True) -> List[str]:
         """
         Lex a string into a list of tokens. Shortcuts and aliases are expanded and comments are removed
 
         :param line: the command line being lexed
         :param expand: If True, then aliases and shortcuts will be expanded.
-                       Set this to False if no expansion should occur because the command name is already known.
-                       Otherwise the command could be expanded if it matched an alias name. This is for cases where
-                       a do_* method was called manually (e.g do_help('alias').
+                       Set this to False if the command token should not be altered. Defaults to True.
         :return: A list of tokens
         :raises ValueError if there are unclosed quotation marks.
         """
@@ -387,18 +385,16 @@ def tokenize(self, line: str, expand: bool = True) -> List[str]:
         tokens = self._split_on_punctuation(tokens)
         return tokens
 
-    def parse(self, line: str, expand: bool = True) -> Statement:
+    def parse(self, line: str, *, expand: bool = True) -> Statement:
         """
         Tokenize the input and parse it into a Statement object, stripping
         comments, expanding aliases and shortcuts, and extracting output
         redirection directives.
 
         :param line: the command line being parsed
         :param expand: If True, then aliases and shortcuts will be expanded.
-                       Set this to False if no expansion should occur because the command name is already known.
-                       Otherwise the command could be expanded if it matched an alias name. This is for cases where
-                       a do_* method was called manually (e.g do_help('alias').
-        :return: A parsed Statement
+                       Set this to False if the command token should not be altered. Defaults to True.
+        :return: the created Statement
         :raises ValueError if there are unclosed quotation marks
         """
 
@@ -414,7 +410,7 @@ def parse(self, line: str, expand: bool = True) -> Statement:
         arg_list = []
 
         # lex the input into a list of tokens
-        tokens = self.tokenize(line, expand)
+        tokens = self.tokenize(line, expand=expand)
 
         # of the valid terminators, find the first one to occur in the input
         terminator_pos = len(tokens) + 1
@@ -533,11 +529,10 @@ def parse(self, line: str, expand: bool = True) -> Statement:
                               suffix=suffix,
                               pipe_to=pipe_to,
                               output=output,
-                              output_to=output_to,
-                              )
+                              output_to=output_to)
         return statement
 
-    def parse_command_only(self, rawinput: str) -> Statement:
+    def parse_command_only(self, rawinput: str, *, expand: bool = True) -> Statement:
         """Partially parse input into a Statement object.
 
         The command is identified, and shortcuts and aliases are expanded.
@@ -560,9 +555,17 @@ def parse_command_only(self, rawinput: str) -> Statement:
         Different from parse(), this method does not remove redundant whitespace
         within args. However, it does ensure args has no leading or trailing
         whitespace.
+
+        :param rawinput: the command line as entered by the user
+        :param expand: If True, then aliases and shortcuts will be expanded.
+                       Set this to False if the command token should not be altered. Defaults to True.
+        :return: the created Statement
         """
+        line = rawinput
+
         # expand shortcuts and aliases
-        line = self._expand(rawinput)
+        if expand:
+            line = self._expand(rawinput)
 
         command = ''
         args = ''
@@ -591,8 +594,7 @@ def parse_command_only(self, rawinput: str) -> Statement:
         statement = Statement(args,
                               raw=rawinput,
                               command=command,
-                              multiline_command=multiline_command,
-                              )
+                              multiline_command=multiline_command)
         return statement
 
     def get_command_arg_list(self, command_name: str, to_parse: Union[Statement, str],

cmd2/parsing.py

@@ -25,11 +25,8 @@ def is_quoted(arg: str) -> bool:
     return len(arg) > 1 and arg[0] == arg[-1] and arg[0] in constants.QUOTES
 
 
-def quote_string_if_needed(arg: str) -> str:
-    """ Quotes a string if it contains spaces and isn't already quoted """
-    if is_quoted(arg) or ' ' not in arg:
-        return arg
-
+def quote_string(arg: str) -> str:
+    """Quote a string"""
     if '"' in arg:
         quote = "'"
     else:
@@ -38,8 +35,16 @@ def quote_string_if_needed(arg: str) -> str:
     return quote + arg + quote
 
 
+def quote_string_if_needed(arg: str) -> str:
+    """Quote a string if it contains spaces and isn't already quoted"""
+    if is_quoted(arg) or ' ' not in arg:
+        return arg
+
+    return quote_string(arg)
+
+
 def strip_quotes(arg: str) -> str:
-    """ Strip outer quotes from a string.
+    """Strip outer quotes from a string.
 
      Applies to both single and double quotes.
 

cmd2/utils.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# coding=utf-8
+"""A simple example demonstrating support for unicode command names.
+"""
+import math
+import cmd2
+
+
+class UnicodeApp(cmd2.Cmd):
+    """Example cmd2 application with unicode command names."""
+
+    def __init__(self):
+        super().__init__()
+        self.intro = 'Welcome the Unicode example app. Note the full Unicode support:  😇 💩'
+
+    def do_𝛑print(self, _):
+        """This command prints 𝛑 to 5 decimal places."""
+        self.poutput("𝛑 = {0:.6}".format(math.pi))
+
+    def do_你好(self, arg):
+        """This command says hello in Chinese (Mandarin)."""
+        self.poutput("你好 " + arg)
+
+
+if __name__ == '__main__':
+    app = UnicodeApp()
+    app.cmdloop()

examples/migrating.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+# coding=utf-8
+# flake8: noqa F821
+"""
+Example demonstrating that calling run_pyscript recursively inside another Python script isn't allowed
+"""
+import os
+
+app.cmd_echo = True
+my_dir = (os.path.dirname(os.path.realpath(sys.argv[0])))
+app('run_pyscript {}'.format(os.path.join(my_dir, 'stop.py')))

examples/unicode_commands.py

@@ -0,0 +1,6 @@
+# flake8: noqa F821
+import os
+
+app.cmd_echo = True
+my_dir = (os.path.dirname(os.path.realpath(sys.argv[0])))
+run(os.path.join(my_dir, 'to_run.py'))

tests/scripts/raises_exception.py renamed to tests/pyscript/raises_exception.py

@@ -0,0 +1,2 @@
+# flake8: noqa F821
+print("I have been run")