python.Configurables.CfgPyComponent Class Reference

Configurable base class for all Py compmonents -------------------------—. More...

Inheritance diagram for python.Configurables.CfgPyComponent:

Collaboration diagram for python.Configurables.CfgPyComponent:

Public Member Functions
def	__init__ (self, name, **kw)
def	getDlls (self)
def	msg (self)
def	getHandle (self)
def	__getstate__ (self)
def	__setstate__ (self, state)
def	setup (self)
def	merge (self, other)

Public Attributes
	OutputLevel
	special case of the OutputLevel: take the value from the svcMgr.MessageSvc if none already set by user More...

Detailed Description

Configurable base class for all Py compmonents -------------------------—.

Definition at line 46 of file Configurables.py.

Constructor & Destructor Documentation

__init__()

def python.Configurables.CfgPyComponent.__init__	(		self,
			name,
		**	kw
	)

Reimplemented in python.Configurables.CfgPyAud, python.Configurables.CfgPyAlgTool, python.Configurables.CfgPyService, and python.Configurables.CfgPyAlgorithm.

Definition at line 47 of file Configurables.py.

    def __init__(self, name, **kw):
        self.__dict__['__cpp_type__'] = self.getType()
        for n,v in kw.items():
            setattr(self, n, v)
 

Member Function Documentation

__getstate__()

def python.Configurables.CfgPyComponent.__getstate__

(

self

)

Definition at line 63 of file Configurables.py.

    def __getstate__(self):
        state = super().__getstate__()
        state.update(self.__dict__)
        return state
 

__setstate__()

def python.Configurables.CfgPyComponent.__setstate__	(		self,
			state
	)

Definition at line 68 of file Configurables.py.

    def __setstate__(self, state):
        self.__dict__.update(state)
        super().__setstate__(state)
 

getDlls()

def python.Configurables.CfgPyComponent.getDlls

(

self

)

Definition at line 52 of file Configurables.py.

    def getDlls(self):
        return 'AthenaPython'
 

getHandle()

def python.Configurables.CfgPyComponent.getHandle

(

self

)

Definition at line 60 of file Configurables.py.

    def getHandle(self):
        return None
 

merge()

def python.Configurables.CfgPyComponent.merge	(		self,
			other
	)

Basic merge for Python components.
Checks that all attributes/properties are identical.

Definition at line 91 of file Configurables.py.

    def merge(self, other):
        """Basic merge for Python components.
        Checks that all attributes/properties are identical.
        """
        if self is other:
            return self
 
        if type(self) is not type(other):
            raise TypeError(f"cannot merge instance of {type(other).__name__} into "
                            f"an instance of { type(self).__name__}")
 
        if self.name != other.name:
            raise ValueError(f"cannot merge configurables with different names ({self.name} and {other.name})")
 
        for prop in other.__dict__:
            if (hasattr(self, prop) and getattr(self, prop) == getattr(other, prop)):
                continue
            else:
                raise ValueError(f"conflicting settings for property {prop} of {self.name}: "
                                 f"{getattr(self,prop)} vs {getattr(other,prop)}")
        return self
 
 

msg()

def python.Configurables.CfgPyComponent.msg

(

self

)

Definition at line 56 of file Configurables.py.

    def msg(self):
        import AthenaCommon.Logging as _L
        return _L.logging.getLogger( self.getName() )
 

setup()

def python.Configurables.CfgPyComponent.setup

(

self

)

Reimplemented in python.Configurables.CfgPyAud, python.Configurables.CfgPyAlgTool, python.Configurables.CfgPyService, and python.Configurables.CfgPyAlgorithm.

Definition at line 72 of file Configurables.py.

    def setup(self):
        if isinstance(self, LegacyConfigurable):
            from AthenaCommon.AppMgr import ServiceMgr as svcMgr
            if not hasattr( svcMgr, 'PyComponentMgr' ):
                from AthenaPython.AthenaPythonCompsConf import PyAthena__PyComponentMgr
                svcMgr += PyAthena__PyComponentMgr('PyComponentMgr')
 
            
            self.OutputLevel = _get_prop_value (self, 'OutputLevel')
 
        
        o = PyComponents.instances.get(self.getName(), None)
        if not (o is None) and not (o is self):
            err = "A python component [%r] has already been "\
                  "registered with the PyComponents registry !" % o
            raise RuntimeError(err)
        PyComponents.instances[self.getName()] = self
 

Member Data Documentation

OutputLevel

python.Configurables.CfgPyComponent.OutputLevel

special case of the OutputLevel: take the value from the svcMgr.MessageSvc if none already set by user

Definition at line 81 of file Configurables.py.

---

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

• Configurables.py