bots.bot_utils Namespace Reference

Classes
class	GSUtil

Functions
def	load_source (modname, filename)
def	GetUtils ()
def	run (command, env=None, shell=False, throw_on_error=True)

Variables
	DART_DIR

Function Documentation

GetUtils()

def bots.bot_utils.GetUtils

(

)

Dynamically load the tools/utils.py python module.

Definition at line 31 of file bot_utils.py.

def GetUtils():
    '''Dynamically load the tools/utils.py python module.'''
    return load_source('utils', os.path.join(DART_DIR, 'tools', 'utils.py'))
 
 

load_source()

def bots.bot_utils.load_source	(		modname,
			filename
	)

Definition at line 18 of file bot_utils.py.

def load_source(modname, filename):
    loader = importlib.machinery.SourceFileLoader(modname, filename)
    spec = importlib.util.spec_from_file_location(modname,
                                                  filename,
                                                  loader=loader)
    module = importlib.util.module_from_spec(spec)
    # The module is always executed and not cached in sys.modules.
    # Uncomment the following line to cache the module.
    # sys.modules[module.__name__] = module
    loader.exec_module(module)
    return module
 
 

run()

def bots.bot_utils.run	(		command,
			env = None,
			shell = False,
			throw_on_error = True
	)

Definition at line 36 of file bot_utils.py.

def run(command, env=None, shell=False, throw_on_error=True):
    print("Running command: ", command)
 
    p = subprocess.Popen(command,
                         stdout=subprocess.PIPE,
                         stderr=subprocess.PIPE,
                         env=env,
                         shell=shell,
                         universal_newlines=True)
    (stdout, stderr) = p.communicate()
    if throw_on_error and p.returncode != 0:
        print("Failed to execute '%s'. Exit code: %s." %
              (command, p.returncode),
              file=sys.stderr)
        print("stdout: ", stdout, file=sys.stderr)
        print("stderr: ", stderr, file=sys.stderr)
        raise Exception("Failed to execute %s." % command)
    return (stdout, stderr, p.returncode)
 
 

Variable Documentation

DART_DIR

bots.bot_utils.DART_DIR

Initial value:

=  os.path.abspath(
    os.path.normpath(os.path.join(__file__, '..', '..', '..')))

Definition at line 14 of file bot_utils.py.