lsst.sconsUtils.dependencies.PackageTree Class Reference

A class for loading and managing the dependency tree of a package, as defined by its configuration module (.cfg) file. More...

Inheritance diagram for lsst.sconsUtils.dependencies.PackageTree:

Public Member Functions
def	__init__
	Recursively load *.cfg files for packageName and all its dependencies. More...
def	configure
	Configure the entire dependency tree in order. More...
def	__contains__
def	__getitem__
def	get
def	keys

Public Attributes
	cfgPath
	packages
	customTests
	primary

Static Public Attributes
	has_key = __contains__

Properties
	name = property(lambda self: self.primary.config.name)

Private Member Functions
def	_tryImport
def	_recurse

Private Attributes
	_current

Detailed Description

A class for loading and managing the dependency tree of a package, as defined by its configuration module (.cfg) file.

This tree isn't actually stored as a tree; it's flattened into an ordered dictionary as it is recursively loaded.

The main SCons produced by configure() and available as sconsUtils.env will contain an instance of this class as env.dependencies.

Its can be used like a read-only dictionary to check whether an optional package has been configured; a package that was not found will have a value of None, while a configured package's value will be its imported .cfg module.

Definition at line 388 of file dependencies.py.

Constructor & Destructor Documentation

def lsst.sconsUtils.dependencies.PackageTree.__init__	(		self,
			primaryName,
			noCfgFile = False
	)

Recursively load *.cfg files for packageName and all its dependencies.

Parameters

primaryName	The name of the primary package being built.
noCfgFile	If True, this package has no .cfg file

After init, self.primary will be set to the configuration module for the primary package, and self.packages will be an OrderedDict of dependencies (excluding self.primary), ordered such that configuration can proceed in iteration order.

Definition at line 400 of file dependencies.py.

    def __init__(self, primaryName, noCfgFile=False):
        self.cfgPath = state.env.cfgPath
        self.packages = collections.OrderedDict()
        self.customTests = {
            "CustomCFlagCheck" : CustomCFlagCheck,
            "CustomCppFlagCheck" : CustomCppFlagCheck,
            "CustomCompileCheck" : CustomCompileCheck,
            "CustomLinkCheck" : CustomLinkCheck,
            }
        self._current = set([primaryName])
        if noCfgFile:
            self.primary = None
            return

        self.primary = self._tryImport(primaryName)
        if self.primary is None:
            state.log.fail("Failed to load primary package configuration for %s." % primaryName)

        missingDeps = []
        for dependency in self.primary.dependencies.get("required", ()):
            if not self._recurse(dependency):
                missingDeps.append(dependency)
        if missingDeps:
            state.log.fail("Failed to load required dependencies: \"%s\"" % '", "'.join(missingDeps))

        missingDeps = []
        for dependency in self.primary.dependencies.get("buildRequired", ()):
            if not self._recurse(dependency):
                missingDeps.append(dependency)
        if missingDeps:
            state.log.fail("Failed to load required build dependencies: \"%s\"" % '", "'.join(missingDeps))

        for dependency in self.primary.dependencies.get("optional", ()):
            self._recurse(dependency)

        for dependency in self.primary.dependencies.get("buildOptional", ()):
            self._recurse(dependency)