Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 1 | """ |
| 2 | atexit.py - allow programmer to define multiple exit functions to be executed |
| 3 | upon normal program termination. |
| 4 | |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 5 | One public function, register, is defined. |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 6 | """ |
| 7 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 8 | __all__ = ["register"] |
| 9 | |
Raymond Hettinger | a9ef5e5 | 2004-12-11 02:49:40 +0000 | [diff] [blame] | 10 | import sys |
| 11 | |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 12 | _exithandlers = [] |
| 13 | def _run_exitfuncs(): |
| 14 | """run any registered exit functions |
| 15 | |
| 16 | _exithandlers is traversed in reverse order so functions are executed |
| 17 | last in, first out. |
| 18 | """ |
Tim Peters | 146965a | 2001-01-14 18:09:23 +0000 | [diff] [blame] | 19 | |
Skip Montanaro | 599bd5e | 2004-11-04 04:31:30 +0000 | [diff] [blame] | 20 | exc_info = None |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 21 | while _exithandlers: |
Tim Peters | 384fd10 | 2001-01-21 03:40:37 +0000 | [diff] [blame] | 22 | func, targs, kargs = _exithandlers.pop() |
Skip Montanaro | 599bd5e | 2004-11-04 04:31:30 +0000 | [diff] [blame] | 23 | try: |
| 24 | func(*targs, **kargs) |
| 25 | except SystemExit: |
| 26 | exc_info = sys.exc_info() |
| 27 | except: |
Raymond Hettinger | a9ef5e5 | 2004-12-11 02:49:40 +0000 | [diff] [blame] | 28 | import traceback |
Skip Montanaro | 599bd5e | 2004-11-04 04:31:30 +0000 | [diff] [blame] | 29 | print >> sys.stderr, "Error in atexit._run_exitfuncs:" |
| 30 | traceback.print_exc() |
| 31 | exc_info = sys.exc_info() |
| 32 | |
| 33 | if exc_info is not None: |
| 34 | raise exc_info[0], exc_info[1], exc_info[2] |
| 35 | |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 36 | |
| 37 | def register(func, *targs, **kargs): |
| 38 | """register a function to be executed upon normal program termination |
| 39 | |
| 40 | func - function to be called at exit |
| 41 | targs - optional arguments to pass to func |
| 42 | kargs - optional keyword arguments to pass to func |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame^] | 43 | |
| 44 | func is returned to facilitate usage as a decorator. |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 45 | """ |
| 46 | _exithandlers.append((func, targs, kargs)) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame^] | 47 | return func |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 48 | |
Tim Peters | 012b69c | 2002-07-16 19:30:59 +0000 | [diff] [blame] | 49 | if hasattr(sys, "exitfunc"): |
| 50 | # Assume it's another registered exit function - append it to our list |
| 51 | register(sys.exitfunc) |
| 52 | sys.exitfunc = _run_exitfuncs |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 53 | |
| 54 | if __name__ == "__main__": |
| 55 | def x1(): |
| 56 | print "running x1" |
| 57 | def x2(n): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 58 | print "running x2(%r)" % (n,) |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 59 | def x3(n, kwd=None): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 60 | print "running x3(%r, kwd=%r)" % (n, kwd) |
Fred Drake | c19425d | 2000-06-28 15:07:31 +0000 | [diff] [blame] | 61 | |
| 62 | register(x1) |
| 63 | register(x2, 12) |
| 64 | register(x3, 5, "bar") |
| 65 | register(x3, "no kwd args") |