Inheritance diagram for python.PropertyProxy.GaudiHandlePropertyProxyBase:

Collaboration diagram for python.PropertyProxy.GaudiHandlePropertyProxyBase:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

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)
	setDefault (self, value)
	getDefault (self)
	fullPropertyName (self, obj)
	__delete__ (self, obj)

Public Attributes
	history = weakref.WeakKeyDictionary()
	descr = descr

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

Properties
	default = property( getDefault, setDefault )

Private Attributes
	__doc__ = docString
	__default = value

Detailed Description

A class with some utilities for GaudiHandles and GaudiHandleArrays

Definition at line 179 of file PropertyProxy.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Constructor & Destructor Documentation

◆ init()

python.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 182 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
#      print "%s: %r (%s)" % (self.__class__.__name__,self._handleType,self._confTypeName)
 
 

Member Function Documentation

◆ delete()

python.PropertyProxy.PropertyProxy.__delete__	(		self,
			obj )

inherited

Definition at line 172 of file PropertyProxy.py.

   def __delete__( self, obj ):
      if obj in self.history:
         del self.history[ obj ]
      self.descr.__delete__( obj )

◆ get()

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

Definition at line 199 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__ )
            # if printing, just show the toolhandle. No need to auto-retrieve default configurable instance
            if obj.isPrinting(): return default
            default = self.convertDefaultToBeSet( obj, default )
            # special case if default is auto-retrieved configurable instance
            if self.isConfig(default):
               if obj.isLocked():
                  # return a locked copy to produce error in case of setting any property
                  # rather then changing the value of the default
                  default = copy.deepcopy(default)
                  default.lock()
                  return default
               else:
                  # Set to default configurable instance to allow MyTool.MySubTool.MyProperty = MyValue
                  self.__set__( obj, default )
            elif isinstance(default,GaudiHandleArray):
               if obj.isLocked():
                  # return a locked copy to produce error in case of setting any property
                  # rather then changing the value of the default
                  default = copy.deepcopy(default)
                  for c in default:
                     if self.isConfig(c):
                        c.lock()
                  return default
               else:
                  # Set array to allow to add to default with syntax: MyTool.MyArray.append()
                  self.__set__( obj, default )
            else:
               return default
         except AttributeError as e:
            import traceback
            traceback.print_exc()
            # change type of exception to avoid false error message
            raise RuntimeError("AttributeError(%s)" % e.args)
 
      return self.descr.__get__( obj, type )
 
 

◆ set()

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

Definition at line 243 of file PropertyProxy.py.

   def __set__( self, obj, value ):
    # locked configurables can no longer be changed
      if obj.isLocked():
         raise RuntimeError(
            'can not change property "%s" of locked configurable "%s"' %
            (self.descr.__name__, obj.getJobOptName()) )
 
    # 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.verbose( "Setting %s = %r", self.fullPropertyName( obj ), value )
         self.history.setdefault( obj, [] ).append( value )
 
 

◆ convertDefaultToBeSet()

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

Reimplemented in python.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 290 of file PropertyProxy.py.

   def convertDefaultToBeSet( self, obj, default ):
      # turn string into handle
      isString = type(default) is 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 and typeAndName:
            # 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 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()

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

Reimplemented in python.PropertyProxy.GaudiHandleArrayPropertyProxy.

Definition at line 321 of file PropertyProxy.py.

   def convertValueToBeSet( self, obj, value ):
      if value is None: value = ''
      isString = type(value) is 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
            return obj.copyChildAndSetParent( value, obj.getJobOptName() )
      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
 
 

◆ fullPropertyName()

python.PropertyProxy.PropertyProxy.fullPropertyName	(		self,
			obj )

inherited

Definition at line 93 of file PropertyProxy.py.

   def fullPropertyName( self, obj ):
      return (obj.getJobOptName() or obj.getName()) + '.' + self.descr.__name__
 

◆ getDefault()

python.PropertyProxy.PropertyProxy.getDefault ( self )

inherited

Definition at line 88 of file PropertyProxy.py.

   def getDefault( self ):
      return self.__default
 

◆ getDefaultConfigurable()

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

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

Definition at line 270 of file PropertyProxy.py.

   def getDefaultConfigurable(self,typeAndName,requester):
      """Return the configurable instance corresponding to the toolhandle if possible.
      Otherwise return None"""
      # 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()

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

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

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

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

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

Definition at line 260 of file PropertyProxy.py.

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

◆ setDefault()

python.PropertyProxy.PropertyProxy.setDefault	(		self,
			value )

inherited

Definition at line 85 of file PropertyProxy.py.

   def setDefault( self, value ):
      self.__default = value
 

Member Data Documentation

◆ __default

python.PropertyProxy.PropertyProxy.__default = value

privateinherited

Definition at line 86 of file PropertyProxy.py.

◆ doc

python.PropertyProxy.PropertyProxy.__doc__ = docString

privateinherited

Definition at line 81 of file PropertyProxy.py.

◆ _confTypeName

python.PropertyProxy.GaudiHandlePropertyProxyBase._confTypeName = 'Configurable' + handleType.componentType

protected

Definition at line 195 of file PropertyProxy.py.

◆ _handleType

python.PropertyProxy.GaudiHandlePropertyProxyBase._handleType = handleType

protected

Definition at line 194 of file PropertyProxy.py.

◆ descr

python.PropertyProxy.PropertyProxy.descr = descr

inherited

Definition at line 79 of file PropertyProxy.py.

◆ history

python.PropertyProxy.PropertyProxy.history = weakref.WeakKeyDictionary()

inherited

Definition at line 78 of file PropertyProxy.py.

Property Documentation

◆ default

python.PropertyProxy.PropertyProxy.default = property( getDefault, setDefault )

staticinherited

Definition at line 91 of file PropertyProxy.py.

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

PropertyProxy.py

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Properties

Private Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __delete__()

◆ __get__()

◆ __set__()

◆ convertDefaultToBeSet()

◆ convertValueToBeSet()

◆ fullPropertyName()

◆ getDefault()

◆ getDefaultConfigurable()

◆ isConfig()

◆ isHandle()

◆ setDefault()

Member Data Documentation

◆ __default

◆ __doc__

◆ _confTypeName

◆ _handleType

◆ descr

◆ history

Property Documentation

◆ default

◆ init()

◆ delete()

◆ get()

◆ set()

◆ doc