Merge pull request #125 from python-cmd2/script_arguments

Added new pyscript command

Author: tleonhardt

CHANGES.md

@@ -11,6 +11,7 @@ News
 * 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
 
 0.7.2
 -----

README.md

@@ -155,8 +155,9 @@ example/exampleSession.txt:
 
 Documented commands (type help <topic>):
 ========================================
-_relative_load  edit  help     list  orate  py    run   say  shell      show
-cmdenvironment  eof   history  load  pause  quit  save  set  shortcuts  speak
+_relative_load  help     orate  pyscript  save  shell      speak
+cmdenvironment  history  pause  quit      say   shortcuts
+edit            load     py     run       set   show
 
 (Cmd) help say
 Repeats what you tell me to.

cmd2.py

@@ -1583,6 +1583,42 @@ def quit():
             self._in_py = False
         return self._should_quit
 
+    # noinspection PyUnusedLocal
+    @options([], arg_desc='<script_path> [script_arguments]')
+    def do_pyscript(self, arg, opts=None):
+        """\nRuns a python script file inside the console
+
+Console commands can be executed inside this script with cmd("your command")
+However, you cannot run nested "py" or "pyscript" commands from within this script
+Paths or arguments that contain spaces must be enclosed in quotes
+"""
+        if not arg:
+            self.perror("pyscript command requires at least 1 argument ...", traceback_war=False)
+            self.do_help('pyscript')
+            return
+
+        if not USE_ARG_LIST:
+            arg = shlex.split(arg, posix=POSIX_SHLEX)
+
+        # Get the absolute path of the script
+        script_path = os.path.abspath(os.path.expanduser(arg[0]))
+
+        # Save current command line arguments
+        orig_args = sys.argv
+
+        # Overwrite sys.argv to allow the script to take command line arguments
+        sys.argv = [script_path]
+        sys.argv.extend(arg[1:])
+
+        # Run the script
+        self.do_py("run('{}')".format(arg[0]))
+
+        # Restore command line arguments to original state
+        sys.argv = orig_args
+
+    # Enable tab completion of paths for pyscript command
+    complete_pyscript = path_complete
+
     # Only include the do_ipy() method if IPython is available on the system
     if ipython_available:
         # noinspection PyMethodMayBeStatic,PyUnusedLocal

examples/arg_printer.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+# coding=utf-8
+import sys
+print("Running Python script {!r} which was called with {} arguments".format(sys.argv[0], len(sys.argv) - 1))
+for i, arg in enumerate(sys.argv[1:]):
+    print("arg {}: {!r}".format(i+1, arg))

examples/exampleSession.txt

@@ -3,8 +3,9 @@
 
 Documented commands (type help <topic>):
 ========================================
-_relative_load  edit  history  orate  py    run   say  shell      show
-cmdenvironment  help  load     pause  quit  save  set  shortcuts  speak
+_relative_load  help     orate  pyscript  save  shell      speak
+cmdenvironment  history  pause  quit      say   shortcuts
+edit            load     py     run       set   show
 
 (Cmd) help say
 Repeats what you tell me to.

tests/conftest.py

@@ -15,8 +15,8 @@
 # Help text for base cmd2.Cmd application
 BASE_HELP = """Documented commands (type help <topic>):
 ========================================
-_relative_load  edit  history  pause  quit  save  shell      show
-cmdenvironment  help  load     py     run   set   shortcuts
+_relative_load  edit  history  pause  pyscript  run   set    shortcuts
+cmdenvironment  help  load     py     quit      save  shell  show
 """
 
 # Help text for the history command

tests/test_transcript.py

@@ -106,8 +106,9 @@ def test_base_with_transcript(_cmdline_app):
 
 Documented commands (type help <topic>):
 ========================================
-_relative_load  edit  history  orate  py    run   say  shell      show
-cmdenvironment  help  load     pause  quit  save  set  shortcuts  speak
+_relative_load  help     orate  pyscript  save  shell      speak
+cmdenvironment  history  pause  quit      say   shortcuts
+edit            load     py     run       set   show
 
 (Cmd) help say
 Repeats what you tell me to.

tests/transcript.txt

@@ -2,8 +2,9 @@
 
 Documented commands (type help <topic>):
 ========================================
-_relative_load  edit  history  orate  py    run   say  shell      show
-cmdenvironment  help  load     pause  quit  save  set  shortcuts  speak
+_relative_load  help     orate  pyscript  save  shell      speak
+cmdenvironment  history  pause  quit      say   shortcuts
+edit            load     py     run       set   show
 
 (Cmd) help say
 Repeats what you tell me to.