Inheritance diagram for python.JobProperties.JobProperty:

Collaboration diagram for python.JobProperties.JobProperty:

Public Member Functions
def	__init__ (self, context='')

def	__bool__ (self)

def	__eq__ (self, rhs)

def	__lt__ (self, rhs)

def	__call__ (self)

def	__str__ (self)

def	__iadd__ (self, value)

def	is_locked (self)

def	set_On (self)

def	set_Off (self)

def	lock (self)

def	unlock (self)

def	__setattr__ (self, name, n_value)

def	set_Value (self, n_value)

def	get_Value (self)

def	set_Value_and_Lock (self, n_value)

def	isDefault (self)

def	help (self)

def	toBePrinted (self)

def	print_JobProperty (self, mode='minimal')

def	__new__ (self, name, bases, dct)

Static Public Attributes
bool	statusOn = False

	allowedTypes = list()

	allowedValues = list()

	StoredValue = None

Private Member Functions
def	_do_action (self)

def	_undo_action (self)

Private Attributes
	__name__

	_context_name

	_locked

Static Private Attributes
	_log = Logging.logging.getLogger('JobProperty ::')

	_nInstancesContextDict = dict()

bool	_locked = False

Detailed Description

Base class for the job properties.  
    
       The job properties are class definitions that will be 
    instanciated at the time the job property is added to global 
    container for the job properties called  "jobproperties". 
    The job properties can be also added to sub-containers within 
    the "jobproperties" container.        
  
  
    All the job properties must be defined as subclasses of 
    "JobProperty" and, as derived classes, can re-define: 

    statusOn, allowedTypes and allowedValues and StoredValue   

    The setting of the StoredValue will automatically check the new 
    value against the lists allowedTypes and allowedValues. A given 
    StoredValue can not be changed if the corresponding job property
    is locked. 
   
    The actual Value of the JobProperty is (statusOn AND StoredValue)

Definition at line 105 of file JobProperties.py.

Constructor & Destructor Documentation

◆ init()

def python.JobProperties.JobProperty.__init__	(	self,
		context = `''`
	)

Each JobProperty has only one possible instance in a given
    context. The context is given by the container and sub-containers
    to which the job property belongs.

Definition at line 137 of file JobProperties.py.

     def __init__(self,context=''):
         """ Each JobProperty has only one possible instance in a given
             context. The context is given by the container and sub-containers
             to which the job property belongs. 
         """
         if jobPropertiesDisallowed:
             raise RuntimeError("JobProperty should not be called in pure CA config")
  
         context_name=context+'.'+self.__class__.__name__
         if not (context_name in self.__class__._nInstancesContextDict.keys()):
             self.__class__._nInstancesContextDict[context_name]=self
             self.__name__=self.__class__.__name__
             self._context_name=context+'.'+self.__class__.__name__
         else:
             self._log.error("There is already an instance of %s at %s ",
                             self.__class__.__name__, context_name)
             raise RuntimeError('JobProperties: JobProperty:: __init__()')
  

Member Function Documentation

◆ bool()

def python.JobProperties.JobProperty.__bool__ ( self )

Definition at line 155 of file JobProperties.py.

     def __bool__(self):
         return self.get_Value()
     

◆ call()

def python.JobProperties.JobProperty.__call__ ( self )

Definition at line 174 of file JobProperties.py.

     def __call__(self):
         return self.get_Value()  
  

◆ eq()

def python.JobProperties.JobProperty.__eq__	(	self,
		rhs
	)

Definition at line 158 of file JobProperties.py.

     def __eq__(self, rhs):
         if isinstance(rhs, JobProperty):
             # FIXME: should we only allow comparison between same class
             #        rather than b/w JobProperties ?
             #        OTOH, JobProperty-derived classes are 'singleton'...
             return self() == rhs()
         return self() == rhs
  

◆ iadd()

def python.JobProperties.JobProperty.__iadd__	(	self,
		value
	)

Definition at line 180 of file JobProperties.py.

     def __iadd__(self,value):
         aux=self.get_Value()
         aux+=value
         self.StoredValue = aux
         return self.StoredValue
         
  

◆ lt()

def python.JobProperties.JobProperty.__lt__	(	self,
		rhs
	)

Definition at line 166 of file JobProperties.py.

     def __lt__(self, rhs):
         if isinstance(rhs, JobProperty):
             # FIXME: should we only allow comparison between same class
             #        rather than b/w JobProperties ?
             #        OTOH, JobProperty-derived classes are 'singleton'...
             return self() < rhs()
         return self() < rhs
  

◆ new()

def python.JobProperties._JobPropertyMeta.__new__	(	self,
		name,
		bases,
		dct
	)

inherited

Definition at line 78 of file JobProperties.py.

     def __new__( self, name, bases, dct ):
      # StoredValue type check
         try:
             sv = dct[ 'StoredValue' ]
             if sv is not None and not _isCompatible( dct[ 'allowedTypes' ], sv ):
                 raise TypeError(
                     'type of StoredValue (%s) not in allowedTypes (%s)' % 
                     (type(sv).__name__,dct[ 'allowedTypes' ])
                     )
         except KeyError:
             pass
  
      # StoredValue value check
         try:
             sv = dct[ 'StoredValue' ]
             if sv is not None and dct[ 'allowedValues' ] and sv not in dct[ 'allowedValues' ]:
                 raise TypeError(
                     'value of StoredValue (%s) not in allowedValues (%s)' % 
                     (str(sv),dct[ 'allowedValues' ])
                     )
         except KeyError:
             pass
  
         return type.__new__( self, name, bases, dct )
  
  
 @functools.total_ordering

◆ setattr()

def python.JobProperties.JobProperty.__setattr__	(	self,
		name,
		n_value
	)

Definition at line 245 of file JobProperties.py.

     def __setattr__(self, name, n_value):
         if hasattr(self, name):
             if name=='StoredValue' and not(self._locked):
                 if len(self.allowedValues) == 0 or \
                       True in [ x == n_value for x in self.allowedValues ]:
                   # WLAV: the following is rather puzzling in the difference
                   # of treatment of bools, especially since it does not work
                   # as expected, and even worse for compatible types. It is
                   # left as-is in place, since changing it has side-effects on
                   # RecExCommon/myTopOptions.py ...
                     if len(self.allowedTypes) == 0:
                         self.__dict__[name] = n_value
                         self.set_On()
                     elif _isCompatible(self.allowedTypes, n_value):
                         self.__dict__[name] = n_value
                         if isinstance(n_value, bool) and n_value is False:
                             self.set_Off() 
                         else:
                             self.set_On()
                     else:
                        raise ValueError(
                            ' %s is not the expected type for: %s' %
                            (n_value, self._context_name)
                            )
                 else:
                     raise ValueError(
                         ' %s is not the expected type and/or the value is not allowed for: %s' %
                         (n_value, self._context_name)
                         )
             elif name == 'StoredValue' and self._locked:
                 self._log.info('The JobProperty %s is blocked', self.__name__)
             else: 
                 self.__dict__[name] = n_value
         elif name == '__name__' or name == '_context_name':
             self.__dict__[name] = n_value
         else:
             raise AttributeError("JobProperty:: You cannot add attributes to %s" % self)
  

◆ str()

def python.JobProperties.JobProperty.__str__ ( self )

Definition at line 177 of file JobProperties.py.

     def __str__(self): 
         return self.print_JobProperty('print_v')  
  

◆ _do_action()

def python.JobProperties.JobProperty._do_action ( self )

private

A place-holder for actions to be taken at the time 
  the JobProperty.StoredValue is set or JobProperty.statusOn 
  is set to True. 

  (for advanced use)

Definition at line 190 of file JobProperties.py.

     def _do_action(self):
         """ A place-holder for actions to be taken at the time 
           the JobProperty.StoredValue is set or JobProperty.statusOn 
           is set to True. 
  
           (for advanced use)
         """
         pass 
  

◆ _undo_action()

def python.JobProperties.JobProperty._undo_action ( self )

private

A place-holder for actions to be taken at the time 
  the JobProperty.statusOn is set to False. 

  (for advanced use)

Definition at line 199 of file JobProperties.py.

     def _undo_action(self):
         """ A place-holder for actions to be taken at the time 
           the JobProperty.statusOn is set to False. 
  
           (for advanced use)
         """
         pass 
  

◆ get_Value()

def python.JobProperties.JobProperty.get_Value ( self )

Gets the value of the job property.

    This is the recommended way top retrieve the actual
   value of the job property. For boolean properties it
   gives the and(statusOn,StoredValue). For the rest of the
   properties it gives the StoredValue if the statusOn==True
   otherwise it gives None.

Definition at line 299 of file JobProperties.py.

     def get_Value(self):
         """ Gets the value of the job property.
  
             This is the recommended way top retrieve the actual
            value of the job property. For boolean properties it
            gives the and(statusOn,StoredValue). For the rest of the
            properties it gives the StoredValue if the statusOn==True
            otherwise it gives None. 
         """
         obj_p=object.__getattribute__(self, 'StoredValue')
         if isinstance(obj_p, type(True)):
             return  obj_p  & self.statusOn 
         else: 
             if self.statusOn: 
                 return obj_p 
             else: 
                 self._log.warning('You are attempting to access the job'+ 
                 'property %s which has not been set', self._context_name) 
                 return None   
  

◆ help()

def python.JobProperties.JobProperty.help ( self )

Prints the documentation available for the JobProperty. 
    together with the actual value, values allowed and types
    allowed.

Definition at line 335 of file JobProperties.py.

     def help(self):
         """ Prints the documentation available for the JobProperty. 
             together with the actual value, values allowed and types
             allowed.   
         """
         self._log.info('### Help for the class %s ###',
                         self.__class__)
         self._log.info(self.__doc__)
     
         print ('##  job property:',self._context_name, self.statusOn, self.StoredValue)
         print ('## allowed Values:',self.allowedValues)
         print ('## default Value:', self.__class__.StoredValue         )
         print ('## allowed Types :',self.allowedTypes )
         self._log.info('### End of the help for the class %s ###',
                         self.__class__)
  

◆ is_locked()

def python.JobProperties.JobProperty.is_locked ( self )

Definition at line 187 of file JobProperties.py.

     def is_locked(self):
         return self._locked
     

◆ isDefault()

def python.JobProperties.JobProperty.isDefault ( self )

check whether a flag has been modified or if it is still containing
its default value.

Definition at line 325 of file JobProperties.py.

     def isDefault (self):
         """check whether a flag has been modified or if it is still containing
         its default value.
         """
         val = self.__getattribute__('StoredValue')
         dft = self.__class__.StoredValue
         return val==dft
  
  
         

◆ lock()

def python.JobProperties.JobProperty.lock ( self )

lock the property

Definition at line 225 of file JobProperties.py.

     def lock(self):
         """ lock the property
         """
         self._locked=True
  

◆ print_JobProperty()

def python.JobProperties.JobProperty.print_JobProperty	(	self,
		mode = `'minimal'`
	)

Prints the information of the JobProperty  

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

Definition at line 374 of file JobProperties.py.

     def print_JobProperty(self,mode='minimal'):
         """ Prints the information of the JobProperty  
  
             The available options are: 'minimal','full','tree','tree&value','tree&valuenondefault'
         """
         indent=''
         obj_p=object.__getattribute__(self, 'StoredValue')
         if self.statusOn: 
             obj_ps=obj_p 
         else: 
             obj_ps=None   
         for i in range(self._context_name.count('.')-2):
             indent+='-'
         if self.is_locked():
             indent+='x'
         else:
             indent+='-'
             
         if mode=='minimal':  
                 self._log.info(" %s-> %s = %s ",indent,
                            self._context_name,pprint.pformat(obj_ps) )
             
         elif(mode=='full'):
             if len(self.allowedTypes)>0:
                  at=self.allowedTypes
             else:
                  at='- - -'
             if len(self.allowedValues)>0:
                  av=pprint.pformat(self.allowedValues)
             else:
                  av='- - -' 
             self._log.info("%s-> %s = %s\n %40s %s\n %40s \
                             %s\n %40s %s\n %40s %s\n %40s %s\n %40s %s",
                            indent,
                            self._context_name,
                            self.__getattribute__('StoredValue'),
                            'allowedTypes :',at,
                            'allowedValues :',av,
                            'default value :', self.__class__.StoredValue,
                            'statusOn :',self.statusOn,
                            'locked :',self.is_locked(),
                            'StoredValue :',pprint.pformat(obj_p))
         elif(mode=='tree'):
             print ('     |'+indent+' '+self.__name__)
         elif(mode.startswith('tree&value')):    
             if mode=='tree&value':
                 printit=True
             elif mode=='tree&valuenondefault':    
                 if self.isDefault():
                     printit=False
                 else:
                     printit=True
             else:
                 raise RuntimeError("This is a non valid print mode %s " % (mode,))
             if printit:        
                 print ('     |'+indent+' '+self.__name__+" = "+\
                     self.toBePrinted())
 #                   fnToBePrinted(self)
  
         elif(mode=='print_v'):
             return '     |'+indent+' '+self.__name__+" = "+\
                    self.toBePrinted()
         # fnToBePrinted(self)
  
         else:
             raise ValueError('Unknow mode, possible modes are: '
                              'minimal, full, tree, tree&value ')
                                 

◆ set_Off()

def python.JobProperties.JobProperty.set_Off ( self )

Sets statusOn equals to False.

Definition at line 216 of file JobProperties.py.

     def set_Off(self):
         """ Sets statusOn equals to False. 
         """
         if not(self._locked):
             self.__dict__['statusOn']=False
             self._undo_action()
         else:
             self._log.info('The JobProperty %s is blocked', self.__name__)
  

◆ set_On()

def python.JobProperties.JobProperty.set_On ( self )

Sets statusOn equals to True.

Definition at line 207 of file JobProperties.py.

     def set_On(self):
         """ Sets statusOn equals to True.
         """
         if not(self._locked):
             self.__dict__['statusOn']=True
             self._do_action()
         else:
             self._log.info('The JobProperty %s is blocked', self.__name__)
  

◆ set_Value()

def python.JobProperties.JobProperty.set_Value	(	self,
		n_value
	)

Sets the value of the JobProperty . 
   
  MyJobProperty.set_Value(NewValue)

    is equivalent to
       
  MyJobProperty=NewValue 
     
      It is checked the type and if the value is allowed. The 
    statusOn is set to True automatically.
       This method is here for backwards compatibility.

Definition at line 283 of file JobProperties.py.

     def set_Value(self, n_value):
         """ Sets the value of the JobProperty . 
            
                   MyJobProperty.set_Value(NewValue)
  
             is equivalent to
                
                   MyJobProperty=NewValue 
      
               It is checked the type and if the value is allowed. The 
             statusOn is set to True automatically.
                This method is here for backwards compatibility. 
         """
 #Joerg S/Martin W advice
         self.StoredValue=n_value
  

◆ set_Value_and_Lock()

def python.JobProperties.JobProperty.set_Value_and_Lock	(	self,
		n_value
	)

Sets the value of the JobProperty and lock it in one command .

Definition at line 319 of file JobProperties.py.

     def set_Value_and_Lock(self,n_value):
         """ Sets the value of the JobProperty and lock it in one command . 
         """
         self.set_Value(n_value)
         self.lock()
  

◆ toBePrinted()

def python.JobProperties.JobProperty.toBePrinted ( self )

compute a string which is : empty if flag is set to default value
                        (<DefaultValue> if flag not set to default value or flas is off

Definition at line 351 of file JobProperties.py.

     def toBePrinted (self):
         """ compute a string which is : empty if flag is set to default value
                                         (<DefaultValue> if flag not set to default value or flas is off  
         """
         if self.statusOn: 
             derived = self.get_Value() # can be overwritten
         else:
             derived = None
         stored = self.__getattribute__('StoredValue')
         default = self.__class__.StoredValue
         if derived==stored:
             tbp = '%s' % pprint.pformat(stored)
         else:
             tbp= '%s (Stored: %s)' %(pprint.pformat(derived),pprint.pformat(stored))
         if stored!=default:
             tbp= '%s (Default: %s)' %(tbp,pprint.pformat(default))
  
         if not self.statusOn:
             tbp = 'Off : %s ' % tbp
  
         return tbp
  
  

◆ unlock()

def python.JobProperties.JobProperty.unlock ( self )

unlock the property

Definition at line 230 of file JobProperties.py.

     def unlock(self):
         """ unlock the property
         """
         self._locked=False
         self._log.warning('The property %s is being unlocked ',
                           self._context_name)
  
             
 #   def __getattribute__(self, name):
 #       obj_p=object.__getattribute__(self, name) 
 #       if  name=='StoredValue': 
 #           self._log.error('You must access the value of the jobproperty'+
 #                          ' using the get_Value() method. ')  
 #       return obj_p
  

Member Data Documentation

◆ name

python.JobProperties.JobProperty.__name__

private

Definition at line 148 of file JobProperties.py.

◆ _context_name

python.JobProperties.JobProperty._context_name

private

Definition at line 149 of file JobProperties.py.

◆ _locked [1/2]

bool python.JobProperties.JobProperty._locked = False

staticprivate

Definition at line 135 of file JobProperties.py.

◆ _locked [2/2]

python.JobProperties.JobProperty._locked

private

Definition at line 228 of file JobProperties.py.

◆ _log

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

staticprivate

Definition at line 133 of file JobProperties.py.

◆ _nInstancesContextDict

python.JobProperties.JobProperty._nInstancesContextDict = dict()

staticprivate

Definition at line 134 of file JobProperties.py.

◆ allowedTypes

python.JobProperties.JobProperty.allowedTypes = list()

static

Definition at line 130 of file JobProperties.py.

◆ allowedValues

python.JobProperties.JobProperty.allowedValues = list()

static

Definition at line 131 of file JobProperties.py.

◆ statusOn

bool python.JobProperties.JobProperty.statusOn = False

static

Definition at line 129 of file JobProperties.py.

◆ StoredValue

python.JobProperties.JobProperty.StoredValue = None

static

Definition at line 132 of file JobProperties.py.

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

JobProperties.py

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __bool__()

◆ __call__()

◆ __eq__()

◆ __iadd__()

◆ __lt__()

◆ __new__()

◆ __setattr__()

◆ __str__()

◆ _do_action()

◆ _undo_action()

◆ get_Value()

◆ help()

◆ is_locked()

◆ isDefault()

◆ lock()

◆ print_JobProperty()

◆ set_Off()

◆ set_On()

◆ set_Value()

◆ set_Value_and_Lock()

◆ toBePrinted()

◆ unlock()

Member Data Documentation

◆ __name__

◆ _context_name

◆ _locked [1/2]

◆ _locked [2/2]

◆ _log

◆ _nInstancesContextDict

◆ allowedTypes

◆ allowedValues

◆ statusOn

◆ StoredValue

◆ init()

◆ bool()

◆ call()

◆ eq()

◆ iadd()

◆ lt()

◆ new()

◆ setattr()

◆ str()

◆ name