/[escript]/trunk/site_scons/site_init.py
ViewVC logotype

Diff of /trunk/site_scons/site_init.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

temp_trunk_copy/scons/scons_extensions.py revision 1384 by phornby, Fri Jan 11 02:29:38 2008 UTC trunk/site_scons/site_init.py revision 4576 by sshaw, Mon Dec 9 23:35:30 2013 UTC
# Line 1  Line 1 
1    
2    ##############################################################################
3  # Extensions to Scons  #
4    # Copyright (c) 2003-2013 by University of Queensland
5  import py_compile  # http://www.uq.edu.au
6  import sys  #
7  import os  # Primary Business: Queensland, Australia
8  import time  # Licensed under the Open Software License version 3.0
9  import glob  # http://www.opensource.org/licenses/osl-3.0.php
10  import fnmatch  #
11  import types  # Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12    # Development since 2012 by School of Earth Sciences
13  from SCons.Script.SConscript import SConsEnvironment  #
14    ##############################################################################
15  ###############################################################################  
16  def matchingFiles(env,directory,includes='*',excludes=None) :  __copyright__="""Copyright (c) 2003-2013 by University of Queensland
17    http://www.uq.edu.au
18      # Pre-process for more convenient arguments  Primary Business: Queensland, Australia"""
19    __license__="""Licensed under the Open Software License version 3.0
20      if isinstance(includes,str) :  http://www.opensource.org/licenses/osl-3.0.php"""
21          includes = env.Split(includes)  __url__="https://launchpad.net/escript-finley"
22    
23      if isinstance(excludes,str) :  import sys, os, time, py_compile, re, subprocess
24          excludes = env.Split(excludes)  from SCons.Defaults import Chmod, Copy
25    from grouptest import *
26      def fn_filter(node):  
27          fn = os.path.basename(str(node))  def findLibWithHeader(env, libs, header, paths, lang='c++'):
28          match = False      from SCons.Script.SConscript import Configure
29          for include in includes:      inc_path=''
30              if fnmatch.fnmatchcase( fn, include ):      lib_path=''
31                  match = True      # 'paths' may be a prefix, so look for lib and include subdirectories
32        if type(paths)==str:
33            # find the header file first
34            for i in 'include','include64','include32','inc':
35                inc=os.path.join(paths, i)
36                if os.path.isfile(os.path.join(inc, header)):
37                    inc_path=inc
38                  break                  break
39            if inc_path=='':
40                raise RuntimeError('%s not found under %s'%(header,paths))
41    
42          if match and not excludes is None:          # now try to find a lib directory
43              for exclude in excludes:          for l in 'lib','lib64','lib32':
44                  if fnmatch.fnmatchcase( fn, exclude ):              lp=os.path.join(paths, l)
45                      match = False              if os.path.isdir(lp):
46                      break                  lib_path=lp
47                    break
48          return match          if lib_path=='':
49                raise RuntimeError('No lib directory found under %s'%paths)
50      def filter_nodes(where):      else:
51          contents = glob.glob( os.path.join(str(where),"*") )          if os.path.isfile(os.path.join(paths[0], header)):
52          children = [ x for x in contents if fn_filter(x) ]              inc_path=paths[0]
         nodes = []  
         for f in children:  
             nodes.append(gen_node(f))  
         return nodes  
   
     def gen_node(n):  
         """Checks first to see if the node is a file or a dir, then  
         creates the appropriate node. [code seems redundant, if the node  
         is a node, then shouldn't it just be left as is?  
         """  
         if type(n) in (type(''), type(u'')):  
             path = n  
53          else:          else:
54              path = n.abspath              raise RuntimeError('%s not found under %s'%(header,paths[0]))
55            if os.path.isdir(paths[1]):
56          if os.path.isdir(path):              lib_path=paths[1]
             return env.Dir(n)  
   
         return env.File(n)  
   
     here = env.Dir(directory)  
     nodes = filter_nodes(here)  
   
     node_srcs = [n.srcnode() for n in nodes]  
   
     src = here.srcnode()  
     if src is not here:  
         for s in filter_nodes(src):  
             if s not in node_srcs:  
                 # Probably need to check if this node is a directory  
                 nodes.append(  
                     gen_node(os.path.join(str(directory),  
                                           os.path.basename(str(s)))))  
   
     return nodes  
 #==============================================================================  
 SConsEnvironment.matchingFiles = matchingFiles  
 ###############################################################################  
   
   
   
 ###############################################################################  
 def InstallPyModule(env,target_dir,source,shlib=None,excludes=None) :  
   
     # put the .so/.dll over in  <target_dir>  
     if shlib :  
         shtarg = env.Install(target_dir, shlib)  
   
     # Gather the python sources  
     python_src = env.matchingFiles(source, "*.py",excludes=excludes)  
   
     # Here is a hack to deal with the (possibly not yet generated)  
     # __init__.py. The problem is that the python_src list is built before  
     # __init__.py is updated from __init__.in. The AlwaysBuild call  
     # ensures that this does not cause a problem, except on the first  
     # build after a clean checkout, in which case there is no old  
     # __init__.py in src, and hence it does not make it into python_src!  
   
     init_input = env.matchingFiles(source, "__init__.in")  
     if init_input :  
         if python_src :  
             names = [x.name for x in python_src]  
             if "__init__.py" not in names :  
                 python_src.append(env.File(os.path.join(str(source),  
                                                         "__init__.py")))  
57          else:          else:
58              python_src = [env.File(os.path.join(str(source),"__init__.py"))]              raise RuntimeError('%s is not a valid path.'%paths[1])
               
     # decide if we're doing py or pyc distribn and install.  
59    
60      if  env['distrib_py_src'] :      # now try the library
61          pytarg = env.Install(target_dir, python_src)      conf=Configure(env.Clone())
62      else:      conf.env.AppendUnique(CPPPATH = [inc_path])
63          pyc = env.PyCompile(python_src)      conf.env.AppendUnique(LIBPATH = [lib_path])
64          pytarg = env.Install(target_dir, pyc)      if type(libs)==str: libs=[libs]
65        # we can't check for each library by itself since they may depend on each
66        # other, so we add all libraries to the link line and check only for one
67        conf.env.AppendUnique(LIBS = libs)
68        if not conf.CheckLibWithHeader(libs[0], header, lang):
69            conf.Finish()
70            raise RuntimeError('Unable to link against %s (paths: %s, %s)'%(libs,inc_path,lib_path))
71    
72        conf.Finish()
73        return inc_path, lib_path
74    
75    def detectModule(env, module):
76        from tempfile import TemporaryFile
77        p=subprocess.call([env['pythoncmd'],'-c','import %s'%module], stderr=TemporaryFile())
78        if p != 0:
79            env[module] = False
80            return False
81        env[module] = True
82        return True
83    
84    def write_buildvars(env):
85        buildvars=open(os.path.join(env['libinstall'], 'buildvars'), 'w')
86        for k,v in sorted(env['buildvars'].items()):
87            buildvars.write("%s=%s\n"%(k,v))
88        buildvars.close()
89    
90      if shlib :  def generateTestScripts(env, TestGroups):
91          targ_ret = env.Flatten([pytarg] + [shtarg])      try:
92      else:          utest=open('utest.sh','w')
93          targ_ret = pytarg          utest.write(GroupTest.makeHeader(env['PLATFORM'], env['prefix'], False))
94            for tests in TestGroups:
95      return targ_ret              utest.write(tests.makeString())
96  #==============================================================================          utest.close()
97  SConsEnvironment.InstallPyModule = InstallPyModule          env.Execute(Chmod('utest.sh', 0o755))
98  ###############################################################################          print("Generated utest.sh.")
99            # This version contains only python tests - I want this to be usable
100  ###############################################################################          # from a binary only install if you have the test files
101  def installDirectory(env,target,source,includes="*", excludes=None,          utest=open('itest.sh','w')
102                       recursive=False):          utest.write(GroupTest.makeHeader(env['PLATFORM'], env['prefix'], True))
103                for tests in TestGroups:
104                  if tests.exec_cmd=='$PYTHONRUNNER ':
105      if os.path.isfile(str(target)) :              utest.write(tests.makeString())
106          raise UserError("target must be a directory")          utest.close()
107            env.Execute(Chmod('itest.sh', 0o755))
108      if os.path.isfile(str(source)) :          print("Generated itest.sh.")        
109          raise UserError("source must be a directory")      except IOError:
110            env['warnings'].append("Error attempting to write unit test script(s).")
111      source_files = env.matchingFiles(source,includes,excludes)  
112        # delete scripts upon cleanup
113      ret_targ = []      env.Clean('target_init', 'utest.sh')
114        env.Clean('target_init', 'itest.sh')
115      for f in source_files :  
116          if f.isfile() :      # Make sure that the escript wrapper is in place
117              targ = env.Install(target,f)      if not os.path.isfile(os.path.join(env['bininstall'], 'run-escript')):
118              ret_targ.append(targ)          print("Copying escript wrapper.")
119            env.Execute(Copy(os.path.join(env['bininstall'],'run-escript'), 'bin/run-escript'))
         if f.isdir() and recursive :  
             x = os.path.basename(str(f))  
             t = env.Dir(os.path.join(str(target),x))  
             targ = env.installDirectory(t,f,includes,excludes,recursive)  
             ret_targ += targ  
       
     return ret_targ  
 #==============================================================================  
 SConsEnvironment.installDirectory = installDirectory  
 ###############################################################################  
120    
 ###############################################################################  
121  # Code to build .pyc from .py  # Code to build .pyc from .py
122  def build_py(target, source, env):  def build_py(target, source, env):
123      py_compile.compile(str(source[0]), str(target[0]))      try:
124      return 0         py_compile.compile(str(source[0]), str(target[0]), doraise=True)
125           return 0
126        except py_compile.PyCompileError, e:
127           print e
128           return 1
129    
 def doSubstitution(target,source,env) :  
     import product_info as PI  
     data = source[0].get_contents()  
     data = data.replace('$ProductName$',PI.PRODUCT_NAME)  
     data = data.replace('$LowerProductName$',PI.product_name)  
     data = data.replace('$ProductVersion$',PI.product_version)  
     data = data.replace('$VersionString$',PI.pkg_version_string)  
     data = data.replace('$SVNRevision$',PI.svn_revision)  
     open(str(target[0]),'w').write(data)  
     return 0  
130    
131  # Code to run unit_test executables  # Code to run unit_test executables
132  def runUnitTest(target, source, env):  def runUnitTest(target, source, env):
133    time_start = time.time()    time_start = time.time()
134    app = str(source[0].abspath)    app = str(source[0].abspath)
135    if env['useMPI']: app = env['mpi_run'] + ' ' + app    pn, sn= os.path.split(app)
136      if not os.name== "nt":
137         app = "cd "+pn+"; "+os.path.join(env['bininstall'], "run-escript")+" -bv "+os.path.join('.',sn)
138      else:
139          if env['usempi']:
140              app = "cd %s & mpiexec -np %s -genvlist PYTHONPATH,OMP_NUM_THREADS,"\
141                "FINLEY_TEST_DATA,PATH %s"\
142                %(pn,env['ENV']['ESCRIPT_NUM_NODES'], sn)
143          else:
144               app = "cd "+ pn +" & "+sn
145    print "Executing test: " + app    print "Executing test: " + app
146    if not env.Execute(app):    if not env.Execute(app):
147      open(str(target[0]),'w').write("PASSED\n")      open(str(target[0]),'w').write("PASSED\n")
# Line 192  def runUnitTest(target, source, env): Line 153  def runUnitTest(target, source, env):
153  def runPyUnitTest(target, source, env):  def runPyUnitTest(target, source, env):
154     time_start = time.time()     time_start = time.time()
155     app = str(source[0].abspath)     app = str(source[0].abspath)
156     if env['useMPI']:     pn, sn= os.path.split(app)
157       app = env['mpi_run'] +' lib/pythonMPI ' + app     if os.name=="nt":
158           if env['usempi']:
159               app = "cd %s & mpiexec -np %s -genvlist PYTHONPATH,OMP_NUM_THREADS,"\
160                  "FINLEY_TEST_DATA,PATH %s\pythonMPIredirect.exe %s"\
161                  %(pn,env['ENV']['ESCRIPT_NUM_NODES'],env['libinstall'],sn)
162           else:
163               app = "cd "+ pn +" & "+sys.executable + " " + sn
164     else:     else:
165       app = sys.executable + " " + app       app = "cd "+pn+"; "+os.path.join(env['bininstall'], "run-escript")+" -ov "+sn
166     print "Executing test: " + app     print "Executing test: ",app
167     if env.Execute(app) == 0:     if env.Execute(app) == 0:
168        open(str(target[0]),'w').write("PASSED\n")        open(str(target[0]),'w').write("PASSED\n")
169     else:     else:
# Line 204  def runPyUnitTest(target, source, env): Line 171  def runPyUnitTest(target, source, env):
171     print "Test execution time: ", round(time.time() - time_start, 1), " seconds wall time for " + str(source[0].abspath)     print "Test execution time: ", round(time.time() - time_start, 1), " seconds wall time for " + str(source[0].abspath)
172     return None     return None
173    
174  def addBuilders(env) :  def eps2pdf(target, source, env):
175      py_builder = env.Builder(action = build_py,  #   if env.Execute("epstopdf "+str(source[0].abspath)+" -o "+str(target[0].abspath))!=0:
176                               suffix = '.pyc',     if env.Execute("ps2pdf -dEPSCrop "+str(source[0].abspath)+" "+str(target[0].abspath))!=0:
177                               src_suffix = '.py',         return 1
178                               single_source=True)     return None
   
     env.Append(BUILDERS = {'PyCompile' : py_builder});  
   
     substituter = env.Builder(action = doSubstitution,  
                               suffix = '',  
                               src_suffix = '.in',  
                               single_source=True )  
   
     env.Append(BUILDERS = {'VariableSubstitution' : substituter});  
   
     runUnitTest_builder = env.Builder(action = runUnitTest,  
                                       suffix = '.passed',  
                                       src_suffix=env.get('PROGSUFFIX',''),  
                                       single_source=True)  
   
     env.Append(BUILDERS = {'RunUnitTest' : runUnitTest_builder});  
   
     runPyUnitTest_builder = env.Builder(action = runPyUnitTest,  
                                         suffix = '.passed',  
                                         src_suffix='.py',  
                                         single_source=True)  
   
     env.Append(BUILDERS = {'RunPyUnitTest' : runPyUnitTest_builder});  
     return  
 #==============================================================================  
 SConsEnvironment.addBuilders = addBuilders  
 ###############################################################################  
   
 ###############################################################################  
 def epydocAction(target, source, env):  
   
     doc_dir = os.path.dirname(str(target[0].abspath))  
   
     cmd = [  
         [env['epydoc_path'], "-qqqq", "-o", doc_dir, str(source[0].tpath)]  
           ]  
     print 'executing epydoc...'  
     return env.Execute(cmd,"Build epydoc documentation")  
   
   
 def epydocDepend(env, target, source,  
                  src_pattern="*.py",  
                  file_names=['index.html','epydoc.css'],  
                  subdirs=['private','public']) :  
     """  
     \brief add a dependency between the directory containing the doco and that  
            containing the source  
     \param target - the directory containing index.html for the doco,  
                     and the private and public sub-directories.  
     \param source - the python module source directory  
     """  
     the_subdirs = [os.path.join(target.abspath,sub) for sub in subdirs]  
     the_targets = [os.path.join(target.abspath,file) for file in file_names]  
   
   
     ret_target = target  
       
     # if absolutely anything goes wrong, turn this on.  
     force_build = False  
   
     dst_time = 0  
     src_time = 1  
   
     try:  
   
         # have a shot at digging out all the source file times.  
         src_time = max(  
             [os.path.getmtime(str(x))  
              for x in env.matchingFiles(source,src_pattern) +  
                       [source.abspath]]  
             )  
   
         # now try to find the target files and their mod time.  
         a = [os.path.getmtime(os.path.join(target.abspath,str(x)))  
              for x in file_names ]  
   
         for directory in the_subdirs :  
             # include the mod time of the directory  
             a += [os.path.getmtime(str(directory))]  
   
             # now go for the mod times of all files below the subdirs.  
             if os.path.isdir(str(directory)) :  
                 a += [os.path.getmtime(str(x))  
                       for x in env.matchingFiles(directory,"*")]  
   
             else:  
                 # if it is not a directory, and we expected it to be  
                 # do something nasty.  
                 # we're in a try anyway.  
                 force_build = True  
                 os.unlink(directory)  
   
         dst_time = max(a)  
               
     except:  
         # Force an unlink and re-build.  
         force_build = True  
           
     if src_time > dst_time or force_build :  
         for x in the_targets :  
             try:  
                 os.unlink(x)  
             except OSError:  
                 pass  
   
         ret_target = env.Command(the_targets,source,epydocAction)  
       
   
     env.Clean(target, the_subdirs + file_names)  
   
     return ret_target  
 #==============================================================================  
 SConsEnvironment.epydocDepend = epydocDepend  
 ###############################################################################  
   
   
 ###############################################################################  
 def genSConscriptCalls(env,dir_list):  
   
     for d in dir_list :  
         print 'calling SConscript in "./%s"' %(d)  
         env.SConscript(dirs = [d],  
                        build_dir='build/$PLATFORM/' + str(d),  
                        duplicate=0)  
   
   
     return  
 #==============================================================================  
 SConsEnvironment.genSConscriptCalls = genSConscriptCalls  
 ###############################################################################  
   
   
 ###############################################################################  
 def print_all_nodes(env,dirnode, level=0):  
     """Print all the scons nodes that are children of this node, recursively."""  
     if type(dirnode)==type(''):  
         dirnode=env.Dir(dirnode)  
     dt = type(env.Dir('.'))  
     for f in dirnode.all_children():  
         if type(f) == dt:  
             print "%s%s: .............."%(level * ' ', str(f))  
             env.print_all_nodes(f, level+2)  
         print "%s%s"%(level * ' ', str(f))  
   
 #==============================================================================  
 SConsEnvironment.print_all_nodes = print_all_nodes  
 ###############################################################################  
     
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 ###############################################################################  
 def Glob(env,dir='.',includes="*",excludes=None, scan_dir=True):  
   
     """Similar to glob.glob, except globs SCons nodes, and thus sees  
     generated files and files from build directories.  Basically, it sees  
     anything SCons knows about.  A key subtlety is that since this function  
     operates on generated nodes as well as source nodes on the filesystem,  
     it needs to be called after builders that generate files you want to  
     include.  
   
     It will return both Dir entries and File entries  
     """  
   
     # Pre-process for more convenient arguments  
   
     if isinstance(includes,str) :  
         includes = env.Split(includes)  
   
     if isinstance(excludes,str) :  
         excludes = env.Split(excludes)  
   
     def fn_filter(node):  
         fn = os.path.basename(str(node))  
         match = 0  
         for include in includes:  
             if fnmatch.fnmatchcase( fn, include ):  
                 match = 1  
                 break  
   
         if match == 1 and not excludes is None:  
             for exclude in excludes:  
                 if fnmatch.fnmatchcase( fn, exclude ):  
                     match = 0  
                     break  
   
         return match  
   
     def filter_nodes(where):  
         contents = where.all_children(scan=scan_dir)  
         children = [ x for x in contents if fn_filter(x) ]  
         nodes = []  
         for f in children:  
             nodes.append(gen_node(f))  
         return nodes  
   
     def gen_node(n):  
         """Checks first to see if the node is a file or a dir, then  
         creates the appropriate node. [code seems redundant, if the node  
         is a node, then shouldn't it just be left as is?  
         """  
         if type(n) in (type(''), type(u'')):  
             path = n  
         else:  
             path = n.abspath  
         if os.path.isdir(path):  
             return env.Dir(n)  
         else:  
             return env.File(n)  
   
     here = env.Dir(dir)  
     nodes = filter_nodes(here)  
   
     node_srcs = [n.srcnode() for n in nodes]  
   
     src = here.srcnode()  
     if src is not here:  
         for s in filter_nodes(src):  
             if s not in node_srcs:  
                 # Probably need to check if this node is a directory  
                 nodes.append(  
                     gen_node(os.path.join(dir,os.path.basename(str(s)))))  
179    
180      return nodes  def effectiveName(inname):
181        m=re.compile("^r1i[0-9]{1,2}n[0-9]{1,2}$")  # savanna names take the form r1i?n?
182        if m.match(inname):
183            return "savanna"
184        return inname

Legend:
Removed from v.1384  
changed lines
  Added in v.4576

  ViewVC Help
Powered by ViewVC 1.1.26