PropertyProxy::GaudiHandlePropertyProxyBase Class Reference

Inheritance diagram for PropertyProxy::GaudiHandlePropertyProxyBase:

Collaboration diagram for PropertyProxy::GaudiHandlePropertyProxyBase:

List of all members.

Public Member Functions
def	__init__
def	__get__
def	__set__
def	isHandle
def	isConfig
def	getDefaultConfigurable
def	convertDefaultToBeSet
def	convertValueToBeSet
Private Attributes
	_handleType
	_confTypeName

---

Detailed Description

A class with some utilities for GaudiHandles and GaudiHandleArrays

Definition at line 151 of file PropertyProxy.py.

---

Constructor & Destructor Documentation

def PropertyProxy::GaudiHandlePropertyProxyBase::__init__	(		self,
			descr,
			docString,
			default,
			handleType,
			allowedType
	)

<descr>: the real property in the object instance (from __slots__)
<docString>: the documentation string of this property
<default>: default value from C++ (via python generated by genconf)
<handleType>: real python handle type (e.g. PublicToolHandle, PrivateToolHandle, ...)
<allowedType>: allowed instance type for default

Definition at line 154 of file PropertyProxy.py.

                                                                           :
        """<descr>: the real property in the object instance (from __slots__)
        <docString>: the documentation string of this property
        <default>: default value from C++ (via python generated by genconf)
        <handleType>: real python handle type (e.g. PublicToolHandle, PrivateToolHandle, ...)
        <allowedType>: allowed instance type for default
        """
        # check that default is of allowed type for this proxy
        if not isinstance(default,allowedType):
            raise TypeError( "%s: %s default: %r is not a %s" % \
                             ( descr.__name__, self.__class__.__name__, default, allowedType.__name__ ) )
        PropertyProxy.__init__( self, descr, docString, default )
        self._handleType = handleType
        self._confTypeName = 'Configurable' + handleType.componentType
#      print "%s: %r (%s)" % (self.__class__.__name__,self._handleType,self._confTypeName)

---

Member Function Documentation

def PropertyProxy::GaudiHandlePropertyProxyBase::__get__	(		self,
			obj,
			type = None
	)

Reimplemented from PropertyProxy::PropertyProxy.

Definition at line 171 of file PropertyProxy.py.

                                         :
        try:
            return self.descr.__get__( obj, type )
        except AttributeError:
            # Get default
            try:
                default = obj.__class__.getDefaultProperty( self.descr.__name__ )
                default = self.convertDefaultToBeSet( obj, default )
                if default:
                    self.__set__( obj, default )
            except AttributeError,e:
                # change type of exception to avoid false error message
                raise RuntimeError(*e.args)

        return self.descr.__get__( obj, type )

def PropertyProxy::GaudiHandlePropertyProxyBase::__set__	(		self,
			obj,
			value
	)

Reimplemented from PropertyProxy::PropertyProxy.

Definition at line 188 of file PropertyProxy.py.

                                   :
     # allow a property to be set if we're in non-default mode, or if it
     # simply hasn't been set before
        if not obj._isInSetDefaults() or not obj in self.history:
            value = self.convertValueToBeSet( obj, value )
            # assign the value
            self.descr.__set__( obj, value )
            log.debug( "Setting %s = %r", self.fullPropertyName( obj ), value )
            self.history.setdefault( obj, [] ).append( value )

def PropertyProxy::GaudiHandlePropertyProxyBase::convertDefaultToBeSet	(		self,
			obj,
			default
	)

Reimplemented in PropertyProxy::GaudiHandleArrayPropertyProxy.

Definition at line 231 of file PropertyProxy.py.

                                                   :
        # turn string into handle
        isString = type(default) == str
        if not isString and self.isConfig(default):
#         print self.fullPropertyName(obj) + ": Setting default configurable: %r" % default
            return default
        elif isString or self.isHandle(default):
            if isString:
                # convert string into handle
                typeAndName = default
                default = self._handleType( typeAndName )
            else:
                typeAndName = default.typeAndName
            if not self._handleType.isPublic:
                if not typeAndName:
                    return None
                # Find corresponding default configurable of private handles
                try:
                    conf = self.getDefaultConfigurable(typeAndName, self.fullPropertyName(obj))
#               print self.fullPropertyName(obj) + ": Setting default private configurable (from default handle): %r" % conf
                except AttributeError,e:
                    # change type of exception to avoid false error message
                    raise RuntimeError(*e.args)
                if conf is None:
                    raise RuntimeError( "%s: Default configurable for class %s not found in ConfigurableDb.CfgDb" % \
                                        (self.fullPropertyName(obj),default.getType() ) )
                return conf
        else: # not a config, not a handle, not a string
            raise TypeError( "%s: default value %r is not of type %s or %s" % \
                             (self.fullPropertyName(obj),default,self._confTypeName,self._handleType.__name__) )

        return default

def PropertyProxy::GaudiHandlePropertyProxyBase::convertValueToBeSet	(		self,
			obj,
			value
	)

Reimplemented in PropertyProxy::GaudiHandleArrayPropertyProxy.

Definition at line 264 of file PropertyProxy.py.

                                               :
        if value is None: value = ''
        isString = type(value) == str
        if isString:
        # create an new handle
            return self._handleType(value)
        elif self.isHandle(value):
        # make a copy of the handle
            return self._handleType(value.toStringProperty())
        elif self.isConfig(value):
            if self._handleType.isPublic:
             # A public tool must be registered to ToolSvc before assigning it
                if derives_from(value,'ConfigurableAlgTool'):
                    if not value.isInToolSvc():
                        suggestion = 'You may need to add jobOptions lines something like:' + os.linesep + \
                                     'from AthenaCommon.AppMgr import ToolSvc' + os.linesep + \
                                     'ToolSvc += '
                        if value.getName() == value.getType(): # using default name
                            suggestion += '%s()' % value.__class__.__name__
                        else: # using user-defined name
                            suggestion += '%s(%r)' % (value.__class__.__name__,value.getName())
                        raise RuntimeError( self.fullPropertyName(obj) +
                                            ': Public tool %s is not yet in ToolSvc. %s' %
                                            (value.getJobOptName(),suggestion) )
             # make it read-only
                return self._handleType(value.toStringProperty())
            elif value.hasParent( obj.getJobOptName() ):
             # is already a child, keep as-is
                return value
            else:
             # make a copy of the configurable
                value = obj.copyChildAndSetParent( value, obj.getJobOptName() )
                # ensure that the new object is in allConfigurables
                obj.allConfigurables[value.name()] = value
                return value
        else:
            raise TypeError( "Property %s value %r is not a %s nor a %s nor a string" % \
                             (self.fullPropertyName(obj),value,self._confTypeName,self._handleType.__name__) )

        return value

def PropertyProxy::GaudiHandlePropertyProxyBase::getDefaultConfigurable	(		self,
			typeAndName,
			requester
	)

Return the configurable instance corresponding to the toolhandle if possible.
Otherwise return None

Definition at line 210 of file PropertyProxy.py.

                                                          :
        """Return the configurable instance corresponding to the toolhandle if possible.
        Otherwise return None"""
        global log
        # find the module
        typeAndNameTuple = typeAndName.split('/')
        confType = typeAndNameTuple[0]
        confClass=ConfigurableDb.getConfigurable(confType)
        # check the type of the configurable
        if not derives_from(confClass,self._confTypeName):
            log.error( "%s: Configurable %s is not a %s",
                       requester, confType, self._confTypeName )
            return None
        try:
            confName = typeAndNameTuple[1]
        except IndexError:
            return confClass() # use default name
        else:
            return confClass(confName)

def PropertyProxy::GaudiHandlePropertyProxyBase::isConfig	(		self,
			value
	)

Check if <value> is a configurable of the correct type

Definition at line 205 of file PropertyProxy.py.

                            :
        """Check if <value> is a configurable of the correct type"""
        return derives_from(value,self._confTypeName)

def PropertyProxy::GaudiHandlePropertyProxyBase::isHandle	(		self,
			value
	)

Check if <value> is a handle of the correct type

Definition at line 200 of file PropertyProxy.py.

                            :
        """Check if <value> is a handle of the correct type"""
        return isinstance(value,self._handleType)

---

Member Data Documentation

PropertyProxy::GaudiHandlePropertyProxyBase::_confTypeName [private]

Definition at line 159 of file PropertyProxy.py.

PropertyProxy::GaudiHandlePropertyProxyBase::_handleType [private]

Definition at line 159 of file PropertyProxy.py.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v22r4/GaudiKernel/python/GaudiKernel/PropertyProxy.py