Inheritance diagram for python.Configurable.ConfigurablePyAlgorithm:

Collaboration diagram for python.Configurable.ConfigurablePyAlgorithm:

Public Member Functions
	__init__ (self, name, **kwargs)
	getDlls (self)
	getHandle (self)
	__deepcopy__ (self, memo)
	getGaudiType (self)
	getJobOptName (self)
	__new__ (cls, args, *kwargs)
	__getstate__ (self)
	__setstate__ (self, dct)
	__getnewargs__ (self)
	__len__ (self)
	__iter__ (self)
	__iadd__ (self, configs, descr=None, index=None)
	__getattr__ (self, attr)
	__delattr__ (self, attr)
	remove (self, items)
	removeAll (self)
	clone (self, newname)
	copyChild (self, child)
	setParent (self, parentName)
	getParent (self)
	hasParent (self, parent)
	copyChildAndSetParent (self, cfg, parent)
	getChildren (self)
	overwriteChild (self, idx, newChild)
	getAllChildren (self)
	getSequence (self)
	setup (self)
	lock (self)
	unlock (self)
	isLocked (self)
	isPrinting (self)
	getProperties (self)
	getValuedProperties (self)
	properties (self)
	getDefaultProperties (cls)
	getDefaultProperty (cls, name)
	getType (cls)
	getName (self)
	name (self)
	isPublic (self)
	getFullName (self)
	getFullJobOptName (self)
	getPrintTitle (self)
	getTitleName (self)
	setDefaults (cls, handle)
	__repr__ (self)
	__str__ (self, indent=0, headerLastIndentUnit=indentUnit)
	getFlattenedProperties (self)
	getStrDescriptor (self)
	__eq__ (self, rhs)
	__ne__ (self, rhs)
	__bool__ (self)
	__call__ (cls, args, *kwargs)

Static Public Attributes
	propertyNoValue
str	indentUnit = '\| '
int	printHeaderWidth = 100
int	printHeaderPre = 5
	allConfigurables = weakref.WeakValueDictionary()

Protected Member Functions
	_isInSetDefaults (self)

Static Protected Member Functions
	_printHeader (indentStr, title)
	_printFooter (indentStr, title)

Protected Attributes
	_jobOptName = name[ name.find('/')+1 : ]
	_name = self.__class__.DefaultedName
int	_flags = 0

Static Protected Attributes
int	_fInSetDefaults = 0x01
int	_fIsLocked = 0x02
int	_fIsPrinting = 0x04
int	_fInitOk = 0x08
int	_fSetupOk = 0x10
int	_printOnce = 0
bool	_useGlobalInstances = True

Private Member Functions
	__setupDlls (self)
	__setupDefaults (self)

Private Attributes
	__name__
list	__children = []
	__class__

Static Private Attributes
dict	__slots__
	__hash__ = object.__hash__

Detailed Description

Definition at line 987 of file Configurable.py.

Constructor & Destructor Documentation

◆ init()

python.Configurable.ConfigurablePyAlgorithm.__init__	(		self,
			name,
		**	kwargs )

Definition at line 988 of file Configurable.py.

   def __init__( self, name, **kwargs ):
      super( ConfigurableAlgorithm, self ).__init__( name )
      self._jobOptName = name
 
      for n, v in kwargs.items():
         setattr(self, n, v)
 

Member Function Documentation

◆ bool()

python.Configurable.Configurable.__bool__ ( self )

inherited

Definition at line 807 of file Configurable.py.

   def __bool__ (self):
      return True
 

◆ call()

python.ConfigurableMeta.ConfigurableMeta.__call__	(		cls,
		*	args,
		**	kwargs )

inherited

To Gaudi, any object with the same type/name is the same object. Hence,
   this is mimicked in the configuration: instantiating a new Configurable
   of a type with the same name will return the same instance.

Definition at line 95 of file ConfigurableMeta.py.

   def __call__( cls, *args, **kwargs ):
      """To Gaudi, any object with the same type/name is the same object. Hence,
         this is mimicked in the configuration: instantiating a new Configurable
         of a type with the same name will return the same instance."""
 
    # Get the instance: `singleton' logic needs to be in __new__, not here,
    # for compatibililty with pickling.)
      cfg = cls.__new__( cls, *args, **kwargs )
 
    # Initialize the object, if not done already.
      if cfg and ( not hasattr(cfg, '_fInitOk') or not cfg._fInitOk ):
         cls.__init__( cfg, *args, **kwargs )
 
      return cfg

◆ deepcopy()

python.Configurable.ConfigurableAlgorithm.__deepcopy__	(		self,
			memo )

inherited

Definition at line 824 of file Configurable.py.

   def __deepcopy__( self, memo ):
      return self                 # algorithms are always shared
 

◆ delattr()

python.Configurable.Configurable.__delattr__	(		self,
			attr )

inherited

Definition at line 348 of file Configurable.py.

   def __delattr__( self, attr ):
    # remove as property, otherwise try as child
      try:
       # remove history etc., then reset to default (in case set before)
         prop = self._properties[ attr ]
         prop.__delete__( self )
         prop.__set__( self, prop.default )
         return               # reaches here? was property: done now
      except KeyError:
         pass
 
    # otherwise, remove child, if one is so named
      for c in self.__children:
         if c.getName() == attr:
            self.__children.remove( c )
 
    # potentially, there are left over caches (certain user derived classes)
      try:
         del self.__dict__[ attr ]
      except (AttributeError,KeyError):
         pass
 

◆ eq()

python.Configurable.Configurable.__eq__	(		self,
			rhs )

inherited

Definition at line 790 of file Configurable.py.

   def __eq__(self,rhs):
      # Check identity first
      if self is rhs: return True
      # Avoid comparing against None...
      if not rhs: return False
      # Class check
      if not isinstance(rhs,Configurable): return False
      # Type/Name check
      if self.getFullName() != rhs.getFullName(): return False
      # If identical types and names, then go the whole hog and test children
      # Could be sped up by testing property by property...
      return self.getStrDescriptor() == rhs.getStrDescriptor()

◆ getattr()

python.Configurable.Configurable.__getattr__	(		self,
			attr )

inherited

Definition at line 339 of file Configurable.py.

   def __getattr__( self, attr ):  # until ToolProperties exist ...
      if attr[0] == "_":
         return super( Configurable, self ).__getattribute__(attr)
      for c in self.__children:
         if c.getName() == attr:
            return c
 
      raise AttributeError( "'%s' object has no attribute '%s'" % (self.__class__,attr) )
 

◆ getnewargs()

python.Configurable.Configurable.__getnewargs__ ( self )

inherited

Definition at line 274 of file Configurable.py.

   def __getnewargs__( self ):
      return (self._name,)
 

◆ getstate()

python.Configurable.Configurable.__getstate__ ( self )

inherited

Definition at line 241 of file Configurable.py.

   def __getstate__( self ):
      d = {}
      for name, proxy in self._properties.items():
         try:
            d[ name ] = proxy.__get__( self )
         except AttributeError:
            pass
 
      d[ '_Configurable__children' ] = self.__children
      d[ '_name' ] = self._name
      if hasattr(self, '_jobOptName'):
         d[ '_jobOptName' ] = self.getJobOptName()
      d[ '_fIsLocked' ] = self.isLocked()
 
      return d
 

◆ iadd()

python.Configurable.Configurable.__iadd__	(	self,
		configs,
		descr = None,
		index = None )

inherited

Definition at line 301 of file Configurable.py.

   def __iadd__( self, configs, descr = None, index = None ):
      if self.isLocked():
         raise RuntimeError( f"cannot add children to locked configurable {self.getJobOptName()}" )
 
      if not type(configs) in (list,tuple):
         configs = ( configs, )
 
      joname = self.getJobOptName()
 
      for cfg in configs:
       # prevent type mismatches
         if not isinstance( cfg, Configurable ):
            raise TypeError( "'%s' is not a Configurable" % str(cfg) )
 
         cc = self.copyChildAndSetParent( cfg, joname )
         
       # filters dupes; usually "ok" (backdoor should catch them)
         ccjo = cc.getJobOptName()
         for c in self.__children:
            if c.getJobOptName() == ccjo:
               log.debug( 'attempt to add a duplicate (%s.%s) ... dupe ignored', joname or self.name(), ccjo )
               break
         else:
            if index is None:
               self.__children.append( cc )
            else:
               self.__children.insert( index, cc )
 
         try:
            if descr:         # support for tool properties
               descr.__set__( self, cc )
            else:
               setattr( self, cc.getName(), cc )
         except AttributeError:
            pass              # to allow free addition of tools/subalgorithms
 
      return self
 

◆ iter()

python.Configurable.Configurable.__iter__ ( self )

inherited

Definition at line 281 of file Configurable.py.

   def __iter__( self ):
      return iter( self.__children )
 

◆ len()

python.Configurable.Configurable.__len__ ( self )

inherited

Definition at line 278 of file Configurable.py.

   def __len__( self ):
      return len( self.__children )
 

◆ ne()

python.Configurable.Configurable.__ne__	(		self,
			rhs )

inherited

Definition at line 802 of file Configurable.py.

   def __ne__(self,rhs):
      return (not self.__eq__(rhs))
 

◆ new()

python.Configurable.Configurable.__new__	(		cls,
		*	args,
		**	kwargs )

inherited

To Gaudi, any object with the same type/name is the same object. Hence,
   this is mimicked in the configuration: instantiating a new Configurable
   of a type with the same name will return the same instance.

Definition at line 89 of file Configurable.py.

   def __new__ ( cls, *args, **kwargs ):
      """To Gaudi, any object with the same type/name is the same object. Hence,
         this is mimicked in the configuration: instantiating a new Configurable
         of a type with the same name will return the same instance."""
 
    # try to get the name of the Configurable (having a name is compulsory)
      if 'name' in kwargs:
       # simple keyword (by far the easiest)
         name = kwargs[ 'name' ]
      elif 'name' in cls.__init__.__code__.co_varnames:
       # either positional in args, or default
         index =  list(cls.__init__.__code__.co_varnames).index( 'name' )
         try:
          # var names index is offset by one as __init__ is to be called with self
            name = args[ index - 1 ]
         except IndexError:
          # retrieve default value, then
            name = cls.__init__.__defaults__[ index - (len(args)+1) ]
      else:
       # positional index is assumed (will work most of the time)
         try:
            name = args[1]    # '0' is for self
         except (IndexError,TypeError):
            raise TypeError( 'no "name" argument while instantiating "%s"' % cls.__name__ )
 
      if name == Configurable.DefaultName:
       # select either conventional name, or the type of the class
         if hasattr( cls, 'DefaultedName' ):
            name = cls.DefaultedName
         else:
            name = cls.getType()
      elif not name or type(name) is not str:
       # unnamed, highly specialized user code, etc. ... unacceptable
         raise TypeError( 'could not retrieve name from %s.__init__ arguments' % cls.__name__ )
 
    # close backdoor access to otherwise private subalgs/tools
      if 0 <= name.find( '.' ):
         raise NameError( '"%s": Gaudi name indexing with "." to private configurables not '
                          'allowed, as it leads to uncheckable backdoors' % name )
 
      if 0 <= name.find( '/' ):
         raise NameError( '"%s": type separator "/" no allowed in component name, '
                          'typename is derived from configurable instead' % name )
 
      if cls._useGlobalInstances:
         # ordinary recycle case
         try:
            conf = cls.configurables[ name ]
 
          # initialize additional properties, if any
            for n,v in kwargs.items():
               try:
                  setattr( conf, n, v )
               except AttributeError as originalAttributeError:
 
                # now for a completely different can of worms ...
                  acceptableKeyWord = False
 
                # little helper
                  def flat( classtree ):
                     if isinstance(classtree, (list, tuple)):
                        return [ j for i in classtree for j in flat( i ) ]
                     else:
                        return [ classtree ]
 
                # the following attempts to figure out if the missing attribute
                # is in fact an acceptable formal function argument to __init__,
                  import inspect
                  allclasses = flat( inspect.getclasstree( [ conf.__class__ ] ) )
                  for confklass in allclasses:
                     try:
                      # the following may result in the same init tried several
                      # times, but we shouldn't be in this loop too often anyway
                        if n in confklass.__init__.__code__.co_varnames:
                           acceptableKeyWord = True
                           break
                     except AttributeError:
                        pass
 
                # raising here will break the usage of keywords in __init__, but
                # there don't appear to be such cases in ATLAS yet ...
                  if not acceptableKeyWord:
                     raise originalAttributeError
            return conf
         except KeyError:
            pass
      else:
         #Run 3 style config
         #Uncomment this line to verify that RecExCommon doesn't use that
         #print "Run 3 style config" 
         pass #end if not new configuration approach
    # still here: create a new instance ...
      conf = object.__new__( cls )
 
    # ... python convention says to silently return, if __new__ fails ...
      if conf is None:
         return
 
    # ... initialize it
      cls.__init__( conf, *args, **kwargs )
 
    # update normal, per-class cache
      if cls._useGlobalInstances:
         cls.configurables[ name ] = conf
 
    # update generics super-cache
         if name in cls.allConfigurables  and conf.getType() != cls.allConfigurables[ name ].getType():
            raise TypeError( 'attempt to redefine type of "%s" (was: %s, new: %s)' %
                             (name,cls.allConfigurables[ name ].getType(), conf.getType()) )
         cls.allConfigurables[ name ] = conf
 
      return conf
 

◆ repr()

python.Configurable.Configurable.__repr__ ( self )

inherited

Definition at line 646 of file Configurable.py.

   def __repr__( self ):
      return '<%s at %s>' % (self.getFullJobOptName(),hex(id(self)))
 

◆ setstate()

python.Configurable.Configurable.__setstate__	(		self,
			dct )

inherited

Definition at line 257 of file Configurable.py.

   def __setstate__( self, dct ):
    # flags are set to neutral, not from pickle except for lockedness
      self._flags = 0
      self._flags |= self._fInitOk
      self._flags &= ~self._fInSetDefaults
      if '_fIsLocked' in dct: 
         if dct[ '_fIsLocked' ]:
            self._flags &= self._fIsLocked
         else:
            self._flags &= ~self._fIsLocked
         del dct['_fIsLocked']
      self._flags &= ~self._fIsPrinting
      for (n, v) in dct.items():
         setattr( self, n, v )
 
      return
 

◆ __setupDefaults()

python.Configurable.Configurable.__setupDefaults ( self )

privateinherited

Definition at line 625 of file Configurable.py.

   def __setupDefaults( self ):
    # set handle defaults flags to inform __setattr__ that it is being
    # called during setDefaults of the concrete Configurable
      self._flags |= self._fInSetDefaults
      self.setDefaults( self )
      self._flags &= ~self._fInSetDefaults
 

◆ __setupDlls()

python.Configurable.Configurable.__setupDlls ( self )

privateinherited

Definition at line 614 of file Configurable.py.

   def __setupDlls( self ):
      dlls = self.getDlls()
      if not dlls:
         dlls = []
      elif isinstance(dlls, str):
         dlls = [ dlls ]
 
      from AthenaCommon.AppMgr import theApp
      dlls = filter( lambda d: d not in theApp.Dlls, dlls )
      if dlls: theApp.Dlls += dlls
 

◆ str()

python.Configurable.Configurable.__str__	(	self,
		indent = 0,
		headerLastIndentUnit = indentUnit )

inherited

Definition at line 649 of file Configurable.py.

   def __str__( self, indent = 0, headerLastIndentUnit=indentUnit ):
      def _sorted_repr_set(value):
         """Helper to print sorted set representation"""
         return "{" + repr(sorted(value))[1:-1] + "}" if value else "set()"
 
      indentStr = indent*Configurable.indentUnit
    # print header
      title = self.getPrintTitle()
 
    # if run under WARNING and hight only, stick with title
      if logging.WARNING <= log.level:
         if not Configurable._printOnce:
            Configurable._printOnce = 1
            return "Reduced Configurable printout; change log level for more details, e.g.:\n   import AthenaCommon.Configurable as Configurable\n   Configurable.log.setLevel( INFO )\n" + title
         else:
            return title
 
    # avoid auto-setting private AlgTools while doing printout
      self._flags |= self._fIsPrinting
 
    # print line to easily see start-of-configurable
      if indent > 0:
         headerIndent = (indent-1)*Configurable.indentUnit + headerLastIndentUnit
      else:
         headerIndent = ''
      rep = Configurable._printHeader( headerIndent, title )
      rep += os.linesep
    # print own properties
      props = self.getProperties()
      defs = self.getDefaultProperties()
      if not props:
         rep += indentStr + '|-<no properties>' + os.linesep
      else:
       # get property name with
         nameWidth = 0
         for p in props.keys():
            nameWidth=max(nameWidth,len(p))
         propNames = sorted(props.keys())
         for p in propNames:
            v = props[p]
          # start with indent and property name
            prefix = indentStr + '|-%-*s' % (nameWidth,p)
          # add memory address for debugging (not for defaults)
            if log.isEnabledFor( logging.DEBUG ):
               if v != Configurable.propertyNoValue:
                  address = ' @%11s' % hex(id(v))
               else:
                  address = 13*' '
               prefix += address
          # add value and default
            default = defs.get(p)
 
            if not isinstance(v,MutableSequence) and v == Configurable.propertyNoValue:
               # show default value as value, and no extra 'default'
               strVal = repr(default)
               strDef = None
            else:
               # convert configurable to handle
               if isinstance(v,Configurable):
                  vv = v.getGaudiHandle()
               else:
                  vv = v
               if isinstance(vv,(GaudiHandles.GaudiHandle,
                                 GaudiHandles.GaudiHandleArray,
                                 DataHandle.DataHandle)):
                  strVal = repr(vv)
                  strDef = repr(default.toStringProperty())
                  if strDef == repr(vv.toStringProperty()):
                     strDef = None
               elif isinstance(vv, set):
                  strVal = _sorted_repr_set(vv)
                  strDef = _sorted_repr_set(default)
               else:
                  strVal = repr(vv)
                  strDef = repr(default)
          # add the value
            line = prefix + ' = ' + strVal
          # add default if present
            if strDef is not None:
               # put default on new line if too big
               if len(line) + len(strDef) > Configurable.printHeaderWidth:
                  line += os.linesep + indentStr + '| ' + (len(prefix)-len(indentStr)-3)*' '
               line += '  (default: %s)' % (strDef,)
          # add the line to the total string
            rep += line + os.linesep
 
    # print configurables + their properties, or loop over sequence
      childNotToSort = []
      childToSort    = []
      for c in self.getAllChildren():
         if isinstance(c, ConfigurableAlgorithm): childNotToSort.append(c)
         else:                                    childToSort.append(c)
    # sort the non-algs
      childToSort.sort(key=lambda x : x.getName())
      for cfg in childToSort + childNotToSort:
         rep += cfg.__str__( indent + 1, '|=' ) + os.linesep
 
    # print line to easily see end-of-configurable. Note: No linesep!
      rep += Configurable._printFooter( indentStr, title )
 
      self._flags &= ~self._fIsPrinting
      return rep
 
    # hash method for set/dict operations
    # first attempt, assuming need to recurse into child properties
    # if too much overhead, could attempt to cache with python
    # properties, but hard to propagate changes upwards to parents
 

◆ _isInSetDefaults()

python.Configurable.Configurable._isInSetDefaults ( self )

protectedinherited

Definition at line 611 of file Configurable.py.

   def _isInSetDefaults( self ):
      return self._flags & self._fInSetDefaults
 

◆ _printFooter()

python.Configurable.Configurable._printFooter	(		indentStr,
			title )

staticprotectedinherited

Definition at line 640 of file Configurable.py.

   def _printFooter( indentStr, title ):
      preLen  = Configurable.printHeaderPre
      postLen = Configurable.printHeaderWidth - preLen - 12 - len(title)# - len(indentStr)
      postLen = max(preLen,postLen)
      return indentStr + '\\%s (End of %s) %s' % (preLen*'-',title,postLen*'-')
 

◆ _printHeader()

python.Configurable.Configurable._printHeader	(		indentStr,
			title )

staticprotectedinherited

Definition at line 633 of file Configurable.py.

   def _printHeader( indentStr, title ):
      preLen  = Configurable.printHeaderPre
      postLen = Configurable.printHeaderWidth - preLen - 3 - len(title)# - len(indentStr)
      postLen = max(preLen,postLen)
      return indentStr + '/%s %s %s' % (preLen*'*',title,postLen*'*')
 

◆ clone()

python.Configurable.Configurable.clone	(		self,
			newname )

inherited

Definition at line 380 of file Configurable.py.

   def clone( self, newname ):
      if newname == self.getName():
         log.error( 'not cloning %s, because new name given is same as old name', self.getName() )
         return None
 
      return self.__class__( newname, **self.getValuedProperties() )
 

◆ copyChild()

python.Configurable.Configurable.copyChild	(		self,
			child )

inherited

Reimplemented in python.Configurable.ConfigurableService.

Definition at line 388 of file Configurable.py.

   def copyChild( self, child ):
      return copy.deepcopy( child )
 

◆ copyChildAndSetParent()

python.Configurable.Configurable.copyChildAndSetParent	(	self,
		cfg,
		parent )

inherited

Definition at line 400 of file Configurable.py.

   def copyChildAndSetParent(self,cfg,parent):
      cc = self.copyChild( cfg )
 
      if hasattr( cc, 'setParent' ) and parent:
         cc.setParent( parent )
 
      return cc
 

◆ getAllChildren()

python.Configurable.Configurable.getAllChildren ( self )

inherited

Get all (private) configurable children, both explicit ones (added with +=)
and the ones in the private GaudiHandle properties

Definition at line 414 of file Configurable.py.

   def getAllChildren( self ):
      """Get all (private) configurable children, both explicit ones (added with +=)
      and the ones in the private GaudiHandle properties"""
      childs = []
    # add private configurable properties (also inside handles)
      for proxy in self._properties.values():
         try:
            c = proxy.__get__( self )
         except AttributeError:
            pass
         else:
            if isinstance(c,Configurable) and not c.isPublic():
               childs.append(c)
            elif isinstance(c,GaudiHandles.GaudiHandle):
               try:
                  conf = c.configurable
               except AttributeError:
                  pass
               else:
                  if not conf.isPublic():
                     childs.append(conf)
            elif isinstance(c,GaudiHandles.GaudiHandleArray):
               # only setup private arrays
               if not c.isPublic():
                  for ci in c:
                     if isinstance(ci,Configurable):
                        childs.append(ci)
                     else:
                        try:
                           conf = ci.configurable
                        except AttributeError:
                           pass
                        else:
                           childs.append(conf)
                        
    # add explicit children
      childs += self.__children
      return childs
 

◆ getChildren()

python.Configurable.Configurable.getChildren ( self )

inherited

Definition at line 408 of file Configurable.py.

   def getChildren( self ):
      return self.__children[:]    # read only
 

◆ getDefaultProperties()

python.Configurable.Configurable.getDefaultProperties ( cls )

inherited

Definition at line 544 of file Configurable.py.

   def getDefaultProperties( cls ):
 
    # user provided defaults
      c = Configurable.DefaultCollector()
      cls.setDefaults( c )
 
    # defaults from C++
      for k,v in cls._properties.items():
         if k not in c.__dict__ and hasattr( v, 'default' ):
            c.__dict__[ k ] = v.default
 
      return c.__dict__
 

◆ getDefaultProperty()

python.Configurable.Configurable.getDefaultProperty	(		cls,
			name )

inherited

Definition at line 558 of file Configurable.py.

   def getDefaultProperty( cls, name ):
 
    # user provided defaults
      c = Configurable.DefaultCollector()
      cls.setDefaults( c )
 
      if name in c.__dict__:
         return c.__dict__[ name ]
 
    # defaults from C++
      try:
         v = cls._properties[name]
         if hasattr( v, 'default' ):
            return v.default
      except KeyError:
         pass
 
      return None
 

◆ getDlls()

python.Configurable.ConfigurablePyAlgorithm.getDlls ( self )

Definition at line 995 of file Configurable.py.

   def getDlls( self ):
      return None
 

◆ getFlattenedProperties()

python.Configurable.Configurable.getFlattenedProperties ( self )

inherited

Definition at line 757 of file Configurable.py.

   def getFlattenedProperties(self):
      self._flags |= self._fIsPrinting
      properties = self.getValuedProperties()
      propstr = ""
      for key,val in sorted(properties.items()):
         if isinstance(val, (GaudiHandles.PublicToolHandle, GaudiHandles.PrivateToolHandle)):
            propstr += val.getFullName()
         elif isinstance(val,Configurable):
            propstr += "({0}:{1})".format(key,val.getFlattenedProperties())
         elif isinstance(val, (GaudiHandles.PublicToolHandleArray, GaudiHandles.PrivateToolHandleArray)):
            for th in val:
               # Handle ToolHandles that have just been set as strings(?)
               if isinstance(th,Configurable):
                  propstr += "({0}:{1}".format(th.getFullName(), th.getFlattenedProperties())
               else:
                  propstr += th.getFullName()
         else:
            propstr += "({0}:{1})".format(key,str(val))
      self._flags &= ~self._fIsPrinting
      return propstr
 

◆ getFullJobOptName()

python.Configurable.Configurable.getFullJobOptName ( self )

inherited

Definition at line 596 of file Configurable.py.

   def getFullJobOptName( self ):
      return "%s/%s" % (self.getType(),self.getJobOptName() or self.getName())
 

◆ getFullName()

python.Configurable.Configurable.getFullName ( self )

inherited

Definition at line 593 of file Configurable.py.

   def getFullName( self ) :
      return str( self.getType() + '/' + self.getName() )
 

◆ getGaudiType()

python.Configurable.ConfigurableAlgorithm.getGaudiType ( self )

inherited

Definition at line 834 of file Configurable.py.

   def getGaudiType( self ):
      return 'Algorithm'
 

◆ getHandle()

python.Configurable.ConfigurablePyAlgorithm.getHandle ( self )

Reimplemented from python.Configurable.ConfigurableAlgorithm.

Definition at line 998 of file Configurable.py.

   def getHandle( self ):
      return None

◆ getJobOptName()

python.Configurable.ConfigurableAlgorithm.getJobOptName ( self )

inherited

Reimplemented from python.Configurable.Configurable.

Definition at line 837 of file Configurable.py.

   def getJobOptName( self ):
      return self._jobOptName

◆ getName()

python.Configurable.Configurable.getName ( self )

inherited

Definition at line 580 of file Configurable.py.

   def getName( self ):
      return self._name
 

◆ getParent()

python.Configurable.Configurable.getParent ( self )

inherited

Reimplemented in python.Configurable.ConfigurableAlgTool.

Definition at line 394 of file Configurable.py.

   def getParent( self ):
      return ""
 

◆ getPrintTitle()

python.Configurable.Configurable.getPrintTitle ( self )

inherited

Reimplemented in python.Configurable.ConfigurableAlgTool.

Definition at line 599 of file Configurable.py.

   def getPrintTitle(self):
      return self.getGaudiType() + ' ' + self.getTitleName()
 

◆ getProperties()

python.Configurable.Configurable.getProperties ( self )

inherited

Definition at line 515 of file Configurable.py.

   def getProperties( self ):
      props = {}
      for name, proxy in self._properties.items():
         try:
            props[ name ] = proxy.__get__( self )
         except AttributeError:
            props[ name ] = Configurable.propertyNoValue
 
      return props
 

◆ getSequence()

python.Configurable.Configurable.getSequence ( self )

inherited

Definition at line 453 of file Configurable.py.

   def getSequence( self ):
      elems = []
      for c in self.__children:
         elems.append( c.getFullName() )
      return elems
 

◆ getStrDescriptor()

python.Configurable.Configurable.getStrDescriptor ( self )

inherited

Definition at line 778 of file Configurable.py.

   def getStrDescriptor(self):
 
      descr = ""
      if hasattr( self,"_name" ):
         propstr = self.getFlattenedProperties()
         descr = (self.getFullName(), propstr)
      else: # Not yet initialised?
         descr = self.getType()
      
      return descr
 

◆ getTitleName()

python.Configurable.Configurable.getTitleName ( self )

inherited

Definition at line 602 of file Configurable.py.

   def getTitleName( self ):
      if log.isEnabledFor( logging.DEBUG ):
         return self.getFullJobOptName()
      else:
         return self.getFullName()
 

◆ getType()

python.Configurable.Configurable.getType ( cls )

inherited

Reimplemented in python.AppMgr.AthServiceManager.

Definition at line 577 of file Configurable.py.

   def getType( cls ):
      return cls.__name__
 

◆ getValuedProperties()

python.Configurable.Configurable.getValuedProperties ( self )

inherited

Definition at line 525 of file Configurable.py.

   def getValuedProperties( self ):
      props = {}
      for name, proxy in self._properties.items():
         try:
            value = proxy.__get__( self )
            if hasattr(value, 'getFullName') :
               value = value.getFullName()
            elif type(value) is list and len(value) > 0 and hasattr(value[0], 'getFullName'):
               value = [ i.getFullName() for i in value ]
            props[ name ] = value               
         except AttributeError:
            pass
 
      return props
 

◆ hasParent()

python.Configurable.Configurable.hasParent	(		self,
			parent )

inherited

Reimplemented in python.Configurable.ConfigurableAlgTool.

Definition at line 397 of file Configurable.py.

   def hasParent( self, parent ):
      return False
 

◆ isLocked()

python.Configurable.Configurable.isLocked ( self )

inherited

Definition at line 507 of file Configurable.py.

   def isLocked( self ):
    # check whether this configurable is currently locked
      return self._flags & self._fIsLocked
 

◆ isPrinting()

python.Configurable.Configurable.isPrinting ( self )

inherited

Definition at line 511 of file Configurable.py.

   def isPrinting( self ):
    # check whether this configurable is currently being printed (see PropertyProxy.py)
      return self._flags & self._fIsPrinting
 

◆ isPublic()

python.Configurable.Configurable.isPublic ( self )

inherited

Reimplemented in python.Configurable.ConfigurableAlgTool.

Definition at line 589 of file Configurable.py.

   def isPublic( self ):
      return True
 

◆ lock()

python.Configurable.Configurable.lock ( self )

inherited

Definition at line 487 of file Configurable.py.

   def lock( self ):
    # prevent any further changes, unless unlocked
      self._flags |= self._fIsLocked
 
    # same for any of its private ToolHandle properties
      for k, v in self.getProperties().items():
         if isinstance( v, Configurable ):
            v.lock()
 
    # leave children alone ... most likely are public (and can't check otherwise)
 

◆ name()

python.Configurable.Configurable.name ( self )

inherited

Definition at line 583 of file Configurable.py.

   def name( self ):
      return self.getName()
 

◆ overwriteChild()

python.Configurable.Configurable.overwriteChild	(	self,
		idx,
		newChild )

inherited

Definition at line 411 of file Configurable.py.

   def overwriteChild( self, idx, newChild ):
      self.__children[idx] = newChild
 

◆ properties()

python.Configurable.Configurable.properties ( self )

inherited

Definition at line 540 of file Configurable.py.

   def properties( self ):
      return self.getProperties()           # compatibility
 

◆ remove()

python.Configurable.Configurable.remove	(		self,
			items )

inherited

Definition at line 370 of file Configurable.py.

   def remove( self, items ):
      if not isinstance(items, (list, tuple)):
         items = [ items ]
 
      self.__children = [ e for e in self.__children if e not in items ]
 

◆ removeAll()

python.Configurable.Configurable.removeAll ( self )

inherited

Definition at line 376 of file Configurable.py.

   def removeAll( self ):
      self.remove( self.__children )
 

◆ setDefaults()

python.Configurable.Configurable.setDefaults	(		cls,
			handle )

inherited

Definition at line 608 of file Configurable.py.

   def setDefaults( cls, handle ):
      pass
 

◆ setParent()

python.Configurable.Configurable.setParent	(		self,
			parentName )

inherited

Reimplemented in python.Configurable.ConfigurableAlgTool.

Definition at line 391 of file Configurable.py.

   def setParent( self, parentName ):
      pass
 

◆ setup()

python.Configurable.Configurable.setup ( self )

inherited

Reimplemented in python.AppMgr.AthServiceManager.

Definition at line 459 of file Configurable.py.

   def setup( self ):
    # make sure base class init has been called
      if not hasattr(self,'_fInitOk') or not self._fInitOk:
       # could check more, but this is the only explanation
         raise TypeError("Configurable.__init__ not called in %s override" % self.__class__.__name__)
 
    # setup self: this collects all values on the python side
      self.__setupDlls()
      self.__setupDefaults()
 
    # setup children
      for c in self.getAllChildren():
         c.setup()
 
    # now get handle to work with for moving properties into the catalogue
      handle = self.getHandle()
      if not handle:     
         log.debug( 'no handle for %s: not transporting properties', self._name )    
         return                    # allowed, done early     
 
    # pass final set of properties on to handle on the C++ side or JobOptSvc
      for name in self._properties.keys():
         if hasattr( self, name ): # means property has python-side value/default
            setattr( handle, name, getattr(self,name) )
 
    # for debugging purposes
      self._flags |= self._fSetupOk
 

◆ unlock()

python.Configurable.Configurable.unlock ( self )

inherited

Definition at line 498 of file Configurable.py.

   def unlock( self ):
    # allow again changes to be made
      import sys, traceback
      stack = traceback.extract_stack( sys._getframe(1), 1 )
      log.warning( 'unlock() called on configurable "%s" in %s', self.getJobOptName(), stack[0][0] )
      self._flags &= ~self._fIsLocked
 
    # note that unlock() does not unlock the children; do that individually
 

Member Data Documentation

◆ __children

python.Configurable.Configurable.__children = []

privateinherited

Definition at line 212 of file Configurable.py.

◆ class

python.Configurable.Configurable.__class__

privateinherited

Definition at line 216 of file Configurable.py.

◆ hash

python.Configurable.Configurable.__hash__ = object.__hash__

staticprivateinherited

Definition at line 805 of file Configurable.py.

◆ name

python.Configurable.Configurable.__name__

privateinherited

Definition at line 112 of file Configurable.py.

◆ slots

dict python.Configurable.ConfigurableAlgorithm.__slots__

staticprivateinherited

Initial value:

=  { '_jobOptName' : 0, 'OutputLevel' : 0, \
      'Enable' : 1, 'ErrorMax' : 1, 'ErrorCounter' : 0, 'AuditAlgorithms' : 0, \
      'AuditInitialize' : 0, 'AuditReinitialize' : 0, 'AuditExecute' : 0, \
      'AuditFinalize' : 0 }

Definition at line 814 of file Configurable.py.

◆ _fInitOk

int python.Configurable.Configurable._fInitOk = 0x08

staticprotectedinherited

Definition at line 69 of file Configurable.py.

◆ _fInSetDefaults

int python.Configurable.Configurable._fInSetDefaults = 0x01

staticprotectedinherited

Definition at line 66 of file Configurable.py.

◆ _fIsLocked

int python.Configurable.Configurable._fIsLocked = 0x02

staticprotectedinherited

Definition at line 67 of file Configurable.py.

◆ _fIsPrinting

int python.Configurable.Configurable._fIsPrinting = 0x04

staticprotectedinherited

Definition at line 68 of file Configurable.py.

◆ _flags

int python.Configurable.Configurable._flags = 0

protectedinherited

Definition at line 223 of file Configurable.py.

◆ _fSetupOk

int python.Configurable.Configurable._fSetupOk = 0x10

staticprotectedinherited

Definition at line 70 of file Configurable.py.

◆ _jobOptName

python.Configurable.ConfigurableAlgorithm._jobOptName = name[ name.find('/')+1 : ]

protectedinherited

Definition at line 822 of file Configurable.py.

◆ _name

python.Configurable.Configurable._name = self.__class__.DefaultedName

protectedinherited

Definition at line 217 of file Configurable.py.

◆ _printOnce

int python.Configurable.Configurable._printOnce = 0

staticprotectedinherited

Definition at line 83 of file Configurable.py.

◆ _useGlobalInstances

bool python.Configurable.Configurable._useGlobalInstances = True

staticprotectedinherited

Definition at line 87 of file Configurable.py.

◆ allConfigurables

python.Configurable.Configurable.allConfigurables = weakref.WeakValueDictionary()

staticinherited

Definition at line 79 of file Configurable.py.

◆ indentUnit

str python.Configurable.Configurable.indentUnit = '| '

staticinherited

Definition at line 62 of file Configurable.py.

◆ printHeaderPre

int python.Configurable.Configurable.printHeaderPre = 5

staticinherited

Definition at line 64 of file Configurable.py.

◆ printHeaderWidth

int python.Configurable.Configurable.printHeaderWidth = 100

staticinherited

Definition at line 63 of file Configurable.py.

◆ propertyNoValue

python.Configurable.Configurable.propertyNoValue

staticinherited

Definition at line 61 of file Configurable.py.

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

Configurable.py

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __bool__()

◆ __call__()

◆ __deepcopy__()

◆ __delattr__()

◆ __eq__()

◆ __getattr__()

◆ __getnewargs__()

◆ __getstate__()

◆ __iadd__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __new__()

◆ __repr__()

◆ __setstate__()

◆ __setupDefaults()

◆ __setupDlls()

◆ __str__()

◆ _isInSetDefaults()

◆ _printFooter()

◆ _printHeader()

◆ clone()

◆ copyChild()

◆ copyChildAndSetParent()

◆ getAllChildren()

◆ getChildren()

◆ getDefaultProperties()

◆ getDefaultProperty()

◆ getDlls()

◆ getFlattenedProperties()

◆ getFullJobOptName()

◆ getFullName()

◆ getGaudiType()

◆ getHandle()

◆ getJobOptName()

◆ getName()

◆ getParent()

◆ getPrintTitle()

◆ getProperties()

◆ getSequence()

◆ getStrDescriptor()

◆ getTitleName()

◆ getType()

◆ getValuedProperties()

◆ hasParent()

◆ isLocked()

◆ isPrinting()

◆ isPublic()

◆ lock()

◆ name()

◆ overwriteChild()

◆ properties()

◆ remove()

◆ removeAll()

◆ setDefaults()

◆ setParent()

◆ setup()

◆ unlock()

Member Data Documentation

◆ __children

◆ __class__

◆ __hash__

◆ __name__

◆ __slots__

◆ _fInitOk

◆ _fInSetDefaults

◆ _fIsLocked

◆ init()

◆ bool()

◆ call()

◆ deepcopy()

◆ delattr()

◆ eq()

◆ getattr()

◆ getnewargs()

◆ getstate()

◆ iadd()

◆ iter()

◆ len()

◆ ne()

◆ new()

◆ repr()

◆ setstate()

◆ str()

◆ class

◆ hash

◆ name

◆ slots