diff options
| -rw-r--r-- | CHANGELOG.md | 3 | ||||
| -rw-r--r-- | cmd2/cmd2.py | 6 | ||||
| -rw-r--r-- | docs/unfreefeatures.rst | 7 | ||||
| -rwxr-xr-x | examples/exit_code.py | 45 |
4 files changed, 61 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index e08e5a75..7fbc7594 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,9 @@ ## 0.9.5 (TBD, 2018) * Bug Fixes * Fixed bug where ``get_all_commands`` could return non-callable attributes +* Enhancements + * Added ``exit_code`` attribute of ``cmd2.Cmd`` class + * Enables applications to return a non-zero exit code when exiting from ``cmdloop`` ## 0.9.4 (August 21, 2018) * Bug Fixes diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index 58972232..a17e128f 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -523,6 +523,9 @@ class Cmd(cmd.Cmd): # This boolean flag determines whether or not the cmd2 application can interact with the clipboard self.can_clip = can_clip + # This determines if a non-zero exit code should be used when exiting the application + self.exit_code = None + # ----- Methods related to presenting output to the user ----- @property @@ -3227,6 +3230,9 @@ Script should contain one command per line, just like command would be typed in func() self.postloop() + if self.exit_code is not None: + sys.exit(self.exit_code) + ### # # plugin related functions diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 41144c8f..cd27745d 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -182,3 +182,10 @@ Presents numbered options to user, as bash ``select``. 2. salty Sauce? 2 wheaties with salty sauce, yum! + + +Exit code to shell +================== +The ``self.exit_code`` attribute of your ``cmd2`` application controls +what exit code is sent to the shell when your application exits from +``cmdloop()``. diff --git a/examples/exit_code.py b/examples/exit_code.py new file mode 100755 index 00000000..e5a896da --- /dev/null +++ b/examples/exit_code.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python +# coding=utf-8 +"""A simple example demonstrating the following how to emit a non-zero exit code in your cmd2 application. +""" +import cmd2 +import sys +from typing import List + + +class ReplWithExitCode(cmd2.Cmd): + """ Example cmd2 application where we can specify an exit code when existing.""" + + def __init__(self): + super().__init__() + + @cmd2.with_argument_list + def do_exit(self, arg_list: List[str]) -> bool: + """Exit the application with an optional exit code. + +Usage: exit [exit_code] + Where: + * exit_code - integer exit code to return to the shell +""" + # If an argument was provided + if arg_list: + try: + self.exit_code = int(arg_list[0]) + except ValueError: + self.perror("{} isn't a valid integer exit code".format(arg_list[0])) + self.exit_code = -1 + + self._should_quit = True + return self._STOP_AND_EXIT + + def postloop(self) -> None: + """Hook method executed once when the cmdloop() method is about to return. + + """ + code = self.exit_code if self.exit_code is not None else 0 + print('{!r} exiting with code: {}'.format(sys.argv[0], code)) + + +if __name__ == '__main__': + app = ReplWithExitCode() + app.cmdloop() |