GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase Class Reference

Inheritance diagram for GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase:

Collaboration diagram for GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase:

Public Member Functions
def	__init__ (self, descr, docString, default, handleType, allowedType)
def	__get__ (self, obj, type=None)
def	__set__ (self, obj, value)
def	isHandle (self, value)
def	isConfig (self, value)
def	getDefaultConfigurable (self, typeAndName, requester)
def	convertDefaultToBeSet (self, obj, default)
def	convertValueToBeSet (self, obj, value)
Public Member Functions inherited from GaudiKernel.PropertyProxy.PropertyProxy
def	__init__ (self, descr, docString=None, default=None)
def	setDefault (self, value)
def	getDefault (self)
def	fullPropertyName (self, obj)
def	__delete__ (self, obj)

Private Attributes
	_handleType
	_confTypeName

Additional Inherited Members
Public Attributes inherited from GaudiKernel.PropertyProxy.PropertyProxy
	history
	descr
	deprecated
Properties inherited from GaudiKernel.PropertyProxy.PropertyProxy
	default = property(getDefault, setDefault)

Detailed Description

A class with some utilities for GaudiHandles and GaudiHandleArrays

Definition at line 183 of file PropertyProxy.py.

Constructor & Destructor Documentation

__init__()

def GaudiKernel.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 186 of file PropertyProxy.py.

    def __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
        """
        # 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
 

Member Function Documentation

__get__()

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

Reimplemented from GaudiKernel.PropertyProxy.PropertyProxy.

Definition at line 210 of file PropertyProxy.py.

    def __get__(self, obj, type=None):
        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 as e:
                # change type of exception to avoid false error message
                raise RuntimeError(*e.args)
 
        return self.descr.__get__(obj, type)
 

__set__()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.__set__	(		self,
			obj,
			value
	)

Reimplemented from GaudiKernel.PropertyProxy.PropertyProxy.

Definition at line 226 of file PropertyProxy.py.

    def __set__(self, obj, value):
        # 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)
 

convertDefaultToBeSet()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.convertDefaultToBeSet	(		self,
			obj,
			default
	)

Reimplemented in GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 268 of file PropertyProxy.py.

    def convertDefaultToBeSet(self, obj, default):
        # 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
                # (make sure the name used to instantiate the private tool
                # includes the name of the owner, see https://gitlab.cern.ch/gaudi/Gaudi/-/issues/141)
                if "/" in typeAndName:
                    typeAndName = typeAndName.replace("/", "/{}.".format(obj.name()), 1)
                else:
                    typeAndName = "{0}/{1}.{0}".format(typeAndName, obj.name())
                try:
                    conf = self.getDefaultConfigurable(
                        typeAndName, self.fullPropertyName(obj)
                    )
 
                #               print self.fullPropertyName(obj) + ": Setting default private configurable (from default handle): %r" % conf
                except AttributeError as 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
 

convertValueToBeSet()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.convertValueToBeSet	(		self,
			obj,
			value
	)

Reimplemented in GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 319 of file PropertyProxy.py.

    def convertValueToBeSet(self, obj, value):
        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
 
 

getDefaultConfigurable()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.getDefaultConfigurable	(		self,
			typeAndName,
			requester
	)

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

Definition at line 244 of file PropertyProxy.py.

    def getDefaultConfigurable(self, typeAndName, requester):
        """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)
 

isConfig()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.isConfig	(		self,
			value
	)

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

Definition at line 240 of file PropertyProxy.py.

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

isHandle()

def GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.isHandle	(		self,
			value
	)

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

Definition at line 236 of file PropertyProxy.py.

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

Member Data Documentation

_confTypeName

GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase._confTypeName

private

Definition at line 206 of file PropertyProxy.py.

_handleType

GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase._handleType

private

Definition at line 205 of file PropertyProxy.py.

---

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

• GaudiKernel/python/GaudiKernel/PropertyProxy.py