lsst.sconsUtils.dependencies.ExternalConfiguration Class Reference

A Configuration subclass for external (third-party) packages. More...

Inheritance diagram for lsst.sconsUtils.dependencies.ExternalConfiguration:

Public Member Functions
def	__init__ (self, cfgFile, headers=(), libs=None, eupsProduct=None)
	Initialize the configuration object. More...
def	addCustomTests (self, tests)
	Add custom SCons configuration tests to the Configure Context passed to the configure() method. More...
def	configure (self, conf, packages, check=False, build=True)
	Update an SCons environment to make use of the package. More...

Static Public Member Functions
def	parseFilename (cfgFile)
def	getEupsData (eupsProduct)

Public Attributes
	root
	eupsProduct
	version
	doxygen
	libs
	paths
	provides

Detailed Description

A Configuration subclass for external (third-party) packages.

Aliased as lsst.sconsUtils.ExternalConfiguration.

ExternalConfiguration doesn't assume the package uses SWIG or Doxygen, and tells SCons not to consider header files this package provides as dependencies (by setting XCPPPATH instead of CPPPATH). This means things SCons won't waste time looking for changes in it every time you build. Header files in external packages are treated as "system headers": that is, most warnings generated when they are being compiled are suppressed.

Definition at line 287 of file dependencies.py.

Constructor & Destructor Documentation

__init__()

def lsst.sconsUtils.dependencies.ExternalConfiguration.__init__	(		self,
			cfgFile,
			headers = (),
			libs = None,
			eupsProduct = None
	)

Initialize the configuration object.

Parameters

cfgFile	The name of the calling .cfg file, usually just passed in with the special variable file. This will be parsed to extract the package name and root.
headers	A list of headers provided by the package, to be used in autoconf-style tests.
libs	A list or dictionary of libraries provided by the package. If a dictionary is provided, libs["main"] should contain a list of regular libraries provided by the library. Other keys are "python" and "test", which refer to libraries that are only linked against compiled Python modules and unit tests, respectively. If a list is provided, the list is used as "main". These are used both for autoconf-style tests and to support env.getLibs(...), which recursively computes the libraries a package must be linked with.

Definition at line 303 of file dependencies.py.

    def __init__(self, cfgFile, headers=(), libs=None, eupsProduct=None):
        Configuration.__init__(self, cfgFile, headers, libs, eupsProduct=eupsProduct, hasSwigFiles=False,
                               hasDoxygenTag=False, hasDoxygenInclude=False)
        self.paths["XCPPPATH"] = self.paths["CPPPATH"]
        del self.paths["CPPPATH"]


# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

Member Function Documentation

addCustomTests()

def lsst.sconsUtils.dependencies.Configuration.addCustomTests (   self,   tests  )

inherited

Add custom SCons configuration tests to the Configure Context passed to the configure() method.

This needs to be done up-front so we can pass in a dictionary of custom tests when calling env.Configure(), and use the same configure context for all packages.

Parameters

tests

A dictionary to add custom tests to. This will be passed as the custom_tests argument to env.Configure().

Definition at line 230 of file dependencies.py.

    def addCustomTests(self, tests):
        pass

configure()

def lsst.sconsUtils.dependencies.Configuration.configure (   self,   conf,   packages,   check = False,   build = True  )

inherited

Update an SCons environment to make use of the package.

Parameters

conf	An SCons Configure context. The SCons Environment conf.env should be updated by the configure function.
packages	A dictionary containing the configuration modules of all dependencies (or None if the dependency was optional and was not found). The <module>.config.configure(...) method will have already been called on all dependencies.
check	If True, perform autoconf-style tests to verify that key components are in fact in place.
build	If True, this is the package currently being built, and packages in "buildRequired" and "buildOptional" dependencies will also be present in the packages dict.

Definition at line 247 of file dependencies.py.

    def configure(self, conf, packages, check=False, build=True):
        assert(not (check and build))
        conf.env.PrependUnique(**self.paths)
        state.log.info("Configuring package '%s'." % self.name)
        conf.env.doxygen["includes"].extend(self.doxygen["includes"])
        if not build:
            conf.env.doxygen["tags"].extend(self.doxygen["tags"])
        for target in self.libs:
            if target not in conf.env.libs:
                conf.env.libs[target] = self.libs[target].copy()
                state.log.info("Adding '%s' libraries to target '%s'." % (self.libs[target], target))
            else:
                for lib in self.libs[target]:
                    if lib not in conf.env.libs[target]:
                        conf.env.libs[target].append(lib)
                        state.log.info("Adding '%s' library to target '%s'." % (lib, target))
        if check:
            for header in self.provides["headers"]:
                if not conf.CheckCXXHeader(header):
                    return False
            for lib in self.libs["main"]:
                if not conf.CheckLib(lib, autoadd=False, language="C++"):
                    return False
        return True


# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

getEupsData()

def lsst.sconsUtils.dependencies.Configuration.getEupsData (   eupsProduct )

staticinherited

Definition at line 129 of file dependencies.py.

    def getEupsData(eupsProduct):
        version, eupsPathDir, productDir, table, flavor = eupsForScons.getEups().findSetupVersion(eupsProduct)
        if productDir is None:
            productDir = eupsForScons.productDir(eupsProduct)
        return version, productDir

parseFilename()

def lsst.sconsUtils.dependencies.Configuration.parseFilename (   cfgFile )

staticinherited

Definition at line 123 of file dependencies.py.

    def parseFilename(cfgFile):
        dir, file = os.path.split(cfgFile)
        name, ext = os.path.splitext(file)
        return name, os.path.abspath(os.path.join(dir, ".."))

Member Data Documentation

doxygen

lsst.sconsUtils.dependencies.Configuration.doxygen

inherited

Definition at line 176 of file dependencies.py.

eupsProduct

lsst.sconsUtils.dependencies.Configuration.eupsProduct

inherited

Definition at line 167 of file dependencies.py.

libs

lsst.sconsUtils.dependencies.Configuration.libs

inherited

Definition at line 185 of file dependencies.py.

paths

lsst.sconsUtils.dependencies.Configuration.paths

inherited

Definition at line 197 of file dependencies.py.

provides

lsst.sconsUtils.dependencies.Configuration.provides

inherited

Definition at line 215 of file dependencies.py.

root

lsst.sconsUtils.dependencies.Configuration.root

inherited

Definition at line 164 of file dependencies.py.

version

lsst.sconsUtils.dependencies.Configuration.version

inherited

Definition at line 170 of file dependencies.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/Linux64/sconsUtils/16.0-17-gd9d95e9+2/python/lsst/sconsUtils/dependencies.py