The Gaudi Framework  v41r0 (bdbe7744)
Loading...
Searching...
No Matches
GaudiKernel.ProcessJobOptions.ConsoleHandler Class Reference
Inheritance diagram for GaudiKernel.ProcessJobOptions.ConsoleHandler:
Collaboration diagram for GaudiKernel.ProcessJobOptions.ConsoleHandler:

Public Member Functions

 __init__ (self, stream=None, prefix=None, with_time=False)
 setPrefix (self, prefix)
 printOn (self, step=1, force=False)
 printOff (self, step=1)
 disable (self, allowed=logging.WARNING)
 enable (self, allowed=logging.WARNING)

Protected Attributes

 _filter = LogFilter(_log.name)
 _formatter = LogFormatter(prefix=prefix, with_time=with_time)

Detailed Description

Definition at line 78 of file ProcessJobOptions.py.

Constructor & Destructor Documentation

◆ __init__()

GaudiKernel.ProcessJobOptions.ConsoleHandler.__init__ ( self,
stream = None,
prefix = None,
with_time = False )

Definition at line 79 of file ProcessJobOptions.py.

79 def __init__(self, stream=None, prefix=None, with_time=False):
80 if stream is None:
81 stream = sys.stdout
82 logging.StreamHandler.__init__(self, stream)
83 if prefix is None:
84 prefix = "# "
85 self._filter = LogFilter(_log.name)
86 self._formatter = LogFormatter(prefix=prefix, with_time=with_time)
87 self.setFormatter(self._formatter)
88 self.addFilter(self._filter)
89

Member Function Documentation

◆ disable()

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

Definition at line 107 of file ProcessJobOptions.py.

107 def disable(self, allowed=logging.WARNING):
108 self._filter.disable(allowed)
109

◆ enable()

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

Definition at line 110 of file ProcessJobOptions.py.

110 def enable(self, allowed=logging.WARNING):
111 self._filter.enable(allowed)
112
113

◆ printOff()

GaudiKernel.ProcessJobOptions.ConsoleHandler.printOff ( self,
step = 1 )
Increase the printing_level of 'step' units. ( >0 means no print)

Definition at line 101 of file ProcessJobOptions.py.

101 def printOff(self, step=1):
102 """
103 Increase the printing_level of 'step' units. ( >0 means no print)
104 """
105 self._filter.printOff(step)
106

◆ printOn()

GaudiKernel.ProcessJobOptions.ConsoleHandler.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 93 of file ProcessJobOptions.py.

93 def printOn(self, step=1, force=False):
94 """
95 Decrease the printing_level of 'step' units. ( >0 means no print)
96 The level cannot go below 0, unless the force flag is set to True.
97 A negative value of the threshold disables subsequent "PrintOff"s.
98 """
99 self._filter.printOn(step, force)
100

◆ setPrefix()

GaudiKernel.ProcessJobOptions.ConsoleHandler.setPrefix ( self,
prefix )

Definition at line 90 of file ProcessJobOptions.py.

90 def setPrefix(self, prefix):
91 self._formatter.prefix = prefix
92

Member Data Documentation

◆ _filter

GaudiKernel.ProcessJobOptions.ConsoleHandler._filter = LogFilter(_log.name)
protected

Definition at line 85 of file ProcessJobOptions.py.

◆ _formatter

GaudiKernel.ProcessJobOptions.ConsoleHandler._formatter = LogFormatter(prefix=prefix, with_time=with_time)
protected

Definition at line 86 of file ProcessJobOptions.py.


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