summaryrefslogtreecommitdiff
path: root/examples/exit_code.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-09-04 22:50:09 -0700
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-09-04 22:50:09 -0700
commit59969dd42694d4b1d11cd1be11adf2d6db41df55 (patch)
tree6f09b671b0f8af98684ca008a0ff8aeceeeb9ea1 /examples/exit_code.py
parent1daf5d2cb63145408520f39c799425a82b2ec948 (diff)
parent1641f54458686eace59bb195fda0e78fb2ecb83f (diff)
downloadcmd2-git-59969dd42694d4b1d11cd1be11adf2d6db41df55.tar.gz
Merged master in and resolved conflicts
@kotfu - I hope this doesn't screw you up, but I wanted to minimize some of the merge pain that will likely be coming up soon
Diffstat (limited to 'examples/exit_code.py')
-rwxr-xr-xexamples/exit_code.py43
1 files changed, 43 insertions, 0 deletions
diff --git a/examples/exit_code.py b/examples/exit_code.py
new file mode 100755
index 00000000..8ae2d310
--- /dev/null
+++ b/examples/exit_code.py
@@ -0,0 +1,43 @@
+#!/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
+ self.poutput('{!r} exiting with code: {}'.format(sys.argv[0], code))
+
+
+if __name__ == '__main__':
+ app = ReplWithExitCode()
+ app.cmdloop()