python.JetAnalysisCommon.Configured Class Reference

Collaboration diagram for python.JetAnalysisCommon.Configured:

Public Member Functions
def	__init__ (self, name, **props)
def	__setattr__ (self, k, v)
def	getName (self)
def	setparent (self, parent)
def	prefixed (self, k)
def	ancestors (self)
def	fullname (self)
def	properties (self)
def	typeAndName (self)
def	asAnaAlg (self)
def	assignAllProperties (self, anaAlg)
def	setPropToAnaAlg (self, k, v)
def	getType (self)

Private Member Functions
def	_setattrImpl (self, k, v)

Private Attributes
	_name

Static Private Attributes
	_properties = set()
	_parent = None
	_anaAlg = None
list	_allowed = ['_properties', '_name', '_parent', '_anaAlg']

Detailed Description

A replacement for Athena auto-generated Configured python class.
Configured has the same interface as its Athena counterpart and can describe both Tools and Algorithms

This is a base class. The system replacing CompFactory will generate a derived class for each c++ Tool/Algorithm
to hold the configuration of such tool/alg  (see generateConfigured())

Definition at line 87 of file JetAnalysisCommon.py.

Constructor & Destructor Documentation

__init__()

def python.JetAnalysisCommon.Configured.__init__	(		self,
			name,
		**	props
	)

Definition at line 101 of file JetAnalysisCommon.py.

    def __init__(self, name, **props):
        self._name = name
        self._properties = set()
        for k,v in props.items():
            setattr(self,k,v)
 

Member Function Documentation

__setattr__()

def python.JetAnalysisCommon.Configured.__setattr__	(		self,
			k,
			v
	)

Definition at line 107 of file JetAnalysisCommon.py.

    def __setattr__(self, k, v):
        if k in self._allowed:
            self._setattrImpl(k,v)
        else:
            raise AttributeError("Configuration of Tool {} / {} . can't set attribute : {}".format(self.type, self._name, k) )
 

_setattrImpl()

def python.JetAnalysisCommon.Configured._setattrImpl (   self,   k,   v  )

private

Definition at line 113 of file JetAnalysisCommon.py.

    def _setattrImpl(self, k, v) :
        super().__setattr__(k,v)
        if k[0] == '_' :
            # this is not a Property 
            return
 
        if isinstance(v, Configured):
            if k in self._properties:
                raise RuntimeError( "Configuring {} / {} : Tool for property {} already exists".format(self.type, self._name, k) )
            # it's a tool:
            v.setparent(self)
            v._name = k
        elif isinstance(v, (list, tuple) ):
            if isinstance(v[0], Configured):
                v = ConfArray(k,v, self)
                super().__setattr__(k,v)                
        self._properties.add(k)
        if self._anaAlg:
            self.setPropToAnaAlg( k , v)
 
 

ancestors()

def python.JetAnalysisCommon.Configured.ancestors

(

self

)

Definition at line 144 of file JetAnalysisCommon.py.

    def ancestors(self):
        if self._parent is None : return [self]
        return self._parent.ancestors()+[self]
    

asAnaAlg()

def python.JetAnalysisCommon.Configured.asAnaAlg

(

self

)

Definition at line 158 of file JetAnalysisCommon.py.

    def asAnaAlg(self):
        if issubclass(self._cppclass, ROOT.EL.AnaReentrantAlgorithm):
            alg=ROOT.EL.AnaReentrantAlgorithmConfig()
        else:
            alg=ROOT.EL.AnaAlgorithmConfig()
 
        alg.setTypeAndName( self.typeAndName() )
        self.assignAllProperties(alg)
        return alg
 

assignAllProperties()

def python.JetAnalysisCommon.Configured.assignAllProperties	(		self,
			anaAlg
	)

Definition at line 168 of file JetAnalysisCommon.py.

    def assignAllProperties(self, anaAlg):
        self._anaAlg = anaAlg 
        for (k,v) in self.properties():
            self.setPropToAnaAlg(k,v)
            

fullname()

def python.JetAnalysisCommon.Configured.fullname

(

self

)

Definition at line 148 of file JetAnalysisCommon.py.

    def fullname(self):
        parents = self.ancestors()[1:]
        return '.'.join([p._name for p in parents])
        

getName()

def python.JetAnalysisCommon.Configured.getName

(

self

)

Definition at line 134 of file JetAnalysisCommon.py.

    def getName(self):
        return self._name
    

getType()

def python.JetAnalysisCommon.Configured.getType

(

self

)

Definition at line 186 of file JetAnalysisCommon.py.

    def getType(self):
        return self.type
        

prefixed()

def python.JetAnalysisCommon.Configured.prefixed	(		self,
			k
	)

Definition at line 140 of file JetAnalysisCommon.py.

    def prefixed(self, k):
        if self._parent is None: return k
        return self.fullname()+'.'+k
 

properties()

def python.JetAnalysisCommon.Configured.properties

(

self

)

Definition at line 152 of file JetAnalysisCommon.py.

    def properties(self):
        return [ (k, getattr(self,k)) for k in self._properties]
 

setparent()

def python.JetAnalysisCommon.Configured.setparent	(		self,
			parent
	)

Definition at line 137 of file JetAnalysisCommon.py.

    def setparent(self, parent):
        self._parent = parent
 

setPropToAnaAlg()

def python.JetAnalysisCommon.Configured.setPropToAnaAlg	(		self,
			k,
			v
	)

Definition at line 173 of file JetAnalysisCommon.py.

    def setPropToAnaAlg(self, k, v):
        alg=self._anaAlg
        if isinstance(v , Configured):
            # it must be a Tool :
            alg.createPrivateTool(v.fullname(), v.type)
            v.assignAllProperties(alg)
        elif isinstance(v, ConfArray ):
            # it is a Tool array 
            v.assignAllProperties(alg)
        else:
            # any other type :
            alg.setPropertyFromString(self.prefixed(k) , stringPropValue( v ) )
 

typeAndName()

def python.JetAnalysisCommon.Configured.typeAndName

(

self

)

Definition at line 155 of file JetAnalysisCommon.py.

    def typeAndName(self):
        return self.type+'/'+self._name
 

Member Data Documentation

_allowed

list python.JetAnalysisCommon.Configured._allowed = ['_properties', '_name', '_parent', '_anaAlg']

staticprivate

Definition at line 99 of file JetAnalysisCommon.py.

_anaAlg

python.JetAnalysisCommon.Configured._anaAlg = None

staticprivate

Definition at line 96 of file JetAnalysisCommon.py.

_name

python.JetAnalysisCommon.Configured._name

private

Definition at line 102 of file JetAnalysisCommon.py.

_parent

python.JetAnalysisCommon.Configured._parent = None

staticprivate

Definition at line 95 of file JetAnalysisCommon.py.

_properties

python.JetAnalysisCommon.Configured._properties = set()

staticprivate

Definition at line 94 of file JetAnalysisCommon.py.

---

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

• JetAnalysisCommon.py