Package tipy :: Module lg :: Class ColorFormatter
[hide private]
[frames] | no frames]

Class ColorFormatter

source code

       object --+    
                |    
logging.Formatter --+
                    |
                   ColorFormatter

Add color to log messages by overring logging.Formater methods.

Instance Methods [hide private]
 
__init__(self, use_color=True)
Initialize the formatter with specified format strings.
source code
 
formatter_msg(self, msg, use_color=True) source code
 
format(self, record)
Format the specified record as text.
source code

Inherited from logging.Formatter: converter, formatException, formatTime, usesTime

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  FORMAT = '[$BOLD%(filename)-8s: %(funcName)20s():%(lineno)4s$R...
  COLOR_SEQ = '\x1b[%dm'
  COLORS = {'CRITICAL': 3, 'DEBUG': 4, 'ERROR': 1, 'INFO': 7, 'W...
  BLACK = 0
  BLUE = 4
  CYAN = 6
  GREEN = 2
  MAGENTA = 5
  RED = 1
  WHITE = 7
  YELLOW = 3
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, use_color=True)
(Constructor)

source code 

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument (if omitted, you get the ISO8601 format).

Overrides: object.__init__
(inherited documentation)

format(self, record)

source code 

Format the specified record as text.

The record's attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

Overrides: logging.Formatter.format
(inherited documentation)

Class Variable Details [hide private]

FORMAT

Value:
'[$BOLD%(filename)-8s: %(funcName)20s():%(lineno)4s$RESET][%(levelname\
)-18s] %(message)s '

COLORS

Value:
{'CRITICAL': 3, 'DEBUG': 4, 'ERROR': 1, 'INFO': 7, 'WARNING': 3}