GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase Class Reference

Inheritance diagram for GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase:

Collaboration diagram for GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase:

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

Protected Attributes
	_handleType = handleType
str	_confTypeName = "Configurable" + handleType.componentType

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

Detailed Description

A class with some utilities for GaudiHandles and GaudiHandleArrays

Definition at line 192 of file PropertyProxy.py.

Constructor & Destructor Documentation

__init__()

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 195 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(
                f"{descr.__name__}: {self.__class__.__name__} default: {default!r} is not a {allowedType.__name__}"
            )
        PropertyProxy.__init__(self, descr, docString, default)
        self._handleType = handleType
        self._confTypeName = "Configurable" + handleType.componentType
 

Member Function Documentation

__get__()

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

Definition at line 211 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 is not None:
                    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__()

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

Definition at line 228 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 obj not 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()

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

Reimplemented in GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 270 of file PropertyProxy.py.

    def convertDefaultToBeSet(self, obj, default):
        # turn string into handle
        isString = isinstance(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("/", f"/{obj.name()}.", 1)
                else:
                    typeAndName = f"{typeAndName}/{obj.name()}.{typeAndName}"
                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(
                        f"{self.fullPropertyName(obj)}: Default configurable for class {default.getType()} not found in ConfigurableDb.CfgDb"
                    )
                return conf
        else:  # not a config, not a handle, not a string
            raise TypeError(
                f"{self.fullPropertyName(obj)}: default value {default!r} is not of type {self._confTypeName} or {self._handleType.__name__}"
            )
 
        return default
 

convertValueToBeSet()

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

Reimplemented in GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 314 of file PropertyProxy.py.

    def convertValueToBeSet(self, obj, value):
        if value is None:
            value = ""
        isString = isinstance(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 += f"{value.__class__.__name__}()"
                        else:  # using user-defined name
                            suggestion += (
                                f"{value.__class__.__name__}({value.getName()!r})"
                            )
                        raise RuntimeError(
                            self.fullPropertyName(obj)
                            + f": Public tool {value.getJobOptName()} is not yet in ToolSvc. {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 (as well as all its children)
                # are in allConfigurables
                _registerConfigurables(obj.allConfigurables, value)
                return value
        else:
            raise TypeError(
                f"Property {self.fullPropertyName(obj)} value {value!r} is not a {self._confTypeName} nor a {self._handleType.__name__} nor a string"
            )
 
        return value
 
 

getDefaultConfigurable()

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

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

Definition at line 246 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()

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

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

Definition at line 242 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()

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

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

Definition at line 238 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 = "Configurable" + handleType.componentType

protected

Definition at line 209 of file PropertyProxy.py.

_handleType

GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase._handleType = handleType

protected

Definition at line 208 of file PropertyProxy.py.

---

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

• GaudiKernel/python/GaudiKernel/PropertyProxy.py