Inheritance diagram for config.CFG:

Public Member Functions
def	__init__ (self, kwargs)

def	__str__ (self)

def	clone (self, kwargs)

Detailed Description

Base configuration class. The attributes are used to store parameters of any type

Definition at line 35 of file config.py.

Constructor & Destructor Documentation

◆ init()

def config.CFG.__init__	(	self,
		kwargs
	)

All keyword arguments are added as attributes.

Definition at line 37 of file config.py.

References update.

     def __init__(self, **kwargs):
         '''All keyword arguments are added as attributes.'''
         self.__dict__.update( **kwargs )
 

Member Function Documentation

◆ str()

def config.CFG.__str__ ( self )

A useful printout

Definition at line 41 of file config.py.

     def __str__(self):
         '''A useful printout'''
         header = '{type}: {name}'.format( type=self.__class__.__name__,
                                           name=self.name)
         varlines = ['\t{var:<15}:   {value}'.format(var=var, value=value) \
                     for var,value in sorted(vars(self.items())) \
                     if var != 'name']
         all = [ header ]
         all.extend(varlines)
         return '\n'.join( all )
 

◆ clone()

def config.CFG.clone	(	self,
		kwargs
	)

Make a copy of this object, redefining (or adding) some parameters, just
   like in the CMSSW python configuration files. 

   For example, you can do
      module1 = cfg.Analyzer(SomeClass, 
          param1 = value1, 
          param2 = value2, 
          param3 = value3, 
          ...)
      module2 = module1.clone(
         param2 = othervalue,
         newparam = newvalue)
   and module2 will inherit the configuration of module2 except for
   the value of param2, and for having an extra newparam of value newvalue
   (the latter may be useful if e.g. newparam were optional, and needed
   only when param2 == othervalue)

   Note that, just like in CMSSW, this is a shallow copy and not a deep copy,
   i.e. if in the example above value1 were to be an object, them module1 and
   module2 will share the same instance of value1, and not have two copies.

Definition at line 52 of file config.py.

     def clone(self, **kwargs):
         '''Make a copy of this object, redefining (or adding) some parameters, just
            like in the CMSSW python configuration files. 
 
            For example, you can do
               module1 = cfg.Analyzer(SomeClass, 
                           param1 = value1, 
                           param2 = value2, 
                           param3 = value3, 
                           ...)
               module2 = module1.clone(
                          param2 = othervalue,
                          newparam = newvalue)
            and module2 will inherit the configuration of module2 except for
            the value of param2, and for having an extra newparam of value newvalue
            (the latter may be useful if e.g. newparam were optional, and needed
            only when param2 == othervalue)
 
            Note that, just like in CMSSW, this is a shallow copy and not a deep copy,
            i.e. if in the example above value1 were to be an object, them module1 and
            module2 will share the same instance of value1, and not have two copies.
         '''
         other = copy.copy(self)
         for k,v in kwargs.items():
             setattr(other, k, v)
         return other

Public Member Functions