GaudiKernel.ConfigurableDb Namespace Reference

Classes
class	_CfgDb
class	_Singleton

Functions
	_normalize_cpp_type_name (name)
	loadConfigurableDb ()
	getConfigurable (className, requester="", assumeCxxClass=True)

Variables
list	__all__ = ["CfgDb", "cfgDb", "loadConfigurableDb", "getConfigurable"]
	(c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".
	log = logging.getLogger("ConfigurableDb")
	_TRANS_TABLE = str.maketrans("<>&*,: ().", "__rp__s___")
	CfgDb = _Singleton()
	cfgDb = CfgDb()

Function Documentation

_normalize_cpp_type_name()

GaudiKernel.ConfigurableDb._normalize_cpp_type_name ( name )

protected

Translate a C++ type name (with templates etc.) to Python identifier.

Definition at line 29 of file ConfigurableDb.py.

def _normalize_cpp_type_name(name):
    """
    Translate a C++ type name (with templates etc.) to Python identifier.
    """
    return name.replace(", ", ",").translate(_TRANS_TABLE)
 
 

getConfigurable()

GaudiKernel.ConfigurableDb.getConfigurable	(		className,
			requester = "",
			assumeCxxClass = True )

Definition at line 174 of file ConfigurableDb.py.

def getConfigurable(className, requester="", assumeCxxClass=True):
    confClass = className
    if assumeCxxClass:
        # assume className is C++: --> translate to python
        confClass = _normalize_cpp_type_name(confClass)
 
    # see if I have it in my dictionary
    confClassInfo = cfgDb.get(confClass)
    if not confClassInfo:
        confClassInfo = cfgDb.get(confClass)
    # get the python module
    confMod = confClassInfo and confClassInfo.get("module")
    if not confMod:
        log.warning("%s: Class %s not in database", requester, className)
        return None
    # load the module
    try:
        mod = __import__(confMod, globals(), locals(), confClass)
    except ImportError:
        log.warning(
            "%s: Module %s not found (needed for configurable %s)",
            requester,
            confMod,
            className,
        )
        return None
    # get the class
    try:
        confClass = getattr(mod, confClass)
    except AttributeError:
        log.warning(
            "%s: Configurable %s not found in module %s", requester, confClass, confMod
        )
        return None
    # Got it!
    log.debug("%s: Found configurable %s in module %s", requester, confClass, confMod)
 
    return confClass

loadConfigurableDb()

GaudiKernel.ConfigurableDb.loadConfigurableDb

(

)

Helper function to load all ConfigurableDb files (modules) holding
informations about Configurables

Definition at line 121 of file ConfigurableDb.py.

def loadConfigurableDb():
    """Helper function to load all ConfigurableDb files (modules) holding
    informations about Configurables
    """
    import os
    import sys
    from itertools import chain
    from os.path import join as path_join
 
    from GaudiPluginService.cpluginsvc import GAUDI_DEFAULT_PLUGIN_PATH
 
    log.debug("loading confDb files...")
    nFiles = 0  # counter of imported files
    pathvars = (
        ["GAUDI_PLUGIN_PATH", "DYLD_LIBRARY_PATH"]
        if sys.platform == "darwin"
        else ["GAUDI_PLUGIN_PATH", "LD_LIBRARY_PATH"]
    )
    ignored_files = set(os.environ.get("CONFIGURABLE_DB_IGNORE", "").split(","))
    for path in chain(
        [GAUDI_DEFAULT_PLUGIN_PATH],
        *[os.getenv(pv, "").split(os.pathsep) for pv in pathvars],
    ):
        if not path or not os.path.isdir(path):
            continue
        log.debug("walking in [%s]...", path)
        confDbFiles = [
            f
            for f in [
                path_join(path, f) for f in os.listdir(path) if f.endswith(".confdb")
            ]
            if os.path.isfile(f) and f not in ignored_files
        ]
        # check if we use "*_merged.confdb"
        mergedConfDbFiles = [f for f in confDbFiles if f.endswith("_merged.confdb")]
        if mergedConfDbFiles:
            # use only the merged ones
            confDbFiles = mergedConfDbFiles
 
        for confDb in confDbFiles:
            log.debug("\t-loading [%s]...", confDb)
            try:
                cfgDb._loadModule(confDb)
            except Exception as err:
                log.warning("Could not load file [%s] !", confDb)
                log.warning("Reason: %s", err)
            nFiles += 1
    log.debug("loading confDb files... [DONE]")
    nPkgs = len(set([k["package"] for k in cfgDb.values()]))
    log.debug("loaded %i confDb packages", nPkgs)
    return nFiles
 
 

Variable Documentation

__all__

list GaudiKernel.ConfigurableDb.__all__ = ["CfgDb", "cfgDb", "loadConfigurableDb", "getConfigurable"]

private

(c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".

# # In applying this licence, CERN does not waive the privileges and immunities # granted to it by virtue of its status as an Intergovernmental Organization # or submit itself to any jurisdiction. #

File: AthenaCommon/python/ConfigurableDb.py Author: Sebastien Binet (binet.nosp@m.@cer.nosp@m.n.ch)

Definition at line 19 of file ConfigurableDb.py.

_TRANS_TABLE

GaudiKernel.ConfigurableDb._TRANS_TABLE = str.maketrans("<>&*,: ().", "__rp__s___")

protected

Definition at line 26 of file ConfigurableDb.py.

CfgDb

GaudiKernel.ConfigurableDb.CfgDb = _Singleton()

Definition at line 109 of file ConfigurableDb.py.

cfgDb

GaudiKernel.ConfigurableDb.cfgDb = CfgDb()

Definition at line 116 of file ConfigurableDb.py.

log

GaudiKernel.ConfigurableDb.log = logging.getLogger("ConfigurableDb")

Definition at line 23 of file ConfigurableDb.py.