GaudiKernel.ProcessJobOptions.LogFilter Class Reference

Inheritance diagram for GaudiKernel.ProcessJobOptions.LogFilter:

Collaboration diagram for GaudiKernel.ProcessJobOptions.LogFilter:

Public Member Functions
	__init__ (self, name="")
	filter (self, record)
	printOn (self, step=1, force=False)
	printOff (self, step=1)
	disable (self, allowed=logging.WARNING)
	enable (self, allowed=logging.WARNING)

Public Attributes
int	printing_level = 0
bool	enabled = True
	threshold = logging.WARNING

Detailed Description

Definition at line 37 of file ProcessJobOptions.py.

Constructor & Destructor Documentation

__init__()

GaudiKernel.ProcessJobOptions.LogFilter.__init__	(		self,
			name = "" )

Definition at line 38 of file ProcessJobOptions.py.

    def __init__(self, name=""):
        logging.Filter.__init__(self, name)
        self.printing_level = 0
        self.enabled = True
        self.threshold = logging.WARNING
 

Member Function Documentation

disable()

GaudiKernel.ProcessJobOptions.LogFilter.disable	(		self,
			allowed = logging.WARNING )

Definition at line 69 of file ProcessJobOptions.py.

    def disable(self, allowed=logging.WARNING):
        self.enabled = False
        self.threshold = allowed
 

enable()

GaudiKernel.ProcessJobOptions.LogFilter.enable	(		self,
			allowed = logging.WARNING )

Definition at line 73 of file ProcessJobOptions.py.

    def enable(self, allowed=logging.WARNING):
        self.enabled = True
        self.threshold = allowed
 
 

filter()

GaudiKernel.ProcessJobOptions.LogFilter.filter	(		self,
			record )

Definition at line 44 of file ProcessJobOptions.py.

    def filter(self, record):
        return record.levelno >= self.threshold or (
            self.enabled and self.printing_level <= 0
        )
 

printOff()

GaudiKernel.ProcessJobOptions.LogFilter.printOff	(		self,
			step = 1 )

Increase the printing_level of 'step' units. ( >0 means no print)

Definition at line 63 of file ProcessJobOptions.py.

    def printOff(self, step=1):
        """
        Increase the printing_level of 'step' units. ( >0 means no print)
        """
        self.printing_level += step
 

printOn()

GaudiKernel.ProcessJobOptions.LogFilter.printOn	(		self,
			step = 1,
			force = False )

Decrease the printing_level of 'step' units. ( >0 means no print)
The level cannot go below 0, unless the force flag is set to True.
A negative value of the threshold disables subsequent "PrintOff"s.

Definition at line 49 of file ProcessJobOptions.py.

    def printOn(self, step=1, force=False):
        """
        Decrease the printing_level of 'step' units. ( >0 means no print)
        The level cannot go below 0, unless the force flag is set to True.
        A negative value of the threshold disables subsequent "PrintOff"s.
        """
        if force:
            self.printing_level -= step
        else:
            if self.printing_level > step:
                self.printing_level -= step
            else:
                self.printing_level = 0
 

Member Data Documentation

enabled

bool GaudiKernel.ProcessJobOptions.LogFilter.enabled = True

Definition at line 41 of file ProcessJobOptions.py.

printing_level

int GaudiKernel.ProcessJobOptions.LogFilter.printing_level = 0

Definition at line 40 of file ProcessJobOptions.py.

threshold

GaudiKernel.ProcessJobOptions.LogFilter.threshold = logging.WARNING

Definition at line 42 of file ProcessJobOptions.py.

---

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

• GaudiKernel/python/GaudiKernel/ProcessJobOptions.py