ProcessJobOptions Namespace Reference

Classes
class	LogFormatter
class	LogFilter
class	ConsoleHandler
class	ParserError
class	JobOptsParser
class	_TempSysPath
Functions
def	GetConsoleHandler
def	InstallRootLoggingHandler
def	PrintOn
def	PrintOff
def	_find_file
def	_to_be_included
def	_import_python
def	_import_pickle
def	_import_opts
def	importOptions
def	importUnits
	Import a file containing declaration of units.
Variables
tuple	_log = logging.getLogger(__name__)
	_consoleHandler = None
tuple	_included_files = set()
tuple	_parser = JobOptsParser()
dictionary	_import_function_mapping

---

Function Documentation

def ProcessJobOptions::_find_file

(

f )

[private]

Definition at line 107 of file ProcessJobOptions.py.

                 :
    # expand environment variables in the filename
    f = os.path.expandvars(f)
    if os.path.isfile(f):
        return os.path.realpath(f)

    path = os.environ.get('JOBOPTSEARCHPATH','').split(os.pathsep)
    # find the full path to the option file
    candidates = [d for d in path if os.path.isfile(os.path.join(d,f))]
    if not candidates:
        raise ParserError("Cannot find '%s' in %s" % (f,path))
    return os.path.realpath(os.path.join(candidates[0],f))

def ProcessJobOptions::_import_opts

(

file )

[private]

Definition at line 386 of file ProcessJobOptions.py.

                      :
    _parser.parse(file)

def ProcessJobOptions::_import_pickle

(

file )

[private]

Definition at line 380 of file ProcessJobOptions.py.

                        :
    import pickle
    input = open(file, 'rb')
    catalog = pickle.load(input)
    _log.info('Unpickled %d configurables', len(catalog))

def ProcessJobOptions::_import_python

(

file )

[private]

Definition at line 377 of file ProcessJobOptions.py.

                        :
    execfile(file, {})

def ProcessJobOptions::_to_be_included

(

f )

[private]

Definition at line 121 of file ProcessJobOptions.py.

                      :
    if f in _included_files:
        _log.warning("file '%s' already included, ignored.", f)
        return False
    _included_files.add(f)
    return True

def ProcessJobOptions::GetConsoleHandler	(		prefix = None,
			strm = None
	)

Definition at line 83 of file ProcessJobOptions.py.

                                                 :
    global _consoleHandler
    if _consoleHandler is None:
        _consoleHandler = ConsoleHandler(prefix = prefix, strm = strm)
    elif prefix is not None:
        _consoleHandler.setPrefix(prefix)
    return _consoleHandler

def ProcessJobOptions::importOptions

(

optsfile )

Definition at line 395 of file ProcessJobOptions.py.

                              :
    # expand environment variables before checking the extension
    optsfile = os.path.expandvars(optsfile)
    # check the file type (extension)
    dummy, ext = os.path.splitext(optsfile)
    if ext in _import_function_mapping:
        # check if the file has been already included
        optsfile = _find_file(optsfile)
        if _to_be_included(optsfile):
            _log.info("--> Including file '%s'", optsfile)
            # include the file
            _import_function_mapping[ext](optsfile)
            _log.info("<-- End of file '%s'", optsfile)
    else:
        raise ParserError("Unknown file type '%s' ('%s')" % (ext,optsfile))

def ProcessJobOptions::importUnits

(

unitsfile )

Import a file containing declaration of units.

It is equivalent to:

units "unitsfile.opts"

Definition at line 416 of file ProcessJobOptions.py.

                          :
    # expand environment variables
    unitsfile = os.path.expandvars(unitsfile)
    # we do not need to check the file type (extension) because it must be a
    # units file
    _parser._include(unitsfile, _parser._parse_units)

def ProcessJobOptions::InstallRootLoggingHandler	(		prefix = None,
			level = None,
			strm = None
	)

Definition at line 91 of file ProcessJobOptions.py.

                                                                       :
    root_logger = logging.getLogger()
    if not root_logger.handlers:
        root_logger.addHandler(GetConsoleHandler(prefix, strm))
        root_logger.setLevel(logging.WARNING)
    if level is not None:
        root_logger.setLevel(level)

def ProcessJobOptions::PrintOff

(

step = 1 )

Definition at line 101 of file ProcessJobOptions.py.

                      :
    GetConsoleHandler().printOff(step)

def ProcessJobOptions::PrintOn	(		step = 1,
			force = False
	)

Definition at line 99 of file ProcessJobOptions.py.

00100                                     :
    GetConsoleHandler().printOn(step, force)

---

Variable Documentation

ProcessJobOptions::_consoleHandler = None

Definition at line 82 of file ProcessJobOptions.py.

dictionary ProcessJobOptions::_import_function_mapping

Initial value:

{
                             ".py"   : _import_python,
                             ".pkl"  : _import_pickle,
                             ".opts" : _import_opts,
                            }

Definition at line 389 of file ProcessJobOptions.py.

tuple ProcessJobOptions::_included_files = set()

Definition at line 120 of file ProcessJobOptions.py.

tuple ProcessJobOptions::_log = logging.getLogger(__name__)

Definition at line 4 of file ProcessJobOptions.py.

tuple ProcessJobOptions::_parser = JobOptsParser()

Definition at line 375 of file ProcessJobOptions.py.