lsst.sconsUtils.utils Namespace Reference

Classes
class	Log
	A dead-simple logger for all messages. More...

Functions
def	runExternal
	Safe wrapper for running external programs, reading stdout, and sanitizing error messages. More...
def	memberOf
	A Python decorator that injects functions into a class. More...

Function Documentation

def lsst.sconsUtils.utils.memberOf	(		cls,
			name = None
	)

A Python decorator that injects functions into a class.

For example:

class test_class(object):
    pass

@memberOf(test_class):
def test_method(self):
    print "test_method!"

...will cause test_method to appear as as if it were defined within test_class.

The function or method will still be added to the module scope as well, replacing any existing module-scope function with that name; this appears to be unavoidable.

Definition at line 84 of file utils.py.

def memberOf(cls, name=None):
    if isinstance(cls, type):
        classes = (cls,)
    else:
        classes = tuple(cls)
    kw = {"name": name}
    def nested(member):
        if kw["name"] is None: kw["name"] = member.__name__
        for scope in classes:
            setattr(scope, kw["name"], member)
        return member
    return nested

def lsst.sconsUtils.utils.runExternal	(		cmd,
			fatal = False,
			msg = None
	)

Safe wrapper for running external programs, reading stdout, and sanitizing error messages.

Note that the entire program output is returned, not just a single line.

Definition at line 51 of file utils.py.

def runExternal(cmd, fatal=False, msg=None):
    if msg is None:
        try:
            msg = "Error running %s" % cmd.split()[0]
        except:
            msg = "Error running external command"
    process = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    stdout, stderr = process.communicate()
    if process.returncode != 0:
        if fatal:
            raise RuntimeError("%s: %s" % (msg, stderr))
        else:
            from . import state # can't import at module scope due to circular dependency
            state.log.warn("%s: %s" % (msg, stderr))
    return stdout