GaudiConfig2._db.ConfigurablesDB Class Reference

Public Member Functions
	__init__ (self, modulename, root=None)
	__getattr__ (self, name)
	getByType (self, typename)

Protected Member Functions
	_getEntries (self)

Protected Attributes
	_log = logging.getLogger(modulename)
	_root = root or modulename
str	_namespace = modulename[len(root) + 1 :].replace(".", "::") if root else ""
	_namespaces
	_classes = self._getEntries()
dict	_alt_names = {}

Private Attributes
	__name__ = modulename
	__loader__ = None
	__all__

Detailed Description

Helper to expose Configurables classes (from Configurables database) as
a tree of subpackages, each mapped to a namespace.

Definition at line 94 of file _db.py.

Constructor & Destructor Documentation

__init__()

GaudiConfig2._db.ConfigurablesDB.__init__	(		self,
			modulename,
			root = None )

@param modulename: name of the module
@param root: name of the root modules (that pointing to the root C++
             namespace), None is ewuivalent to pass modulename as root

Definition at line 100 of file _db.py.

    def __init__(self, modulename, root=None):
        """
        @param modulename: name of the module
        @param root: name of the root modules (that pointing to the root C++
                     namespace), None is ewuivalent to pass modulename as root
        """
        self._log = logging.getLogger(modulename)
        self._log.debug("initializing module %r (with root %r)", modulename, root)
 
        self.__name__ = modulename
        self.__loader__ = None
        self._root = root or modulename
        assert (not root) or modulename.startswith(
            root + "."
        ), "modulename should be (indirect submodule of root)"
 
        self._namespace = modulename[len(root) + 1 :].replace(".", "::") if root else ""
        self._log.debug("%r mapping namespace %r", modulename, self._namespace or "::")
 
        self._namespaces, self._classes = self._getEntries()
        self._alt_names = {}
        for cname in self._classes:
            alt_name = _normalize_cpp_type_name(cname)
            if alt_name != cname:
                self._alt_names[alt_name] = cname
            if " " in cname:  # allow matching of 'T<A, B>' a well as 'T<A,B>'
                self._alt_names[cname.replace(" ", "")] = cname
        self.__all__ = list(
            self._namespaces.union(self._classes).union(self._alt_names)
        )
 
        sys.modules[modulename] = self
 
        for submodule in self._namespaces:
            setattr(
                self,
                submodule,
                ConfigurablesDB(".".join([self.__name__, submodule]), self._root),
            )
 

Member Function Documentation

__getattr__()

GaudiConfig2._db.ConfigurablesDB.__getattr__	(		self,
			name )

Helper to instantiate on demand Configurable classes.

Definition at line 164 of file _db.py.

    def __getattr__(self, name):
        """
        Helper to instantiate on demand Configurable classes.
        """
        if name in self._classes:
            fullname = "::".join([self._namespace, name]) if self._namespace else name
            from ._configurables import makeConfigurableClass
 
            self._log.debug("generating %r (%s)", name, fullname)
            entry = makeConfigurableClass(
                name,
                __module__=self.__name__,
                __qualname__=name,
                __cpp_type__=fullname,
                **_DB[fullname],
            )
        elif name.replace(" ", "") in self._alt_names:
            entry = getattr(self, self._alt_names[name.replace(" ", "")])
        elif name == "__spec__":  # pragma no cover
            import importlib
 
            entry = importlib.machinery.ModuleSpec(
                name=self.__package__,
                loader=self.__loader__,
            )
        elif name == "__package__":  # pragma no cover
            entry = self.__name__
        else:
            raise AttributeError(f"module {self.__name__!r} has no attribute {name!r}")
        setattr(self, name, entry)
        return entry
 

_getEntries()

GaudiConfig2._db.ConfigurablesDB._getEntries ( self )

protected

Extract from the Configurables DB the namespaces and classes names in
the namespace this instance represents.

Definition at line 140 of file _db.py.

    def _getEntries(self):
        """
        Extract from the Configurables DB the namespaces and classes names in
        the namespace this instance represents.
        """
        self._log.debug("getting list of entries under %r", self._namespace)
        prefix = self._namespace + "::" if self._namespace else ""
        prefix_len = len(prefix)
 
        namespaces = set()
        classes = set()
        for name in _DB:
            if name.startswith(prefix):
                head, tail = split_namespace(name[prefix_len:])
                if head:
                    namespaces.add(head)
                else:
                    classes.add(tail)
 
        self._log.debug(
            "found %d namespaces and %d classes", len(namespaces), len(classes)
        )
        return (namespaces, classes)
 

getByType()

GaudiConfig2._db.ConfigurablesDB.getByType	(		self,
			typename )

Return a configurable from the fully qualified type name (relative to
the current namespace).any

Definition at line 196 of file _db.py.

    def getByType(self, typename):
        """
        Return a configurable from the fully qualified type name (relative to
        the current namespace).any
        """
        head, tail = split_namespace(typename)
        if head:
            return getattr(self, head).getByType(tail)
        else:
            return getattr(self, tail)

Member Data Documentation

__all__

GaudiConfig2._db.ConfigurablesDB.__all__

private

Initial value:

=  list(
            self._namespaces.union(self._classes).union(self._alt_names)
        )

Definition at line 127 of file _db.py.

__loader__

GaudiConfig2._db.ConfigurablesDB.__loader__ = None

private

Definition at line 110 of file _db.py.

__name__

GaudiConfig2._db.ConfigurablesDB.__name__ = modulename

private

Definition at line 109 of file _db.py.

_alt_names

dict GaudiConfig2._db.ConfigurablesDB._alt_names = {}

protected

Definition at line 120 of file _db.py.

_classes

GaudiConfig2._db.ConfigurablesDB._classes = self._getEntries()

protected

Definition at line 119 of file _db.py.

_log

GaudiConfig2._db.ConfigurablesDB._log = logging.getLogger(modulename)

protected

Definition at line 106 of file _db.py.

_namespace

GaudiConfig2._db.ConfigurablesDB._namespace = modulename[len(root) + 1 :].replace(".", "::") if root else ""

protected

Definition at line 116 of file _db.py.

_namespaces

GaudiConfig2._db.ConfigurablesDB._namespaces

protected

Definition at line 119 of file _db.py.

_root

GaudiConfig2._db.ConfigurablesDB._root = root or modulename

protected

Definition at line 111 of file _db.py.

---

The documentation for this class was generated from the following file:

• GaudiConfiguration/python/GaudiConfig2/_db.py