Add framework to execute code on exit from scons.

git-svn-id: http://scons.tigris.org/svn/scons/trunk@25 fdb21ef1-2011-0410-befe-b5e4ea1792b1

diff --git a/src/MANIFEST b/src/MANIFEST
index 88709bac4291fc6ff9fecfae685204988b21eeae..33e888c86e8b0e48d86f23c3a99850b57c5c1037 100644 (file)
--- a/src/MANIFEST
+++ b/src/MANIFEST
@@ -5,6 +5,7 @@ scons/Defaults.py
 scons/Environment.py
 scons/Errors.py
 scons/Job.py
+scons/exitfuncs.py
 scons/Node/__init__.py
 scons/Node/FS.py
 scons/Scanner/__init__.py

diff --git a/src/scons/exitfuncs.py b/src/scons/exitfuncs.py
new file mode 100644 (file)
index 0000000..e26a031
--- /dev/null
+++ b/src/scons/exitfuncs.py
@@ -0,0 +1,48 @@
+"""scons.exitfuncs
+
+Register functions which are executed when scons exits for any reason.
+
+"""
+
+__revision__ = "exitfuncs.py __REVISION__ __DATE__ __DEVELOPER__"
+
+
+
+_exithandlers = []
+def _run_exitfuncs():
+    """run any registered exit functions
+
+    _exithandlers is traversed in reverse order so functions are executed
+    last in, first out.
+    """
+
+    while _exithandlers:
+        func, targs, kargs =  _exithandlers.pop()
+        apply(func, targs, kargs)
+
+def register(func, *targs, **kargs):
+    """register a function to be executed upon normal program termination
+
+    func - function to be called at exit
+    targs - optional arguments to pass to func
+    kargs - optional keyword arguments to pass to func
+    """
+    _exithandlers.append((func, targs, kargs))
+
+import sys
+
+try:
+    x = sys.exitfunc
+
+    # if x isn't our own exit func executive, assume it's another
+    # registered exit function - append it to our list...
+    if x != _run_exitfuncs:
+        register(x)
+
+except AttributeError:
+    pass
+
+# make our exit function get run by python when it exits:    
+sys.exitfunc = _run_exitfuncs
+
+del sys

diff --git a/test/exitfns.py b/test/exitfns.py
new file mode 100644 (file)
index 0000000..94911e7
--- /dev/null
+++ b/test/exitfns.py
@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+
+__revision__ = "test/exitfns.py __REVISION__ __DATE__ __DEVELOPER__"
+
+from TestCmd import TestCmd
+
+test = TestCmd(program = 'scons.py',
+               workdir = '',
+               interpreter = 'python')
+
+sconstruct = """
+from scons.exitfuncs import *
+
+def x1():
+    print "running x1"
+def x2(n):
+    print "running x2(%s)" % `n`
+def x3(n, kwd=None):
+    print "running x3(%s, kwd=%s)" % (`n`, `kwd`)
+
+register(x3, "no kwd args")
+register(x1)
+register(x2, 12)
+register(x3, 5, kwd="bar")
+register(x3, "no kwd args")
+
+"""
+
+expected_output = """running x3('no kwd args', kwd=None)
+running x3(5, kwd='bar')
+running x2(12)
+running x1
+running x3('no kwd args', kwd=None)
+"""
+
+test.write('SConstruct', sconstruct)
+
+test.run(chdir = '.', arguments='-f SConstruct')
+
+test.fail_test(test.stdout() != expected_output)
+
+test.write('SConstruct', """import sys
+def f():
+    pass
+
+sys.exitfunc = f
+""" + sconstruct)
+
+test.run(chdir = '.', arguments='-f SConstruct')
+
+test.fail_test(test.stdout() != expected_output)
+
+test.pass_test()