rcUtil.py

#!/usr/local/bin/python
#
#                               Copyright 2002
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "GLAST LAT run control related utility methods"
__author__   = "S. Tuvi <stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = ("$Date: 2005/03/30 05:59:08 $").split(' ')[1]
__version__  = "$Revision: 2.12 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

import imp
import os
import sys
import logging as log
import string
from   types import ModuleType

class Reloader:
  DONT_RELOAD_LIST = ['scipy', 'weave', 'qwt', 'xml', 'pyexpat', 'win32',
                      'ROOT', 'libPyROOT']

  def __init__(self):
    self.appinit = {}

  def getNewModules(self, keepem):
    modules = {}
    for i, m in sys.modules.items():
      if (i not in keepem) and \
          (type(m) == ModuleType):
          modules[i] = m
    return modules

  def clearAppModules(self, dontReloadList, showUnloadedModules):
    if self.appinit == {}:
      appfinish = {}
    else:
      appfinish = self.getNewModules(self.appinit)
    for i in self.filterModules(appfinish, dontReloadList):
      if i in sys.modules:
        if showUnloadedModules:
          log.debug("Unloading module %s %s" % (i, sys.modules[i].__file__))
        del sys.modules[i]
    self.appinit = sys.modules.copy()

  def filterModules(self, modules, dontReloadList):
    dontReload = dontReloadList + Reloader.DONT_RELOAD_LIST
    mods = []
    for (moduleName, module) in modules.items():
      for modulePrefix in dontReload:
        if moduleName.startswith(modulePrefix):
          break
        if '__file__' not in dir(module):
          break
        if os.path.splitext(module.__file__)[1].lower() in ('.pyd','.dll'):
          break
        if os.path.normpath(os.path.normcase(module.__file__)).startswith(os.path.normpath(os.path.normcase(sys.prefix))):
          break
      else:
        mods.append(moduleName)
    return mods

reloadModules = Reloader()

def importModule(appName, reload=1, dontReloadList=[], showUnloadedModules=0):
  """Import a RunControl application or suite
  \param appName        Name of the module or pathname of the python script
  \param reload         1 = Reload all modules that have been loaded since RunControl started (default)
                        0 = Do not reload modules (used if a suite is being loaded)
  \param dontReloadList Optional parameter which specifies the additional list of module prefixes
                        that should not be reloaded. If this parameter is missing then the default list
                        (Reloader.DONT_RELOAD_LIST) is used, if it is specified then it gets appended
                        to the default list.

  \return The name of the module and the resolved pathname

  """

  # First check if a module name is specified, if so try to resolve its source.
  (appPath, appFile) = os.path.split(appName)
  (appBase, appExt)  = os.path.splitext(appFile)
  if appExt == '':
    try:
      if appPath == '':
        (f, path, desc) = imp.find_module(appBase)
      else:
        (f, path, desc) = imp.find_module(appBase, [appPath])
      (appPath, appFile) = os.path.split(path)
      (appBase, appExt)  = os.path.splitext(appFile)
    except ImportError, e:
      raise e

  _suffixes = {}
  for ext, mode, typ in imp.get_suffixes():
    _suffixes[ext] = (ext, mode, typ)
  _infoMap =  {
                '.py' : ('.py','r',1),
                '.pyc': ('.pyc','rb',2),
                '.pyo': ('.pyo','rb',2)
              }


  # Temporarily change the directory in case the application
  # needs to load additional modules from the same directory.
  curDir = os.getcwd()
  if appPath != '': os.chdir(appPath)

  # Handle relative paths, by resolving the path again after current directory is changed.
  appPath = os.getcwd()
  if appPath not in sys.path:
    sys.path.append(appPath)
  appName = os.path.join(appPath, appFile)

  pycFile = os.path.join(appPath, appBase + '.pyc')
  pyoFile = os.path.join(appPath, appBase + '.pyo')
  if appExt == '.py':
    if os.path.exists(pyoFile) and os.path.getmtime(pyoFile) >= os.path.getmtime(appName):
        filename = pyoFile
        appExt = '.pyo'
    elif _suffixes.has_key('.pyo'):
        filename = appName
    elif os.path.exists(pycFile) and os.path.getmtime(pycFile) >= os.path.getmtime(appName):
      filename = pycFile
      appExt = '.pyc'
    else:
      filename = appName
  elif appExt == '.pyc':
    if os.path.exists(pyoFile) and os.path.getmtime(pyoFile) >= os.path.getmtime(appName):
      filename = pyoFile
      appExt = '.pyo'
    else:
      filename = appName
  elif appExt == '.pyo':
    filename = appName
  else:
    msg = 'Invalid module extension: %s' % appName
    raise RuntimeError, msg
  info = _infoMap[appExt]
  f = file(filename, info[1])

  try:
    # Clear the modules that was imported during the loading and
    # execution of the previous script.
    if reload: reloadModules.clearAppModules(dontReloadList, showUnloadedModules)
    module = imp.load_module(appBase, f, filename, info)
  finally:
    f.close()
    sys.path.remove(appPath)
    if os.path.exists(curDir):
      os.chdir(curDir)
  return (module, filename)

---