Refactor exit_code implementation

cmd2.Cmd.cmdloop() now returns self.exit_code which should be an integer

Also:
- Refactored examples to call sys.exit(app.cmdloop()) in their __main__
- Running transcript tests now sets the exit_code accordingly based on success/failure
- Updated CHANGELOG
- Updated README
- Updated Sphinx docs
- Added unit test for case when transcript test fails

1 files changed, 5 insertions, 1 deletions

diff --git a/examples/pirate.py b/examples/pirate.py
index 994ca245..9abbe4e6 100755
--- a/examples/pirate.py
+++ b/examples/pirate.py
@@ -55,6 +55,7 @@ class Pirate(cmd2.Cmd):
             self.poutput('Now we gots {0} doubloons'.format(self.gold))
         if self.gold < 0:
             self.poutput("Off to debtorrr's prison.")
+            self.exit_code = -1
             stop = True
         return stop
 
@@ -99,6 +100,9 @@ class Pirate(cmd2.Cmd):
 
 
 if __name__ == '__main__':
+    import sys
     # Create an instance of the Pirate derived class and enter the REPL with cmdlooop().
     pirate = Pirate()
-    pirate.cmdloop()
+    sys_exit_code = pirate.cmdloop()
+    print('Exiting with code: {!r}'.format(sys_exit_code))
+    sys.exit(sys_exit_code)