CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes
Config.Modifier Class Reference
Inheritance diagram for Config.Modifier:

Public Member Functions

def __and__ (self, other)
 
def __init__ (self)
 
def __invert__ (self)
 
def __or__ (self, other)
 
def makeProcessModifier (self, func)
 
def toModify (self, obj, func=None, kw)
 
def toReplaceWith (self, toObj, fromObj)
 

Private Member Functions

def _isChosen (self)
 
def _isOrContains (self, other)
 
def _setChosen (self)
 

Static Private Member Functions

def _toModify (obj, func, kw)
 
def _toModifyCheck (obj, func, kw)
 
def _toReplaceWith (toObj, fromObj)
 
def _toReplaceWithCheck (toObj, fromObj)
 

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 1779 of file Config.py.

Constructor & Destructor Documentation

◆ __init__()

def Config.Modifier.__init__ (   self)

Definition at line 1788 of file Config.py.

1788  def __init__(self):
1789  self.__processModifiers = []
1790  self.__chosen = False
def __init__(self, dataset, job_number, job_id, job_name, isDA, isMC, applyBOWS, applyEXTRACOND, extraconditions, runboundary, lumilist, intlumi, maxevents, gt, allFromGT, alignmentDB, alignmentTAG, apeDB, apeTAG, bowDB, bowTAG, vertextype, tracktype, refittertype, ttrhtype, applyruncontrol, ptcut, CMSSW_dir, the_dir)

Member Function Documentation

◆ __and__()

def Config.Modifier.__and__ (   self,
  other 
)

Definition at line 1862 of file Config.py.

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

◆ __invert__()

def Config.Modifier.__invert__ (   self)

Definition at line 1864 of file Config.py.

1864  def __invert__(self):
1865  return _InvertModifier(self)

◆ __or__()

def Config.Modifier.__or__ (   self,
  other 
)

Definition at line 1866 of file Config.py.

Referenced by LumiList.LumiList.__add__().

1866  def __or__(self, other):
1867  return _OrModifier(self,other)

◆ _isChosen()

def Config.Modifier._isChosen (   self)
private

Definition at line 1860 of file Config.py.

References Config.Modifier.__chosen.

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

1860  def _isChosen(self):
1861  return self.__chosen

◆ _isOrContains()

def Config.Modifier._isOrContains (   self,
  other 
)
private

Definition at line 1868 of file Config.py.

Referenced by Config.ModifierChain.__copyIfExclude().

1868  def _isOrContains(self, other):
1869  return self == other
1870 
1871 

◆ _setChosen()

def Config.Modifier._setChosen (   self)
private
Should only be called by cms.Process instances

Definition at line 1857 of file Config.py.

References Config.Modifier.__chosen.

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

◆ _toModify()

def Config.Modifier._toModify (   obj,
  func,
  kw 
)
staticprivate

Definition at line 1819 of file Config.py.

References EcalMonitorTask_cff.func, and groupFilesInBlocks.temp.

1819  def _toModify(obj,func,**kw):
1820  if func is not None:
1821  func(obj)
1822  else:
1823  temp =_ParameterModifier(kw)
1824  temp(obj)

◆ _toModifyCheck()

def Config.Modifier._toModifyCheck (   obj,
  func,
  kw 
)
staticprivate

Definition at line 1798 of file Config.py.

1798  def _toModifyCheck(obj,func,**kw):
1799  if func is not None and len(kw) != 0:
1800  raise TypeError("toModify takes either two arguments or one argument and key/value pairs")

◆ _toReplaceWith()

def Config.Modifier._toReplaceWith (   toObj,
  fromObj 
)
staticprivate

Definition at line 1837 of file Config.py.

References str.

1837  def _toReplaceWith(toObj,fromObj):
1838  if isinstance(fromObj,_ModuleSequenceType):
1839  toObj._seq = fromObj._seq
1840  toObj._tasks = fromObj._tasks
1841  elif isinstance(fromObj,Task):
1842  toObj._collection = fromObj._collection
1843  elif isinstance(fromObj,ConditionalTask):
1844  toObj._collection = fromObj._collection
1845  elif isinstance(fromObj,_Parameterizable):
1846  #clear old items just incase fromObj is not a complete superset of toObj
1847  for p in toObj.parameterNames_():
1848  delattr(toObj,p)
1849  for p in fromObj.parameterNames_():
1850  setattr(toObj,p,getattr(fromObj,p))
1851  if isinstance(fromObj,_TypedParameterizable):
1852  toObj._TypedParameterizable__type = fromObj._TypedParameterizable__type
1853 
1854  else:
1855  raise TypeError("toReplaceWith does not work with type "+str(type(toObj)))
1856 
#define str(s)

◆ _toReplaceWithCheck()

def Config.Modifier._toReplaceWithCheck (   toObj,
  fromObj 
)
staticprivate

Definition at line 1826 of file Config.py.

1826  def _toReplaceWithCheck(toObj,fromObj):
1827  if not isinstance(fromObj, type(toObj)):
1828  raise TypeError("toReplaceWith requires both arguments to be the same class type")

◆ makeProcessModifier()

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 1791 of file Config.py.

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

◆ toModify()

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 1801 of file Config.py.

References Config._AndModifier._isChosen(), Config._InvertModifier._isChosen(), Config._OrModifier._isChosen(), and Config.Modifier._isChosen().

1801  def toModify(self,obj, func=None,**kw):
1802  """This is used to register an action to be performed on the specific object. Two different forms are allowed
1803  Form 1: A callable object (e.g. function) can be passed as the second. This callable object is expected to take one argument
1804  that will be the object passed in as the first argument.
1805  Form 2: A list of parameter name, value pairs can be passed
1806  mod.toModify(foo, fred=cms.int32(7), barney = cms.double(3.14))
1807  This form can also be used to remove a parameter by passing the value of None
1808  #remove the parameter foo.fred
1809  mod.toModify(foo, fred = None)
1810  Additionally, parameters embedded within PSets can also be modified using a dictionary
1811  #change foo.fred.pebbles to 3 and foo.fred.friend to "barney"
1812  mod.toModify(foo, fred = dict(pebbles = 3, friend = "barney)) )
1813  """
1814  Modifier._toModifyCheck(obj,func,**kw)
1815  if self._isChosen():
1816  Modifier._toModify(obj,func,**kw)
1817  return self

◆ toReplaceWith()

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 1829 of file Config.py.

References Config._AndModifier._isChosen(), Config._InvertModifier._isChosen(), Config._OrModifier._isChosen(), and Config.Modifier._isChosen().

1829  def toReplaceWith(self,toObj,fromObj):
1830  """If the Modifier is chosen the internals of toObj will be associated with the internals of fromObj
1831  """
1832  Modifier._toReplaceWithCheck(toObj,fromObj)
1833  if self._isChosen():
1834  Modifier._toReplaceWith(toObj,fromObj)
1835  return self

Member Data Documentation

◆ __chosen

Config.Modifier.__chosen
private

◆ __processModifiers

Config.Modifier.__processModifiers
private

Definition at line 1789 of file Config.py.