Mixins._Parameterizable Class Reference

Inheritance diagram for Mixins._Parameterizable:

Public Member Functions
def	__delattr__ (self, name)
def	__init__ (self, arg, kargs)
def	__repr__ (self)
def	__setattr__ (self, name, value)
def	dumpPython (self, options=PrintOptions())
def	getParameter (self, params)
def	hasParameter (self, params)
def	insertContentsInto (self, parameterSet)
def	isFrozen (self)
def	isModified (self)
def	parameterNames_ (self)
def	parameters_ (self)
def	setIsFrozen (self)

Private Member Functions
def	__addParameter (self, name, value)
def	__setParameters (self, parameters)

Static Private Member Functions
def	__raiseBadSetAttr (name)

Private Attributes
	__validator
	_isFrozen
	_isModified

Detailed Description

Base class for classes which allow addition of _ParameterTypeBase data

Definition at line 162 of file Mixins.py.

Constructor & Destructor Documentation

def Mixins._Parameterizable.__init__	(		self,
			arg,
			kargs
	)

Definition at line 164 of file Mixins.py.

References Mixins._Parameterizable.__setParameters().

    def __init__(self,*arg,**kargs):
        self.__dict__['_Parameterizable__parameterNames'] = []
        self.__dict__["_isFrozen"] = False
        self.__dict__['_Parameterizable__validator'] = None
        """The named arguments are the 'parameters' which are added as 'python attributes' to the object"""
        if len(arg) != 0:
            #raise ValueError("unnamed arguments are not allowed. Please use the syntax 'name = value' when assigning arguments.")
            for block in arg:
                if type(block).__name__ != "PSet":
                    raise ValueError("Only PSets can be passed as unnamed argument blocks.  This is a "+type(block).__name__)
                self.__setParameters(block.parameters_())
        self.__setParameters(kargs)
        self._isModified = False
        

Member Function Documentation

def Mixins._Parameterizable.__addParameter (   self,   name,   value  )

private

Definition at line 233 of file Mixins.py.

Referenced by Mixins._Parameterizable.__setattr__(), Modules.SwitchProducer.__setattr__(), Mixins._Parameterizable.__setParameters(), and Modules.SwitchProducer.__setParameters().

    def __addParameter(self, name, value):
        if name == 'allowAnyLabel_':
            self.__validator = value
            self._isModified = True
            return
        if not isinstance(value,_ParameterTypeBase):
            if self.__validator is not None:
                value = self.__validator.convert_(value)
            else:
                self.__raiseBadSetAttr(name)
        if name in self.__dict__:
            message = "Duplicate insert of member " + name
            message += "\nThe original parameters are:\n"
            message += self.dumpPython() + '\n'
            raise ValueError(message)
        self.__dict__[name]=value
        self.__parameterNames.append(name)
        self._isModified = True

def Mixins._Parameterizable.__delattr__	(		self,
			name
	)

Definition at line 290 of file Mixins.py.

References Mixins._ParameterTypeBase.isFrozen(), and Mixins._Parameterizable.isFrozen().

    def __delattr__(self,name):
        if self.isFrozen():
            raise ValueError("Object already added to a process. It is read only now")
        super(_Parameterizable,self).__delattr__(name)
        self.__parameterNames.remove(name)

def Mixins._Parameterizable.__raiseBadSetAttr (   name )

staticprivate

Definition at line 296 of file Mixins.py.

    def __raiseBadSetAttr(name):
        raise TypeError(name+" does not already exist, so it can only be set to a CMS python configuration type")

def Mixins._Parameterizable.__repr__

(

self

)

Definition at line 366 of file Mixins.py.

References editorTools.UserCodeTool.dumpPython(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ImportTool.dumpPython(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ApplyTool.dumpPython(), Mixins._ParameterTypeBase.dumpPython(), ConfigToolBase.ConfigToolBase.dumpPython(), Mixins.UsingBlock.dumpPython(), Vispa.Plugins.ConfigEditor.ConfigEditorTabController.ConfigEditorTabController.dumpPython(), Mixins._Parameterizable.dumpPython(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor.dumpPython(), Config.Process.dumpPython(), and Config.SubProcess.dumpPython().

    def __repr__(self):
        return self.dumpPython()

def Mixins._Parameterizable.__setattr__	(		self,
			name,
			value
	)

Definition at line 261 of file Mixins.py.

References Mixins._Parameterizable.__addParameter(), Mixins._ParameterTypeBase._isModified, Mixins._SimpleParameterTypeBase._isModified, Mixins._Parameterizable._isModified, editorTools.UserCodeTool.dumpPython(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ImportTool.dumpPython(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ApplyTool.dumpPython(), Mixins._ParameterTypeBase.dumpPython(), ConfigToolBase.ConfigToolBase.dumpPython(), Mixins.UsingBlock.dumpPython(), Vispa.Plugins.ConfigEditor.ConfigEditorTabController.ConfigEditorTabController.dumpPython(), Mixins._Parameterizable.dumpPython(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor.dumpPython(), Config.Process.dumpPython(), Config.SubProcess.dumpPython(), Mixins._ParameterTypeBase.isFrozen(), Mixins._Parameterizable.isFrozen(), and reco::JetExtendedAssociation.setValue().

Referenced by GenObject.GenObject.setValue().

    def __setattr__(self,name,value):
        #since labels are not supposed to have underscores at the beginning
        # I will assume that if we have such then we are setting an internal variable
        if self.isFrozen() and not (name in ["_Labelable__label","_isFrozen"] or name.startswith('_')): 
            message = "Object already added to a process. It is read only now\n"
            message +=  "    %s = %s" %(name, value)
            message += "\nThe original parameters are:\n"
            message += self.dumpPython() + '\n'           
            raise ValueError(message)
        # underscored names bypass checking for _ParameterTypeBase
        if name[0]=='_':
            super(_Parameterizable,self).__setattr__(name,value)
        elif not name in self.__dict__:
            self.__addParameter(name, value)
            self._isModified = True
        else:
            # handle the case where users just replace with a value, a = 12, rather than a = cms.int32(12)
            if isinstance(value,_ParameterTypeBase):
                self.__dict__[name] = value
            else:
                self.__dict__[name].setValue(value)
            self._isModified = True

def Mixins._Parameterizable.__setParameters (   self,   parameters  )

private

Definition at line 252 of file Mixins.py.

References Mixins._Parameterizable.__addParameter(), and Mixins._Parameterizable.__validator.

Referenced by Mixins._Parameterizable.__init__().

    def __setParameters(self,parameters):
        v = None
        for name,value in six.iteritems(parameters):
            if name == 'allowAnyLabel_':
                v = value
                continue
            self.__addParameter(name, value)
        if v is not None:
            self.__validator=v

def Mixins._Parameterizable.dumpPython	(		self,
			options = PrintOptions()
	)

Definition at line 298 of file Mixins.py.

References join(), and Mixins._Parameterizable.parameterNames_().

Referenced by Modules.SwitchProducer.__addParameter(), Types._AllowedParameterTypes.__init__(), Mixins._Parameterizable.__repr__(), Mixins._Parameterizable.__setattr__(), and Modules.SwitchProducer.__setattr__().

    def dumpPython(self, options=PrintOptions()):
        specialImportRegistry.registerUse(self)
        sortedNames = sorted(self.parameterNames_())
        if len(sortedNames) > 200:
        #Too many parameters for a python function call
        # The solution is to create a temporary dictionary which
        # is constructed by concatenating long lists (with maximum
        # 200 entries each) together.
        # This looks like
        #  **dict( [(...,...), ...] + [...] + ... )
            others = []
            usings = []
            for name in sortedNames:
                param = self.__dict__[name]
                # we don't want minuses in names
                name2 = name.replace('-','_')
                options.indent()
                #_UsingNodes don't get assigned variables
                if name.startswith("using_"):
                    usings.append(options.indentation()+param.dumpPython(options))
                else:
                    others.append((name2, param.dumpPython(options)))
                options.unindent()

            resultList = ',\n'.join(usings)
            longOthers = options.indentation()+"**dict(\n"
            options.indent()
            longOthers += options.indentation()+"[\n"
            entriesInList = 0
            options.indent()
            for n,v in others:
                entriesInList +=1
                if entriesInList > 200:
                    #need to start a new list
                    options.unindent()
                    longOthers += options.indentation()+"] +\n"+options.indentation()+"[\n"
                    entriesInList = 0
                    options.indent()
                longOthers += options.indentation()+'("'+n+'" , '+v+' ),\n'
            
            longOthers += options.indentation()+"]\n"
            options.unindent()
            longOthers +=options.indentation()+")\n"
            options.unindent()
            ret = []
            if resultList:
                ret.append(resultList)
            if longOthers:
                ret.append(longOthers)
            return ",\n".join(ret)
        #Standard case, small number of parameters
        others = []
        usings = []
        for name in sortedNames:
            param = self.__dict__[name]
            # we don't want minuses in names
            name2 = name.replace('-','_')
            options.indent()
            #_UsingNodes don't get assigned variables
            if name.startswith("using_"):
                usings.append(options.indentation()+param.dumpPython(options))
            else:
                others.append(options.indentation()+name2+' = '+param.dumpPython(options))
            options.unindent()
        # usings need to go first
        resultList = usings
        resultList.extend(others)
        return ',\n'.join(resultList)+'\n'

def Mixins._Parameterizable.getParameter	(		self,
			params
	)

_getParameter_

Retrieve the specified parameter from the PSet Provided
given the attribute chain

returns None if not found

Definition at line 205 of file Mixins.py.

References edm.print(), and str.

Referenced by Mixins._Parameterizable.hasParameter().

    def getParameter(self, params):
        """
        _getParameter_

        Retrieve the specified parameter from the PSet Provided
        given the attribute chain

        returns None if not found
        """
        lastParam = self
        # Don't accidentally iterate over letters in a string
        if type(params).__name__ == 'str':
            return getattr(self, params, None)
        for param in params:
            lastParam = getattr(lastParam, param, None)
            print(str(lastParam))
            if lastParam == None:
                return None
        return lastParam

def Mixins._Parameterizable.hasParameter	(		self,
			params
	)

_hasParameter_

check that pset provided has the attribute chain
specified.

Eg, if params is [ 'attr1', 'attr2', 'attr3' ]
check for pset.attr1.attr2.attr3

returns True if parameter exists, False if not

Definition at line 191 of file Mixins.py.

References DropBoxMetadata::Parameters.getParameter(), Args.getParameter(), QIE8Simulator.getParameter(), AbsElectronicODERHS.getParameter(), SiStripLorentzAngleCalibration.getParameter(), SiPixelLorentzAngleCalibration.getParameter(), IntegratedCalibrationBase.getParameter(), SiStripBackplaneCalibration.getParameter(), edm::ParameterSet.getParameter(), and Mixins._Parameterizable.getParameter().

    def hasParameter(self, params):
        """
        _hasParameter_

        check that pset provided has the attribute chain
        specified.

        Eg, if params is [ 'attr1', 'attr2', 'attr3' ]
        check for pset.attr1.attr2.attr3

        returns True if parameter exists, False if not
        """
        return (self.getParameter(params) != None)

def Mixins._Parameterizable.insertContentsInto	(		self,
			parameterSet
	)

Definition at line 368 of file Mixins.py.

References Mixins._Parameterizable.parameterNames_().

Referenced by Modules.Service.insertInto(), Mixins._TypedParameterizable.insertInto(), and Types.PSet.insertInto().

    def insertContentsInto(self, parameterSet):
        for name in self.parameterNames_():
            param = getattr(self,name)
            param.insertInto(parameterSet, name)

def Mixins._Parameterizable.isFrozen

(

self

)

Definition at line 284 of file Mixins.py.

References Mixins._ParameterTypeBase._isFrozen, and Mixins._Parameterizable._isFrozen.

Referenced by Mixins._Parameterizable.__delattr__(), Mixins._Parameterizable.__setattr__(), and Modules.SwitchProducer.__setattr__().

    def isFrozen(self):
        return self._isFrozen

def Mixins._Parameterizable.isModified

(

self

)

Definition at line 181 of file Mixins.py.

References Mixins._ParameterTypeBase._isModified, Mixins._SimpleParameterTypeBase._isModified, Mixins._Parameterizable._isModified, and Mixins._Parameterizable.parameterNames_().

    def isModified(self):
        if self._isModified:
            return True
        for name in self.parameterNames_():
            param = self.__dict__[name]
            if isinstance(param, _Parameterizable) and param.isModified():
                self._isModified = True
                return True
        return False

def Mixins._Parameterizable.parameterNames_

(

self

)

Returns the name of the parameters

Definition at line 178 of file Mixins.py.

Referenced by Modules.SwitchProducer._chooseCase(), Modules.SwitchProducer.appendToProcessDescLists_(), Modules.SwitchProducer.clone(), Types.PSet.configValue(), Mixins._TypedParameterizable.dumpConfig(), Mixins._Parameterizable.dumpPython(), Modules.SwitchProducer.dumpPython(), Mixins._TypedParameterizable.dumpPython(), Types.EDAlias.dumpPython(), Modules.ESPrefer.dumpPythonAs(), Mixins._TypedParameterizable.dumpPythonAttributes(), Mixins._Parameterizable.insertContentsInto(), Modules.SwitchProducer.insertInto(), Types.EDAlias.insertInto(), Mixins._Parameterizable.isModified(), and Mixins._Parameterizable.parameters_().

    def parameterNames_(self):
        """Returns the name of the parameters"""
        return self.__parameterNames[:]

def Mixins._Parameterizable.parameters_

(

self

)

Returns a dictionary of copies of the user-set parameters

Definition at line 225 of file Mixins.py.

References Mixins._Parameterizable.parameterNames_().

Referenced by Mixins._TypedParameterizable.clone(), Types.PSet.clone(), Types.EDAlias.clone(), and Mixins._TypedParameterizable.copy().

    def parameters_(self):
        """Returns a dictionary of copies of the user-set parameters"""
        import copy
        result = dict()
        for name in self.parameterNames_():
               result[name]=copy.deepcopy(self.__dict__[name])
        return result

def Mixins._Parameterizable.setIsFrozen

(

self

)

Definition at line 286 of file Mixins.py.

Referenced by Modules._Module.__init__().

    def setIsFrozen(self):
        self._isFrozen = True
        for name in self.parameterNames_():
            self.__dict__[name].setIsFrozen() 

Member Data Documentation

Mixins._Parameterizable.__validator

private

Definition at line 235 of file Mixins.py.

Referenced by Mixins._Parameterizable.__setParameters().

Mixins._Parameterizable._isFrozen

private

Definition at line 287 of file Mixins.py.

Referenced by Mixins._Parameterizable.isFrozen(), and SequenceTypes._ModuleSequenceType.isFrozen().

Mixins._Parameterizable._isModified

private

Definition at line 176 of file Mixins.py.

Referenced by Modules.SwitchProducer.__addParameter(), Mixins._Parameterizable.__setattr__(), Modules.SwitchProducer.__setattr__(), Mixins._TypedParameterizable.copy(), and Mixins._Parameterizable.isModified().