/[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 3975 by caltinay, Thu Sep 20 01:54:06 2012 UTC
# Line 1  Line 1 
1    
2    ########################################################
3  # Extensions to Scons  #
4    # Copyright (c) 2003-2012 by University of Queensland
5  import py_compile  # Earth Systems Science Computational Center (ESSCC)
6  import sys  # http://www.uq.edu.au/esscc
7  import os  #
8  import time  # Primary Business: Queensland, Australia
9  import glob  # Licensed under the Open Software License version 3.0
10  import fnmatch  # http://www.opensource.org/licenses/osl-3.0.php
11  import types  #
12    ########################################################
13  from SCons.Script.SConscript import SConsEnvironment  
14    __copyright__="""Copyright (c) 2003-2012 by University of Queensland
15  ###############################################################################  Earth Systems Science Computational Center (ESSCC)
16  def matchingFiles(env,directory,includes='*',excludes=None) :  http://www.uq.edu.au/esscc
17    Primary Business: Queensland, Australia"""
18      # Pre-process for more convenient arguments  __license__="""Licensed under the Open Software License version 3.0
19    http://www.opensource.org/licenses/osl-3.0.php"""
20      if isinstance(includes,str) :  __url__="https://launchpad.net/escript-finley"
21          includes = env.Split(includes)  
22    import sys, os, time, py_compile, re, subprocess
23      if isinstance(excludes,str) :  
24          excludes = env.Split(excludes)  def findLibWithHeader(env, libs, header, paths, lang='c'):
25        from SCons.Script.SConscript import Configure
26      def fn_filter(node):      inc_path=''
27          fn = os.path.basename(str(node))      lib_path=''
28          match = False      # 'paths' may be a prefix, so look for lib and include subdirectories
29          for include in includes:      if type(paths)==str:
30              if fnmatch.fnmatchcase( fn, include ):          # find the header file first
31                  match = True          for i in 'include','include64','include32','inc':
32                inc=os.path.join(paths, i)
33                if os.path.isfile(os.path.join(inc, header)):
34                    inc_path=inc
35                  break                  break
36            if inc_path=='':
37                raise RuntimeError('%s not found under %s'%(header,paths))
38    
39          if match and not excludes is None:          # now try to find a lib directory
40              for exclude in excludes:          for l in 'lib','lib64','lib32':
41                  if fnmatch.fnmatchcase( fn, exclude ):              lp=os.path.join(paths, l)
42                      match = False              if os.path.isdir(lp):
43                      break                  lib_path=lp
44                    break
45          return match          if lib_path=='':
46                raise RuntimeError('No lib directory found under %s'%paths)
47      def filter_nodes(where):      else:
48          contents = glob.glob( os.path.join(str(where),"*") )          if os.path.isfile(os.path.join(paths[0], header)):
49          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  
50          else:          else:
51              path = n.abspath              raise RuntimeError('%s not found under %s'%(header,paths[0]))
52            if os.path.isdir(paths[1]):
53          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")))  
54          else:          else:
55              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.  
   
     if  env['distrib_py_src'] :  
         pytarg = env.Install(target_dir, python_src)  
     else:  
         pyc = env.PyCompile(python_src)  
         pytarg = env.Install(target_dir, pyc)  
56    
57      if shlib :      # now try the library
58          targ_ret = env.Flatten([pytarg] + [shtarg])      conf=Configure(env.Clone())
59        conf.env.AppendUnique(CPPPATH = [inc_path])
60        conf.env.AppendUnique(LIBPATH = [lib_path])
61        if type(libs)==str: libs=[libs]
62        # we can't check for each library by itself since they may depend on each
63        # other, so we add all libraries to the link line and check only for one
64        conf.env.AppendUnique(LIBS = libs)
65        if not conf.CheckLibWithHeader(libs[0], header, lang):
66            conf.Finish()
67            raise RuntimeError('Unable to link against %s (paths: %s, %s)'%(libs,inc_path,lib_path))
68    
69        conf.Finish()
70        return inc_path, lib_path
71    
72    def detectModule(env, module):
73        if env['pythoncmd']=='python':
74            try:
75                __import__(module)
76            except ImportError:
77                return False
78      else:      else:
79          targ_ret = pytarg          p=subprocess.call([env['pythoncmd'],'-c','import %s'%module])
80            if p!=0:
81                return False
82        return True
83    
     return targ_ret  
 #==============================================================================  
 SConsEnvironment.InstallPyModule = InstallPyModule  
 ###############################################################################  
   
 ###############################################################################  
 def installDirectory(env,target,source,includes="*", excludes=None,  
                      recursive=False):  
       
       
     if os.path.isfile(str(target)) :  
         raise UserError("target must be a directory")  
   
     if os.path.isfile(str(source)) :  
         raise UserError("source must be a directory")  
   
     source_files = env.matchingFiles(source,includes,excludes)  
   
     ret_targ = []  
   
     for f in source_files :  
         if f.isfile() :  
             targ = env.Install(target,f)  
             ret_targ.append(targ)  
   
         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  
 ###############################################################################  
   
 ###############################################################################  
84  # Code to build .pyc from .py  # Code to build .pyc from .py
85  def build_py(target, source, env):  def build_py(target, source, env):
86      py_compile.compile(str(source[0]), str(target[0]))      try:
87      return 0         py_compile.compile(str(source[0]), str(target[0]), doraise=True)
88           return 0
89  def doSubstitution(target,source,env) :      except py_compile.PyCompileError, e:
90      import product_info as PI         print e
91      data = source[0].get_contents()         return 1
92      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  
93    
94  # Code to run unit_test executables  # Code to run unit_test executables
95  def runUnitTest(target, source, env):  def runUnitTest(target, source, env):
96    time_start = time.time()    time_start = time.time()
97    app = str(source[0].abspath)    app = str(source[0].abspath)
98    if env['useMPI']: app = env['mpi_run'] + ' ' + app    pn, sn= os.path.split(app)
99      if not os.name== "nt":
100         app = "cd "+pn+"; "+os.path.join(env['bininstall'], "run-escript")+" -bv "+os.path.join('.',sn)
101      else:
102          if env['usempi']:
103              app = "cd %s & mpiexec -np %s -genvlist PYTHONPATH,OMP_NUM_THREADS,"\
104                "FINLEY_TEST_DATA,PYVISI_TEST_DATA_ROOT,PYVISI_WORKDIR,PATH %s"\
105                %(pn,env['ENV']['ESCRIPT_NUM_NODES'], sn)
106          else:
107               app = "cd "+ pn +" & "+sn
108    print "Executing test: " + app    print "Executing test: " + app
109    if not env.Execute(app):    if not env.Execute(app):
110      open(str(target[0]),'w').write("PASSED\n")      open(str(target[0]),'w').write("PASSED\n")
# Line 192  def runUnitTest(target, source, env): Line 116  def runUnitTest(target, source, env):
116  def runPyUnitTest(target, source, env):  def runPyUnitTest(target, source, env):
117     time_start = time.time()     time_start = time.time()
118     app = str(source[0].abspath)     app = str(source[0].abspath)
119     if env['useMPI']:     pn, sn= os.path.split(app)
120       app = env['mpi_run'] +' lib/pythonMPI ' + app     if os.name== "nt":
121           if env['usempi']:
122               app = "cd %s & mpiexec -np %s -genvlist PYTHONPATH,OMP_NUM_THREADS,"\
123                  "FINLEY_TEST_DATA,PYVISI_TEST_DATA_ROOT,PYVISI_WORKDIR,PATH %s\pythonMPIredirect.exe %s"\
124                  %(pn,env['ENV']['ESCRIPT_NUM_NODES'],env['libinstall'],sn)
125           else:
126               app = "cd "+ pn +" & "+sys.executable + " " + sn
127     else:     else:
128       app = sys.executable + " " + app       app = "cd "+pn+"; "+os.path.join(env['bininstall'], "run-escript")+" -ov "+sn
129     print "Executing test: " + app     print "Executing test: ",app
130     if env.Execute(app) == 0:     if env.Execute(app) == 0:
131        open(str(target[0]),'w').write("PASSED\n")        open(str(target[0]),'w').write("PASSED\n")
132     else:     else:
# Line 204  def runPyUnitTest(target, source, env): Line 134  def runPyUnitTest(target, source, env):
134     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)
135     return None     return None
136    
137  def addBuilders(env) :  def eps2pdf(target, source, env):
138      py_builder = env.Builder(action = build_py,  #   if env.Execute("epstopdf "+str(source[0].abspath)+" -o "+str(target[0].abspath))!=0:
139                               suffix = '.pyc',     if env.Execute("ps2pdf -dEPSCrop "+str(source[0].abspath)+" "+str(target[0].abspath))!=0:
140                               src_suffix = '.py',         return 1
141                               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)))))  
142    
143      return nodes  def effectiveName(inname):
144       m=re.compile("^r1i[0-9]{1,2}n[0-9]{1,2}$")   # savanna names take the form r1i?n?
145       if m.match(inname):
146        return "savanna"
147       return inname

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

  ViewVC Help
Powered by ViewVC 1.1.26