LSSTApplications: lsst.sconsUtils.scripts.BasicSConscript Class Reference

A scope-only class for SConscript-replacement convenience functions. More...

Inheritance diagram for lsst.sconsUtils.scripts.BasicSConscript:

Static Public Member Functions
def	lib
	Convenience function to replace standard lib/SConscript boilerplate. More...

def	python
	Convenience function to replace standard python/*/SConscript boilerplate. More...

def	doc
	Convenience function to replace standard doc/SConscript boilerplate. More...

def	tests
	Convenience function to replace standard tests/SConscript boilerplate. More...

def	examples
	Convenience function to replace standard examples/SConscript boilerplate. More...

Detailed Description

A scope-only class for SConscript-replacement convenience functions.

All methods of BasicSConscript are static. All of these functions update the state.targets dictionary of targets used to set default targets and fix build dependencies; if you build anything without using BasicSConscript methods, be sure to manually it to the state.targets dict.

Definition at line 180 of file scripts.py.

Member Function Documentation

def lsst.sconsUtils.scripts.BasicSConscript.doc	(	config = `"doxygen.conf.in"`,
		projectName = `None`,
		projectNumber = `None`,
		kw
	)

static

Convenience function to replace standard doc/SConscript boilerplate.

With no arguments, this will generate a Doxygen config file and run Doxygen with env.Doxygen(), using the projectName and projectNumber from env["packageName"] and env["version"], respectively.

This essentially just forwards all arguments (which should be passed as keyword arguments) to env.Doxygen().

Definition at line 253 of file scripts.py.

 
     def doc(config="doxygen.conf.in", projectName=None, projectNumber=None, **kw):
         if not find_executable("doxygen"):
             state.log.warn("doxygen executable not found; skipping documentation build.")
             return []
         if projectName is None:
             projectName = ".".join(["lsst"] + state.env["packageName"].split("_"))
         if projectNumber is None:
             projectNumber = state.env["version"]
         result = state.env.Doxygen(
             config, projectName=projectName, projectNumber=projectNumber,
             includes=state.env.doxygen["includes"],
             useTags=state.env.doxygen["tags"],
             makeTag=(state.env["packageName"] + ".tag"),
             **kw
             )
         state.targets["doc"].extend(result)
         return result

lsst.sconsUtils.scripts.BasicSConscript.doc

def doc

Convenience function to replace standard doc/SConscript boilerplate.

Definition: scripts.py:253

def lsst.sconsUtils.scripts.BasicSConscript.examples	(	ccList = `None`,
		swigNameList = `None`,
		swigSrc = `None`
	)

static

Convenience function to replace standard examples/SConscript boilerplate.

Parameters

ccList	A sequence of C++ examples to build (including .cc extensions). Defaults to a .cc glob of the examples directory, minus any files that end with _wrap.cc and files present in swigSrc.
swigNameList	A sequence of SWIG modules to build (NOT including .i extensions).
swigSrc	Additional source files to be compiled into SWIG modules, as a dictionary; each key must be an entry in swigNameList, and each value a list of additional source files.

Definition at line 361 of file scripts.py.

 
     def examples(ccList=None, swigNameList=None, swigSrc=None):
         if swigNameList is None:
             swigFileList = Glob("*.i")
             swigNameList = [_getFileBase(node) for node in swigFileList]
         else:
             swigFileList = [File(name) for name in swigNameList]
         if swigSrc is None:
             swigSrc = {}
         allSwigSrc = set()
         for name, node in zip(swigNameList, swigFileList):
             src = swigSrc.setdefault(name, [])
             allSwigSrc.update(str(element) for element in src)
             src.append(node)
         if ccList is None:
             ccList = [node for node in Glob("*.cc")
                           if (not str(node).endswith("_wrap.cc")) and str(node) not in allSwigSrc]
         state.log.info("SWIG modules for examples: %s" % swigFileList)
         state.log.info("C++ examples: %s" % ccList)
         results = []
         for src in ccList:
             results.extend(state.env.Program(src, LIBS=state.env.getLibs("main")))
         swigMods = []
         for name, src in swigSrc.items():
             results.extend(
                 state.env.SwigLoadableModule("_" + name, src, LIBS=state.env.getLibs("main python"))
                 )
         for result in results:
             state.env.Depends(result, state.targets["lib"])
         state.targets["examples"].extend(results)
         return results

lsst.sconsUtils.scripts.BasicSConscript.examples

def examples

Convenience function to replace standard examples/SConscript boilerplate.

Definition: scripts.py:361

lsst.sconsUtils.scripts._getFileBase

def _getFileBase

Definition: scripts.py:20

def lsst.sconsUtils.scripts.BasicSConscript.lib	(	libName = `None`,
		src = `None`,
		libs = `"self"`
	)

static

Convenience function to replace standard lib/SConscript boilerplate.

With no arguments, this will build a shared library with the same name as the package. This uses env.SourcesForSharedLibrary to support the optFiles/noOptFiles command-line variables.

Parameters

libName	Name of the shared libray to be built (defaults to env["packageName"]).
src	Source to compile into the library. Defaults to a 4-directory deep glob of all *.cc files in #src.
libs	Libraries to link against, either as a string argument to be passed to env.getLibs() or a sequence of actual libraries to pass in.

Definition at line 195 of file scripts.py.

 
     def lib(libName=None, src=None, libs="self"):
         if libName is None:
             libName = state.env["packageName"]
         if src is None:
             src = Glob("#src/*.cc") + Glob("#src/*/*.cc") + Glob("#src/*/*/*.cc") + Glob("#src/*/*/*/*.cc")
         src = state.env.SourcesForSharedLibrary(src)
         if isinstance(libs, basestring):
             libs = state.env.getLibs(libs)
         elif libs is None:
             libs = []
         result = state.env.SharedLibrary(libName, src, LIBS=libs)
         state.targets["lib"].extend(result)
         return result

lsst.sconsUtils.scripts.BasicSConscript.lib

def lib

Convenience function to replace standard lib/SConscript boilerplate.

Definition: scripts.py:195

def lsst.sconsUtils.scripts.BasicSConscript.python	(	swigNameList = `None`,
		libs = `"main python"`,
		swigSrc = `None`
	)

static

Convenience function to replace standard python/*/SConscript boilerplate.

With no arguments, this will build a SWIG module with the name determined according to our current pseudo-convention: last part of env["packageName"], split by underscores, with "Lib" appended to the end.

Parameters

swigNameList	Sequence of SWIG modules to be built (does not include the file extensions).
libs	Libraries to link against, either as a string argument to be passed to env.getLibs() or a sequence of actual libraries to pass in.
swigSrc	A dictionary of additional source files that go into the modules. Each key should be an entry in swigNameList, and each value should be a list of additional C++ source files not generated by SWIG.

Definition at line 224 of file scripts.py.

 
     def python(swigNameList=None, libs="main python", swigSrc=None):
         if swigNameList is None:
             swigNameList = [state.env["packageName"].split("_")[-1] + "Lib"]
         swigFileList = [File(name + ".i") for name in swigNameList]
         if swigSrc is None:
             swigSrc = {}
         for name, node in zip(swigNameList, swigFileList):
             swigSrc.setdefault(name, []).append(node)
         if isinstance(libs, basestring):
             libs = state.env.getLibs(libs)
         elif libs is None:
             libs = []
         result = []
         for name, src in swigSrc.items():
             result.extend(state.env.SwigLoadableModule("_" + name, src, LIBS=libs))
         state.targets["python"].extend(result)
         return result

lsst.sconsUtils.scripts.BasicSConscript.python

def python

Convenience function to replace standard python/*/SConscript boilerplate.

Definition: scripts.py:224

def lsst.sconsUtils.scripts.BasicSConscript.tests	(	pyList = `None`,
		ccList = `None`,
		swigNameList = `None`,
		swigSrc = `None`,
		ignoreList = `None`,
		noBuildList = `None`,
		args = `None`
	)

static

Convenience function to replace standard tests/SConscript boilerplate.

With no arguments, will attempt to figure out which files should be run as tests and which are support code (like SWIG modules).

Python tests will be marked as dependent on the entire #python directory and any SWIG modules built in the tests directory. This should ensure tests are always run when their results might have changed, but may result in them being re-run more often than necessary.

Parameters

pyList	A sequence of Python tests to run (including .py extensions). Defaults to a *.py glob of the tests directory, minus any files corresponding to the SWIG modules in swigFileList.
ccList	A sequence of C++ unit tests to run (including .cc extensions). Defaults to a .cc glob of the tests directory, minus any files that end with _wrap.cc and files present in swigSrc.
swigNameList	A sequence of SWIG modules to build (NOT including .i extensions).
swigSrc	Additional source files to be compiled into SWIG modules, as a dictionary; each key must be an entry in swigNameList, and each value a list of additional source files.
ignoreList	List of ignored tests to be passed to tests.Control (note that ignored tests will be built, but not run).
nobuildList	List of tests that should not even be built.
args	A dictionary of program arguments for tests, passed directly to tests.Control.

Definition at line 301 of file scripts.py.

 
               args=None):
         if noBuildList is None:
             noBuildList = []
         if swigNameList is None:
             swigFileList = Glob("*.i")
             swigNameList = [_getFileBase(node) for node in swigFileList]
         else:
             swigFileList = [File(name + ".i") for name in swigNameList]
         if swigSrc is None:
             swigSrc = {}
         allSwigSrc = set()
         for name, node in zip(swigNameList, swigFileList):
             src = swigSrc.setdefault(name, [])
             allSwigSrc.update(str(element) for element in src)
             src.append(node)
         if pyList is None:
             pyList = [node for node in Glob("*.py")
                       if _getFileBase(node) not in swigNameList
                       and os.path.basename(str(node)) not in noBuildList]
         if ccList is None:
             ccList = [node for node in Glob("*.cc")
                       if (not str(node).endswith("_wrap.cc")) and str(node) not in allSwigSrc
                       and os.path.basename(str(node)) not in noBuildList]
         if ignoreList is None:
             ignoreList = []
         s = lambda l: [str(i) for i in l]
         state.log.info("SWIG modules for tests: %s" % s(swigFileList))
         state.log.info("Python tests: %s" % s(pyList))
         state.log.info("C++ tests: %s" % s(ccList))
         state.log.info("Files that will not be built: %s" % noBuildList)
         state.log.info("Ignored tests: %s" % ignoreList)
         control = tests.Control(state.env, ignoreList=ignoreList, args=args, verbose=True)
         for ccTest in ccList:
             state.env.Program(ccTest, LIBS=state.env.getLibs("main test"))
         swigMods = []
         for name, src in swigSrc.items():
             swigMods.extend(
                 state.env.SwigLoadableModule("_" + name, src, LIBS=state.env.getLibs("main python"))
             )
         ccList = [control.run(str(node)) for node in ccList]
         pyList = [control.run(str(node)) for node in pyList]
         for pyTest in pyList:
             state.env.Depends(pyTest, swigMods)
             state.env.Depends(pyTest, state.targets["python"])
         result = ccList + pyList
         state.targets["tests"].extend(result)
         return result

lsst.sconsUtils.scripts._getFileBase

def _getFileBase

Definition: scripts.py:20

lsst.sconsUtils.tests.Control

A class to control unit tests.

Definition: tests.py:17

Static Public Member Functions

Detailed Description

Member Function Documentation