summaryrefslogtreecommitdiff
path: root/examples/exit_code.py
blob: 8ae2d310479b8478332c5977930e8fc275111b8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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()