Add an Execute() method.

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

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 2d7886b79f18f45af641b15acb6653a38da84111..caba4a5b99e1824c6f4ba6ecd36738292cb87b5e 100644 (file)
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -2554,6 +2554,27 @@ initialized with the specified
 .IR key = value
 pairs.
 
+'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.TP 
+.RI Execute( action ", [" strfunction ", " varlist ])
+.TP
+.RI env.Execute( action ", [" strfunction ", " varlist ])
+Executes an Action object.
+The specified
+.IR action
+may be an Action object
+(see the section "Action Objects,"
+below, for a complete explanation of the arguments and behavior),
+or it may be a command-line string,
+list of commands,
+or executable Python function,
+each of which will be converted
+into an Action object
+and then executed.
+The exit value of the command
+or return value of the Python function
+will be returned.
+
 '\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .TP
 .RI Exit([ value ])

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index a8f0eccb9301c57797740a8ec151e3df5da5c174..285ffbefe2ac0b90e878ff86a0b4a3a849d7fe32 100644 (file)
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -12,6 +12,8 @@ RELEASE 0.96 - XXX
 
   From Steven Knight:
 
+  - Add an Execute() method for executing actions directly.
+
 
 
 RELEASE 0.95 - Mon, 08 Mar 2004 06:43:20 -0600

diff --git a/src/engine/SCons/Environment.py b/src/engine/SCons/Environment.py
index da455bcff4abf2b3879feb696914126a2ac80546..ca25021a552895c09d9a9b266920f31bde775963 100644 (file)
--- a/src/engine/SCons/Environment.py
+++ b/src/engine/SCons/Environment.py
@@ -920,6 +920,12 @@ class Base:
     def Environment(self, **kw):
         return apply(SCons.Environment.Environment, [], self.subst_kw(kw))
 
+    def Execute(self, action, *args, **kw):
+        """Directly execute an action through an Environment
+        """
+        action = apply(self.Action, (action,) + args, kw)
+        return action([], [], self)
+
     def File(self, name, *args, **kw):
         """
         """

diff --git a/src/engine/SCons/EnvironmentTests.py b/src/engine/SCons/EnvironmentTests.py
index d450075e5e89cd85b95bff59277e8f2c7e189af0..ca0b45884a8c8dcd7304005d8a1d4df5f3b6bc5f 100644 (file)
--- a/src/engine/SCons/EnvironmentTests.py
+++ b/src/engine/SCons/EnvironmentTests.py
@@ -1757,6 +1757,21 @@ class EnvironmentTestCase(unittest.TestCase):
         assert e2['X'] == 'xxx', e2['X']
         assert e2['Y'] == 'yyy', e2['Y']
 
+    def test_Execute(self):
+        """Test the Execute() method"""
+
+        class MyAction:
+            def __init__(self, *args, **kw):
+                self.args = args
+            def __call__(self, target, source, env):
+                return "%s executed" % self.args
+
+        env = Environment()
+        env.Action = MyAction
+
+        result = env.Execute("foo")
+        assert result == "foo executed", result
+
     def test_File(self):
         """Test the File() method"""
         class MyFS:

diff --git a/src/engine/SCons/Script/SConscript.py b/src/engine/SCons/Script/SConscript.py
index 2fa15103dbfed367db45c1ba0b31da4a984c0cc5..d6e40fd23168a23c3e654f413473054c6fc12ece 100644 (file)
--- a/src/engine/SCons/Script/SConscript.py
+++ b/src/engine/SCons/Script/SConscript.py
@@ -569,6 +569,8 @@ def get_DefaultEnvironmentProxy():
             def subst_kw(self, kw, raw=0, target=None, source=None):
                 return kw
             def subst_list(self, string, raw=0, target=None, source=None):
+                if not SCons.Util.is_List(string):
+                    string = [[string]]
                 return string
         default_env = SCons.Defaults.DefaultEnvironment()
         _DefaultEnvironmentProxy = EnvironmentProxy(default_env)
@@ -619,6 +621,7 @@ GlobalDefaultEnvironmentFunctions = [
     'Command',
     'Depends',
     'Dir',
+    'Execute',
     'File',
     'FindFile',
     'GetBuildPath',

diff --git a/test/Execute.py b/test/Execute.py
new file mode 100644 (file)
index 0000000..6942617
--- /dev/null
+++ b/test/Execute.py
@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Test the Execute() function for executing actions directly.
+"""
+
+import TestSCons
+
+python = TestSCons.python
+
+test = TestSCons.TestSCons()
+
+test.write('copy.py', """\
+import sys
+open(sys.argv[2], 'wb').write(open(sys.argv[1], 'rb').read())
+try:
+    exitval = int(sys.argv[3])
+except IndexError:
+    exitval = 0
+sys.exit(exitval)
+""")
+
+test.write('SConstruct', """\
+Execute("%s copy.py a.in a.out")
+Execute(Action("%s copy.py b.in b.out"))
+env = Environment(COPY = 'copy.py')
+env.Execute("%s copy.py c.in c.out")
+env.Execute(Action("%s copy.py d.in d.out"))
+v = env.Execute("%s $COPY e.in e.out")
+assert v == 0, v
+v = env.Execute(Action("%s $COPY f.in f.out"))
+assert v == 0, v
+v = env.Execute("%s $COPY g.in g.out 1")
+assert v == 1, v
+v = env.Execute(Action("%s $COPY h.in h.out 2"))
+assert v == 2, v
+import shutil
+Execute(lambda target, source, env: shutil.copy('i.in', 'i.out'))
+Execute(Action(lambda target, source, env: shutil.copy('j.in', 'j.out')))
+env.Execute(lambda target, source, env: shutil.copy('k.in', 'k.out'))
+env.Execute(Action(lambda target, source, env: shutil.copy('l.in', 'l.out')))
+""" % (python, python, python, python, python, python, python, python))
+
+test.write('a.in', "a.in\n")
+test.write('b.in', "b.in\n")
+test.write('c.in', "c.in\n")
+test.write('d.in', "d.in\n")
+test.write('e.in', "e.in\n")
+test.write('f.in', "f.in\n")
+test.write('g.in', "g.in\n")
+test.write('h.in', "h.in\n")
+test.write('i.in', "i.in\n")
+test.write('j.in', "j.in\n")
+test.write('k.in', "k.in\n")
+test.write('l.in', "l.in\n")
+
+test.run(arguments = '.')
+
+test.fail_test(test.read('a.out') != "a.in\n")
+test.fail_test(test.read('b.out') != "b.in\n")
+test.fail_test(test.read('c.out') != "c.in\n")
+test.fail_test(test.read('d.out') != "d.in\n")
+test.fail_test(test.read('e.out') != "e.in\n")
+test.fail_test(test.read('f.out') != "f.in\n")
+test.fail_test(test.read('g.out') != "g.in\n")
+test.fail_test(test.read('h.out') != "h.in\n")
+test.fail_test(test.read('i.out') != "i.in\n")
+test.fail_test(test.read('j.out') != "j.in\n")
+test.fail_test(test.read('k.out') != "k.in\n")
+test.fail_test(test.read('l.out') != "l.in\n")
+
+test.pass_test()