GaudiKernel.ProcessJobOptions Namespace Reference

Classes
class	_TempSysPath
class	ConsoleHandler
class	JobOptsParser
class	LogFilter
class	LogFormatter
class	ParserError

Functions
	GetConsoleHandler (prefix=None, stream=None, with_time=False)
	InstallRootLoggingHandler (prefix=None, level=None, stream=None, with_time=False)
	PrintOn (step=1, force=False)
	PrintOff (step=1)
	_find_file (f)
	_to_be_included (f)
	_import_python (file)
	_import_pickle (file)
	_import_opts (file)
	_import_dict (data)
	_import_json (filename)
	_import_yaml (filename)
	importOptions (optsfile)
	importUnits (unitsfile)

Variables
	_log = logging.getLogger(__name__)
	_consoleHandler = None
	_included_files = set()
	_parser = JobOptsParser()
dict	_import_function_mapping

Function Documentation

_find_file()

GaudiKernel.ProcessJobOptions._find_file ( f )

protected

Definition at line 149 of file ProcessJobOptions.py.

def _find_file(f):
    # 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))
 
 

_import_dict()

GaudiKernel.ProcessJobOptions._import_dict ( data )

protected

Definition at line 499 of file ProcessJobOptions.py.

def _import_dict(data):
    from GaudiKernel.Proxy.Configurable import Configurable, ConfigurableGeneric
 
    for property, value_repr in data.items():
        component, property = property.rsplit(".", 1)
        if component in Configurable.allConfigurables:
            cfg = Configurable.allConfigurables[component]
        else:
            cfg = ConfigurableGeneric(component)
        value = eval(value_repr)
        setattr(cfg, property, value)
 
 

_import_json()

GaudiKernel.ProcessJobOptions._import_json ( filename )

protected

Definition at line 512 of file ProcessJobOptions.py.

def _import_json(filename):
    import json
 
    with open(filename) as f:
        _import_dict(json.load(f))
 
 

_import_opts()

GaudiKernel.ProcessJobOptions._import_opts ( file )

protected

Definition at line 495 of file ProcessJobOptions.py.

def _import_opts(file):
    _parser.parse(file)
 
 

_import_pickle()

GaudiKernel.ProcessJobOptions._import_pickle ( file )

protected

Definition at line 487 of file ProcessJobOptions.py.

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

_import_python()

GaudiKernel.ProcessJobOptions._import_python ( file )

protected

Definition at line 481 of file ProcessJobOptions.py.

def _import_python(file):
    with open(file) as f:
        code = compile(f.read(), file, "exec")
        exec(code, {"__file__": file})
 
 

_import_yaml()

GaudiKernel.ProcessJobOptions._import_yaml ( filename )

protected

Definition at line 529 of file ProcessJobOptions.py.

    def _import_yaml(filename):
        with open(filename) as f:
            _import_dict(yaml.safe_load(f))
 

_to_be_included()

GaudiKernel.ProcessJobOptions._to_be_included ( f )

protected

Definition at line 166 of file ProcessJobOptions.py.

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

GetConsoleHandler()

GaudiKernel.ProcessJobOptions.GetConsoleHandler	(		prefix = None,
			stream = None,
			with_time = False )

Definition at line 117 of file ProcessJobOptions.py.

def GetConsoleHandler(prefix=None, stream=None, with_time=False):
    global _consoleHandler
    if _consoleHandler is None:
        _consoleHandler = ConsoleHandler(
            prefix=prefix, stream=stream, with_time=with_time
        )
    elif prefix is not None:
        _consoleHandler.setPrefix(prefix)
    return _consoleHandler
 
 

importOptions()

GaudiKernel.ProcessJobOptions.importOptions

(

optsfile

)

Definition at line 539 of file ProcessJobOptions.py.

def importOptions(optsfile):
    # 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))
 
 
# Import a file containing declaration of units.
#  It is equivalent to:
#
#  #units "unitsfile.opts"
#
 
 

importUnits()

GaudiKernel.ProcessJobOptions.importUnits

(

unitsfile

)

Definition at line 563 of file ProcessJobOptions.py.

def importUnits(unitsfile):
    # 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)

InstallRootLoggingHandler()

GaudiKernel.ProcessJobOptions.InstallRootLoggingHandler	(		prefix = None,
			level = None,
			stream = None,
			with_time = False )

Definition at line 128 of file ProcessJobOptions.py.

def InstallRootLoggingHandler(prefix=None, level=None, stream=None, with_time=False):
    root_logger = logging.getLogger()
    if not root_logger.handlers:
        root_logger.addHandler(GetConsoleHandler(prefix, stream, with_time))
        root_logger.setLevel(logging.WARNING)
    if level is not None:
        root_logger.setLevel(level)
 
 

PrintOff()

GaudiKernel.ProcessJobOptions.PrintOff

(

step = 1

)

Definition at line 141 of file ProcessJobOptions.py.

def PrintOff(step=1):
    GetConsoleHandler().printOff(step)
 
 

PrintOn()

GaudiKernel.ProcessJobOptions.PrintOn	(		step = 1,
			force = False )

Definition at line 137 of file ProcessJobOptions.py.

def PrintOn(step=1, force=False):
    GetConsoleHandler().printOn(step, force)
 
 

Variable Documentation

_consoleHandler

GaudiKernel.ProcessJobOptions._consoleHandler = None

protected

Definition at line 114 of file ProcessJobOptions.py.

_import_function_mapping

dict GaudiKernel.ProcessJobOptions._import_function_mapping

protected

Initial value:

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

Definition at line 519 of file ProcessJobOptions.py.

_included_files

GaudiKernel.ProcessJobOptions._included_files = set()

protected

Definition at line 163 of file ProcessJobOptions.py.

_log

GaudiKernel.ProcessJobOptions._log = logging.getLogger(__name__)

protected

Definition at line 17 of file ProcessJobOptions.py.

_parser

GaudiKernel.ProcessJobOptions._parser = JobOptsParser()

protected

Definition at line 478 of file ProcessJobOptions.py.