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...

Public Member Functions
def	__init__ (self, primaryName, noCfgFile=False)
	Recursively load *.cfg files for packageName and all its dependencies. More...
def	configure (self, env, check=False)
def	__contains__ (self, name)
def	__getitem__ (self, name)
def	get (self, name, default=None)
def	keys (self)

Public Attributes
	cfgPath
	packages
	customTests
	primary

Static Public Attributes
def	has_key = __contains__

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

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 407 of file dependencies.py.

Constructor & Destructor Documentation

__init__()

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 419 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)

Member Function Documentation

__contains__()

def lsst.sconsUtils.dependencies.PackageTree.__contains__	(		self,
			name
	)

Definition at line 480 of file dependencies.py.

    def __contains__(self, name):
        return name == self.name or name in self.packages

__getitem__()

def lsst.sconsUtils.dependencies.PackageTree.__getitem__	(		self,
			name
	)

Definition at line 485 of file dependencies.py.

    def __getitem__(self, name):
        if name == self.name:
            return self.primary
        else:
            return self.packages[name]

configure()

def lsst.sconsUtils.dependencies.PackageTree.configure	(		self,
			env,
			check = False
	)

Definition at line 460 of file dependencies.py.

    def configure(self, env, check=False):
        conf = env.Configure(custom_tests=self.customTests)
        for name, module in self.packages.items():
            if module is None:
                state.log.info("Skipping missing optional package %s." % name)
                continue
            if not module.config.configure(conf, packages=self.packages, check=check, build=False):
                state.log.fail("%s was found but did not pass configuration checks." % name)
        if self.primary:
            self.primary.config.configure(conf, packages=self.packages, check=False, build=True)
        env.AppendUnique(SWIGPATH=env["CPPPATH"])
        env.AppendUnique(XSWIGPATH=env["XCPPPATH"])
        # reverse the order of libraries in env.libs, so libraries that fulfill a dependency
        # of another appear after it. required by the linker to successfully resolve symbols
        # in static libraries.
        for target in env.libs:
            env.libs[target].reverse()
        env = conf.Finish()
        return env

get()

def lsst.sconsUtils.dependencies.PackageTree.get	(		self,
			name,
			default = None
	)

Definition at line 491 of file dependencies.py.

    def get(self, name, default=None):
        if name == self.name:
            return self.primary
        else:
            return self.packages.get(name)

keys()

def lsst.sconsUtils.dependencies.PackageTree.keys

(

self

)

Definition at line 497 of file dependencies.py.

    def keys(self):
        k = list(self.packages.keys())
        k.append(self.name)
        return k

Member Data Documentation

cfgPath

lsst.sconsUtils.dependencies.PackageTree.cfgPath

Definition at line 420 of file dependencies.py.

customTests

lsst.sconsUtils.dependencies.PackageTree.customTests

Definition at line 422 of file dependencies.py.

has_key

def lsst.sconsUtils.dependencies.PackageTree.has_key = __contains__

static

Definition at line 483 of file dependencies.py.

packages

lsst.sconsUtils.dependencies.PackageTree.packages

Definition at line 421 of file dependencies.py.

primary

lsst.sconsUtils.dependencies.PackageTree.primary

Definition at line 430 of file dependencies.py.

Property Documentation

name

lsst.sconsUtils.dependencies.PackageTree.name = property(lambda self: self.primary.config.name)

static

Definition at line 457 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