lsst.sconsUtils
14.0-14-g812352e+1
|
A scope-only class for SConstruct-replacement convenience functions. More...
Public Member Functions | |
def | __new__ (cls, packageName, versionString=None, eupsProduct=None, eupsProductPath=None, cleanExt=None, defaultTargets=DEFAULT_TARGETS, subDirList=None, ignoreRegex=None, versionModuleName="python/lsst/%s/version.py", noCfgFile=False, sconscriptOrder=None) |
Convenience function to replace standard SConstruct boilerplate. More... | |
def | initialize (cls, packageName, versionString=None, eupsProduct=None, eupsProductPath=None, cleanExt=None, versionModuleName="python/lsst/%s/version.py", noCfgFile=False, sconscriptOrder=None) |
Convenience function to replace standard SConstruct boilerplate (step 1). More... | |
Static Public Member Functions | |
def | finish (defaultTargets=DEFAULT_TARGETS, subDirList=None, ignoreRegex=None) |
Convenience function to replace standard SConstruct boilerplate (step 2). More... | |
A scope-only class for SConstruct-replacement convenience functions.
The boilerplate for a standard LSST SConstruct file is replaced by two static methods: initialize() and finish(). The former configures dependencies, sets up package-dependent environment variables, and calls any SConscript files found in subdirectories, while the latter sets up installation paths, default targets, and explicit dependencies.
Calling BasicSConstruct as a function invokes its new method, which calls both initialize() and finish(), and should be used when the SConstruct file doesn't need to do anything other than what they provide.
def lsst.sconsUtils.scripts.BasicSConstruct.__new__ | ( | cls, | |
packageName, | |||
versionString = None , |
|||
eupsProduct = None , |
|||
eupsProductPath = None , |
|||
cleanExt = None , |
|||
defaultTargets = DEFAULT_TARGETS , |
|||
subDirList = None , |
|||
ignoreRegex = None , |
|||
versionModuleName = "python/lsst/%s/version.py" , |
|||
noCfgFile = False , |
|||
sconscriptOrder = None |
|||
) |
Convenience function to replace standard SConstruct boilerplate.
This is a shortcut for
This returns the sconsUtils.env Environment object rather than a BasicSConstruct instance (which would be useless).
References lsst.sconsUtils.scripts.BasicSConstruct.finish(), and lsst.sconsUtils.scripts.BasicSConstruct.initialize().
|
static |
Convenience function to replace standard SConstruct boilerplate (step 2).
This function:
subDirList | An explicit list of subdirectories that should be installed. By default, all non-hidden subdirectories will be installed. |
defaultTargets | A sequence of targets (see state.targets) that should be built when scons is run with no arguments. |
ignoreRegex | Regular expression that matches files that should not be installed. |
Referenced by lsst.sconsUtils.scripts.BasicSConstruct.__new__(), and lsst.sconsUtils.scripts.BasicSConstruct.initialize().
def lsst.sconsUtils.scripts.BasicSConstruct.initialize | ( | cls, | |
packageName, | |||
versionString = None , |
|||
eupsProduct = None , |
|||
eupsProductPath = None , |
|||
cleanExt = None , |
|||
versionModuleName = "python/lsst/%s/version.py" , |
|||
noCfgFile = False , |
|||
sconscriptOrder = None |
|||
) |
Convenience function to replace standard SConstruct boilerplate (step 1).
This function:
packageName | Name of the package being built; must correspond to a .cfg file in ups/. |
versionString | Version-control system string to be parsed for version information ($HeadURL$ for SVN). Defaults to "git" if not set or None. |
eupsProduct | Name of the EUPS product being built. Defaults to and is almost always the name of the package. |
eupsProductPath | An alternate directory where the package should be installed. |
cleanExt | Whitespace delimited sequence of globs for files to remove with –clean. |
versionModuleName | If non-None, builds a version.py module as this file; 's' is replaced with the name of the package. |
noCfgFile | If True, this package has no .cfg file |
sconscriptOrder | A sequence of directory names that set the order for processing SConscript files discovered in nested directories. Full directories need not be specified, but paths must begin at the root. For example, ["lib", "python"] will ensure that "lib/SConscript" is run before both "python/foo/SConscript" and "python/bar/SConscript". The default order should work for most LSST SCons builds, as it provides the correct ordering for the lib, python, tests, examples, and doc targets. If this argument is provided, it must include the subset of that list that is valid for the package, in that order. |
References lsst.sconsUtils.scripts.BasicSConstruct._initializing, and lsst.sconsUtils.scripts.BasicSConstruct.finish().
Referenced by lsst.sconsUtils.scripts.BasicSConstruct.__new__().