Inheritance diagram for python.JobProperties.JobPropertyContainer:

Collaboration diagram for python.JobProperties.JobPropertyContainer:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

Public Member Functions
	__init__ (self, context='')
	__setattr__ (self, name, n_value)
	__str__ (self)
	is_locked (self)
	help (self)
	import_JobProperties (self, module_name)
	import_Flags (self, module_name)
	add_Container (self, new_container)
	add_JobProperty (self, new_flag)
	del_JobProperty (self, del_flag)
	del_Container (self, del_container)
	lock_JobProperties (self)
	unlock_JobProperties (self)
	print_JobProperties (self, mode='minimal')
	set_JobProperties (self, data)
	__getattribute__ (self, name)

Protected Attributes
	_context_name = context_name

Static Protected Attributes
	_log = Logging.logging.getLogger('JobPropertyContainer::')
	_nInstancesContextList = list()
bool	_locked = False

Private Attributes
	__name__ = self.__class__.__name__
	__class__
	__doc__

Detailed Description

 Container for the JobProperties. 

     By definition it will contain a minimal set of flags,
   but this set can be increased during the job configuration
   using the "import_JobProperties" or "add_JobProperty" 
   methods. In this way it can be adapted to the diferent 
   job needs.
     A JobPropertyContainer can contain other JobProperty 
   containers, that can be added using the "add_Container" 
   method.
     There is a top global job properties container instance 
   which is called "jobproperties" that has to be used as starting
   point.

Definition at line 444 of file JobProperties.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Constructor & Destructor Documentation

◆ init()

python.JobProperties.JobPropertyContainer.__init__	(		self,
			context = '' )

 Each JobPropertyContainer has only one possible instance
    in a given context.

Definition at line 464 of file JobProperties.py.

    def __init__(self,context=''):
        """ Each JobPropertyContainer has only one possible instance
            in a given context.
        """
        if context=='': 
            context_name=self.__class__.__name__
        else: 
            context_name=context+'.'+self.__class__.__name__ 
        if not (context_name in self.__class__._nInstancesContextList):
            self.__class__._nInstancesContextList.append(context_name)
            self.__name__=self.__class__.__name__
            self._context_name=context_name
        else:
            self._log.error('There is already an instance of %s at %s',
                            self.__class__.__name__,  context_name)
            raise RuntimeError('JobProperties:JobPropertyContainer: __init__()')
 

Member Function Documentation

◆ getattribute()

python.JobProperties.JobPropertyContainer.__getattribute__	(		self,
			name )

Definition at line 757 of file JobProperties.py.

    def __getattribute__(self,name):
        try:
            return object.__getattribute__(self, name)   
        except AttributeError:
            
            errString="JobPropertyContainer:: %s does not have property %s" % (object.__getattribute__(self,'_context_name'), name)
            allattrs=object.__getattribute__(self,'__dict__').keys()
            from difflib import get_close_matches
            closestMatch=get_close_matches(name,allattrs,1)
            if len(closestMatch)>0:
                errString+=". Did you mean \'%s\'?" %  closestMatch[0]
            raise AttributeError(errString)
        pass
    
 
#=======================================================================
# data 
#=======================================================================

◆ setattr()

python.JobProperties.JobPropertyContainer.__setattr__	(	self,
		name,
		n_value )

Definition at line 481 of file JobProperties.py.

    def __setattr__(self, name, n_value):
        # Protection for the already defined JobProperties classes 
        # and inmediate asignation of a new StoredValue
        if not(name=='__name__' or name=='_context_name' or name=='_locked'):
          if (issubclass(n_value.__class__,JobProperty) or
              issubclass(n_value.__class__,JobPropertyContainer)): 
              pass 
          elif(self.__dict__.__contains__(name)): 
              pass 
          else:
              errString="JobPropertyContainer:: %s does not have property %s" % (self._context_name, name)
              try:
                  from difflib import get_close_matches
                  closestMatch=get_close_matches(name,self.__dict__.keys(),1)
                  if len(closestMatch)>0:
                      errString+=". Did you mean \'%s\'?" %  closestMatch[0] 
              except Exception:
                  pass #No execption from here
                  
              raise AttributeError(errString)
        try: 
            protected=hasattr(self.__dict__[name],'_context_name') 
        except Exception:
            protected=False 
        if not protected:
            self.__dict__[name] = n_value
        else:
            property_obj=self.__dict__.get(name)
            property_obj.StoredValue=n_value
            property_obj.statusOn=True
 
 
 

◆ str()

python.JobProperties.JobPropertyContainer.__str__ ( self )

Definition at line 514 of file JobProperties.py.

    def __str__(self): 
        if self._context_name.count('.')==0:
            # the top container case 
            print_view='    [-]'+self.__name__+'\n'+'     | '+'\n' 
            for k in sorted(self.__dict__.keys()):
                m=self.__dict__.get(k)
                if hasattr(m,'print_JobProperty'):
                    m.print_JobProperty('print_v')
                    print_view+=str(m)+'\n'
                elif hasattr(m,'print_JobProperties'):
                    indent='-'
                    for i in range(m._context_name.count('.')-1):
                        indent+='-'
                    print_view+='     /'+indent+'> ## '+m.__name__+' ## '+'\n' 
                    print_view+=m.print_JobProperties('print_v')
            return print_view         
        else: 
            return self.print_JobProperties('print_v') 
 

◆ add_Container()

python.JobProperties.JobPropertyContainer.add_Container	(		self,
			new_container )

 Adds a container of JobProperties of the type 
   JobPropertyContainer to the existing container.

Definition at line 590 of file JobProperties.py.

    def add_Container(self,new_container):
        """ Adds a container of JobProperties of the type 
           JobPropertyContainer to the existing container. 
        """
        if issubclass(new_container,JobPropertyContainer):
            issubclass(new_container,JobPropertyContainer) 
            if not(new_container.__name__ in self.__dict__.keys()):
                setattr(self,new_container.__name__,
                        new_container(self._context_name))
            else:
               self._log.warning('The container %s is already in %s',
                                  new_container.__name__,self.__name__)
        else:
           self._log.error('You are not adding a JobPropertyContainer ')
 

◆ add_JobProperty()

python.JobProperties.JobPropertyContainer.add_JobProperty	(		self,
			new_flag )

 Add one JobProperty to the present container.  

   The new JobProperty added must have a name 
   without '_' and subclass the base class "JobProperty".

Definition at line 605 of file JobProperties.py.

    def add_JobProperty(self, new_flag):
        """ Add one JobProperty to the present container.  
        
           The new JobProperty added must have a name 
           without '_' and subclass the base class "JobProperty".
        """
        if issubclass(new_flag,JobProperty):
            if not(new_flag.__name__ in self.__dict__.keys()):
                setattr(self,new_flag.__name__,new_flag(self._context_name))
            else:
                self._log.warning('The flag %s is already in %s',
                                   new_flag.__name__, self.__name__) 
        else:
           self._log.error('You are not adding a JobProperty ')
 

◆ del_Container()

python.JobProperties.JobPropertyContainer.del_Container	(		self,
			del_container )

 Deletes one sub-container of the present container.

Definition at line 634 of file JobProperties.py.

    def del_Container(self, del_container):
        """ Deletes one sub-container of the present container.  
        """
        if (issubclass(del_container,JobPropertyContainer) and  
            hasattr(self,del_container.__name__)):
            flagcontainer_obj=getattr(self,del_container.__name__) 
            delattr(self,del_container.__name__)
            del_container._nInstancesContextList.remove(flagcontainer_obj._context_name)
            self._log.warning('The JobProperty Container %s has been deleted',
                               del_container.__name__)  
        else:
            self._log.info('The JobProperty Container %s is not defined here', 
                               del_container.__name__)

◆ del_JobProperty()

python.JobProperties.JobPropertyContainer.del_JobProperty	(		self,
			del_flag )

 Deletes one JobProperty from the present container.

Definition at line 620 of file JobProperties.py.

    def del_JobProperty(self, del_flag):
        """ Deletes one JobProperty from the present container.
        """
        if (issubclass(del_flag,JobProperty) and   
            hasattr(self,del_flag.__name__)):
            flag_obj=getattr(self,del_flag.__name__)
            delattr(self,del_flag.__name__)
            del_flag._nInstancesContextDict.pop(flag_obj._context_name)
            self._log.debug('The JobProperty %s has been deleted',
                               del_flag.__name__)  
        else:
            self._log.info('The JobProperty %s is not defined here', 
                               del_flag.__name__)
 

◆ help()

python.JobProperties.JobPropertyContainer.help ( self )

 Prints the documentation generated with the JobProperty 
    container.

Definition at line 536 of file JobProperties.py.

    def help(self):
        """ Prints the documentation generated with the JobProperty 
            container.  
        """
        self._log.info('### Help for the class %s ###',
                        self.__class__)
        self._log.info(self.__doc__)
        self._log.info('### End of the help for the class %s ###',
                        self.__class__)
 

◆ import_Flags()

python.JobProperties.JobPropertyContainer.import_Flags	(		self,
			module_name )

 OBSOLETE: Use import_JobProperties

    Import modules with JobProperties specific to a given job 
   configuration.  
   
   The new specific set of JobProperties added must have a name 
   without '_' and subclass the base class "JobProperty". 

   IMPORTANT: "import_Flags" method is calling the new method 
              "import_JobProperties". For some time import_Flags
               it will work but it will be removed soon

Definition at line 574 of file JobProperties.py.

    def import_Flags(self,module_name):
        """ OBSOLETE: Use import_JobProperties
 
            Import modules with JobProperties specific to a given job 
           configuration.  
           
           The new specific set of JobProperties added must have a name 
           without '_' and subclass the base class "JobProperty". 
 
           IMPORTANT: "import_Flags" method is calling the new method 
                      "import_JobProperties". For some time import_Flags
                       it will work but it will be removed soon
        """
        self._log.warning('OBSOLETE method: use import_JobProperties') 
        self.import_JobProperties(module_name)
 

◆ import_JobProperties()

python.JobProperties.JobPropertyContainer.import_JobProperties	(		self,
			module_name )

 Import modules with JobProperties specific to a given job 
   configuration.  
   
   The new specific set of JobProperties added must have a name 
   without '_' and subclass the base class "JobProperty".

Definition at line 546 of file JobProperties.py.

    def import_JobProperties(self,module_name):
        """ Import modules with JobProperties specific to a given job 
           configuration.  
           
           The new specific set of JobProperties added must have a name 
           without '_' and subclass the base class "JobProperty".
        """
        try:
            if(module_name.count('.')==0):
                module=__import__(module_name,globals(),locals())
            elif(module_name.count('.')>0):
                module=__import__(module_name,globals(),locals(),\
                              ['JobProperties'])
        except ImportError:
            import traceback
            traceback.print_exc()
            self._log.error(" import_JobProperties: No module named %s",
                            module_name)
            return None
        mo=vars(module)
        p = re.compile('_') # mgallas  --> look into this and relax it 
        for i in mo.keys():
            if(not(p.match(i)) and 
               (i !='JobPropertyContainer' and i!='JobProperty' and 
                i !='jobproperties')):
                 mok=mo.get(i)
                 setattr(self,mok.__name__,mok(self._context_name))
 

◆ is_locked()

python.JobProperties.JobPropertyContainer.is_locked ( self )

Definition at line 533 of file JobProperties.py.

    def is_locked(self):
        return self._locked
    

◆ lock_JobProperties()

python.JobProperties.JobPropertyContainer.lock_JobProperties ( self )

 Locks the Values of the JobProperties

Definition at line 647 of file JobProperties.py.

    def lock_JobProperties(self):
        """ Locks the Values of the JobProperties
        """
        for j in self.__dict__.keys():
            j_obj=self.__dict__.get(j)
            if hasattr(j_obj,'lock_JobProperties'):
                j_obj.lock_JobProperties()
                j_obj._locked=True
            elif hasattr(j_obj,'_locked'):
                j_obj._locked=True
        self._log.info('The JobProperty Container %s is locked',
                          self.__name__)     
 

◆ print_JobProperties()

python.JobProperties.JobPropertyContainer.print_JobProperties	(		self,
			mode = 'minimal' )

Prints all the JobProperties in the container. 

    It will print also the JobProperties within the sub-containers
   present in the container. 

    The available options are: 'minimal','full','tree','tree&value','tree&valuenondefault'

Definition at line 673 of file JobProperties.py.

    def print_JobProperties(self,mode='minimal'):
        """Prints all the JobProperties in the container. 
 
            It will print also the JobProperties within the sub-containers
           present in the container. 
 
            The available options are: 'minimal','full','tree','tree&value','tree&valuenondefault'
        """
        print_view=''
        if self._context_name.count('.')==0:
            additionalinfo=''
            if (mode=='tree&valuenondefault'):
                additionalinfo="(Only non default values)"
            if mode != "minimal":
                additionalinfo+="(X indicates locked properties)"
                
            self._log.info("### Printing the job properties container %s %s ###",
                           self.__name__ ,additionalinfo)
 
            if(mode=='tree' or mode.startswith('tree&value')):
                print ('    [-]'+self.__name__)
                print ('     | ')
            elif(mode=='print_v'):
                print_view+='    [-]'+self.__name__+'\n'+'     | '+'\n' 
            else:
                self._log.info('    [-]'+self.__name__)
       
        for k in sorted(self.__dict__.keys()):
            m=self.__dict__.get(k)
            if hasattr(m,'print_JobProperty'):
                m.print_JobProperty(mode)
                if mode=='print_v': 
                   print_view+=str(m)+'\n'
            elif hasattr(m,'print_JobProperties'):
                indent='-'
                for i in range(m._context_name.count('.')-1):
                    indent+='-'
                if(mode=='tree' or mode.startswith('tree&value')):    
                    print ('     /'+indent+'> ## '+m.__name__+' ## ')
                elif(mode=='print_v'): 
                    print_view+='     /'+indent+'> ## '+m.__name__+' ## '+'\n' 
                else:
                    self._log.info('     /'+indent+'> ## '+m.__name__+' ## ')
 
                if(mode=='print_v'):
                    print_view+=m.print_JobProperties(mode)
                else:
                    m.print_JobProperties(mode)
                
        if mode=='print_v':
           return print_view         
        if self._context_name.count('.')==0:
            self._log.info("### Ends the job properties container %s ###",
                           self.__name__ )
 

◆ set_JobProperties()

python.JobProperties.JobPropertyContainer.set_JobProperties	(		self,
			data )

 It can be used to set several job properties in different
    JobContainers in one step.


    The expected data must be a dict as for example:

     data={'JobProperties.SimFlags':{'init_Level':2,'SeedsG4':.98},
           'JobProperties.Digitization':{'writeMuonDigit':False}
          }

Definition at line 728 of file JobProperties.py.

    def set_JobProperties(self,data):
        """ It can be used to set several job properties in different
            JobContainers in one step.
 
 
            The expected data must be a dict as for example:
 
             data={'JobProperties.SimFlags':{'init_Level':2,'SeedsG4':.98},
                   'JobProperties.Digitization':{'writeMuonDigit':False}
                  }
                  
        """
        tp=type(data)
        if tp.__name__=='dict':
            list_context=list(JobProperty._nInstancesContextDict.keys())
            for i in data.keys():
                for j in data[i].keys():
                    if list_context.count(i+'.'+j)==1:
                        jp=JobProperty._nInstancesContextDict[i+'.'+j]
                        jp.set_Value(data[i][j])
                        self._log.info("The JobProperty %s has been set to %s",
                                      i+'.'+j,data[i][j])
                    else:
                        self._log.warning("The JobProperty %s does not exist",
                                          i+'.'+j)
        else:
            raise ValueError('The received data is has not the expected'
                             'type/format') 
 

◆ unlock_JobProperties()

python.JobProperties.JobPropertyContainer.unlock_JobProperties ( self )

 Unlocks the Values of the JobProperties

Definition at line 660 of file JobProperties.py.

    def unlock_JobProperties(self):
        """ Unlocks the Values of the JobProperties
        """
        for j in self.__dict__.keys():
            j_obj=self.__dict__.get(j)
            if hasattr(j_obj,'lock_JobProperties'):
                j_obj.unlock_JobProperties()
                j_obj._locked=False
            elif hasattr(j_obj,'_locked'):
                j_obj._locked=False            
        self._log.warning('The JobProperty Container %s is being unlocked ',
                          self.__name__)
 

Member Data Documentation

◆ class

python.JobProperties.JobPropertyContainer.__class__

private

Definition at line 541 of file JobProperties.py.

◆ doc

python.JobProperties.JobPropertyContainer.__doc__

private

Definition at line 542 of file JobProperties.py.

◆ name

python.JobProperties.JobPropertyContainer.__name__ = self.__class__.__name__

private

Definition at line 474 of file JobProperties.py.

◆ _context_name

python.JobProperties.JobPropertyContainer._context_name = context_name

protected

Definition at line 475 of file JobProperties.py.

◆ _locked

bool python.JobProperties.JobPropertyContainer._locked = False

staticprotected

Definition at line 462 of file JobProperties.py.

◆ _log

python.JobProperties.JobPropertyContainer._log = Logging.logging.getLogger('JobPropertyContainer::')

staticprotected

Definition at line 460 of file JobProperties.py.

◆ _nInstancesContextList

python.JobProperties.JobPropertyContainer._nInstancesContextList = list()

staticprotected

Definition at line 461 of file JobProperties.py.

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

JobProperties.py

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getattribute__()

◆ __setattr__()

◆ __str__()

◆ add_Container()

◆ add_JobProperty()

◆ del_Container()

◆ del_JobProperty()

◆ help()

◆ import_Flags()

◆ import_JobProperties()

◆ is_locked()

◆ lock_JobProperties()

◆ print_JobProperties()

◆ set_JobProperties()

◆ unlock_JobProperties()

Member Data Documentation

◆ __class__

◆ __doc__

◆ __name__

◆ _context_name

◆ _locked

◆ _log

◆ _nInstancesContextList

◆ init()

◆ getattribute()

◆ setattr()

◆ str()

◆ class

◆ doc

◆ name