Config.Modifier Class Reference

Inheritance diagram for Config.Modifier:

Public Member Functions
def	__and__ (self, other)
def	__init__ (self)
def	isChosen (self)
def	makeProcessModifier (self, func)
def	toModify (self, obj, func=None, kw)
def	toReplaceWith (self, toObj, fromObj)

Private Member Functions
def	_isOrContains (self, other)
def	_setChosen (self)

Private Attributes
	__chosen
	__processModifiers

Detailed Description

This class is used to define standard modifications to a Process.
An instance of this class is declared to denote a specific modification,e.g. era2017 could
reconfigure items in a process to match our expectation of running in 2017. Once declared,
these Modifier instances are imported into a configuration and items that need to be modified
are then associated with the Modifier and with the action to do the modification.
The registered modifications will only occur if the Modifier was passed to 
the cms.Process' constructor.

Definition at line 1298 of file Config.py.

Constructor & Destructor Documentation

def Config.Modifier.__init__

(

self

)

Definition at line 1307 of file Config.py.

  def __init__(self):
    self.__processModifiers = []
    self.__chosen = False

Member Function Documentation

def Config.Modifier.__and__	(		self,
			other
	)

Definition at line 1367 of file Config.py.

  def __and__(self, other):
    return _AndModifier(self,other)

def Config.Modifier._isOrContains (   self,   other  )

private

Definition at line 1369 of file Config.py.

Referenced by Config.ModifierChain.__copyIfExclude().

  def _isOrContains(self, other):
    return self == other

def Config.Modifier._setChosen (   self )

private

Should only be called by cms.Process instances

Definition at line 1362 of file Config.py.

References Config.Modifier.__chosen.

  def _setChosen(self):
    """Should only be called by cms.Process instances"""
    self.__chosen = True

def Config.Modifier.isChosen

(

self

)

Definition at line 1365 of file Config.py.

References Config.Modifier.__chosen.

Referenced by Config.Modifier.toModify(), and Config.Modifier.toReplaceWith().

  def isChosen(self):
    return self.__chosen

def Config.Modifier.makeProcessModifier	(		self,
			func
	)

This is used to create a ProcessModifer that can perform actions on the process as a whole.
   This takes as argument a callable object (e.g. function) that takes as its sole argument an instance of Process.
   In order to work, the value returned from this function must be assigned to a uniquely named variable.

Definition at line 1310 of file Config.py.

  def makeProcessModifier(self,func):
    """This is used to create a ProcessModifer that can perform actions on the process as a whole.
       This takes as argument a callable object (e.g. function) that takes as its sole argument an instance of Process.
       In order to work, the value returned from this function must be assigned to a uniquely named variable.
    """
    return ProcessModifier(self,func)

def Config.Modifier.toModify	(		self,
			obj,
			func = None,
			kw
	)

This is used to register an action to be performed on the specific object. Two different forms are allowed
Form 1: A callable object (e.g. function) can be passed as the second. This callable object is expected to take one argument
that will be the object passed in as the first argument.
Form 2: A list of parameter name, value pairs can be passed
   mod.toModify(foo, fred=cms.int32(7), barney = cms.double(3.14))
This form can also be used to remove a parameter by passing the value of None
#remove the parameter foo.fred       
mod.toModify(foo, fred = None)
Additionally, parameters embedded within PSets can also be modified using a dictionary
#change foo.fred.pebbles to 3 and foo.fred.friend to "barney"
mod.toModify(foo, fred = dict(pebbles = 3, friend = "barney)) )

Definition at line 1316 of file Config.py.

References RecoEcal_EventContent_cff.func, Config._AndModifier.isChosen(), Config.Modifier.isChosen(), and groupFilesInBlocks.temp.

  def toModify(self,obj, func=None,**kw):
    """This is used to register an action to be performed on the specific object. Two different forms are allowed
    Form 1: A callable object (e.g. function) can be passed as the second. This callable object is expected to take one argument
    that will be the object passed in as the first argument.
    Form 2: A list of parameter name, value pairs can be passed
       mod.toModify(foo, fred=cms.int32(7), barney = cms.double(3.14))
    This form can also be used to remove a parameter by passing the value of None
        #remove the parameter foo.fred       
        mod.toModify(foo, fred = None)
    Additionally, parameters embedded within PSets can also be modified using a dictionary
        #change foo.fred.pebbles to 3 and foo.fred.friend to "barney"
        mod.toModify(foo, fred = dict(pebbles = 3, friend = "barney)) )
    """
    if func is not None and len(kw) != 0:
      raise TypeError("toModify takes either two arguments or one argument and key/value pairs")
    if not self.isChosen():
        return
    if func is not None:
      func(obj)
    else:
      temp =_ParameterModifier(kw)
      temp(obj)

def Config.Modifier.toReplaceWith	(		self,
			toObj,
			fromObj
	)

If the Modifier is chosen the internals of toObj will be associated with the internals of fromObj

Definition at line 1338 of file Config.py.

References Config._AndModifier.isChosen(), Config.Modifier.isChosen(), and harvestTrackValidationPlots.str.

  def toReplaceWith(self,toObj,fromObj):
    """If the Modifier is chosen the internals of toObj will be associated with the internals of fromObj
    """
    if type(fromObj) != type(toObj):
        raise TypeError("toReplaceWith requires both arguments to be the same class type")
    if not self.isChosen():
        return
    if isinstance(fromObj,_ModuleSequenceType):
        toObj._seq = fromObj._seq
        toObj._tasks = fromObj._tasks
    elif isinstance(fromObj,Task):
        toObj._collection = fromObj._collection
    elif isinstance(fromObj,_Parameterizable):
        #clear old items just incase fromObj is not a complete superset of toObj
        for p in toObj.parameterNames_():
            delattr(toObj,p)
        for p in fromObj.parameterNames_():
            setattr(toObj,p,getattr(fromObj,p))
        if isinstance(fromObj,_TypedParameterizable):
            toObj._TypedParameterizable__type = fromObj._TypedParameterizable__type
            
    else:
        raise TypeError("toReplaceWith does not work with type "+str(type(toObj)))

Member Data Documentation

Config.Modifier.__chosen

private

Definition at line 1309 of file Config.py.

Referenced by Config.Modifier._setChosen(), Config.ModifierChain._setChosen(), Config.Modifier.isChosen(), and Config.ModifierChain.isChosen().

Config.Modifier.__processModifiers

private

Definition at line 1308 of file Config.py.