kallithea Changeset - f6ee6d26b9bd

Changeset - f6ee6d26b9bd

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Mads Kiilerich (mads) - 6 years ago 2020-05-10 21:31:56
mads@kiilerich.com

Grafted from: a0ffe0c2e60e

logging: try to avoid using ANSI color codes when not logging to a terminal

Color on the console is nice, but it is annoying to get these codes when for
example redirecting to a file.

The formatter doesn't know exactly where the message will be used - it is fully
configurable. In the default configuration, the messages are passed to a
StreamHandler to sys.stderr .

As an approximate optmization, hardcode the color formatters to only emit color
formatting if logging to something that isatty.

1 file changed with 9 insertions and 2 deletions:

kallithea/lib/colored_formatter.py

0 comments (0 inline, 0 general)

kallithea/lib/colored_formatter.py

➞

Show inline comments

 # -*- coding: utf-8 -*-
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 import logging
 import sys
 BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(30, 38)
 # Sequences
 RESET_SEQ = "\033[0m"
 COLOR_SEQ = "\033[0;%dm"
 BOLD_SEQ = "\033[1m"
 COLORS = {
     'CRITICAL': MAGENTA,
     'ERROR': RED,
     'WARNING': CYAN,
     'INFO': GREEN,
     'DEBUG': BLUE,
     'SQL': YELLOW
+}
 def one_space_trim(s):
     if s.find("  ") == -1:
         return s
     else:
         s = s.replace('  ', ' ')
@@ @@ -44,56 +45,62 @@ def format_sql(sql): @@
     sql = sql.replace('\n', '')
     sql = one_space_trim(sql)
     sql = sql \
         .replace(',', ',\n\t') \
         .replace('SELECT', '\n\tSELECT \n\t') \
         .replace('UPDATE', '\n\tUPDATE \n\t') \
         .replace('DELETE', '\n\tDELETE \n\t') \
         .replace('FROM', '\n\tFROM') \
         .replace('ORDER BY', '\n\tORDER BY') \
         .replace('LIMIT', '\n\tLIMIT') \
         .replace('WHERE', '\n\tWHERE') \
         .replace('AND', '\n\tAND') \
         .replace('LEFT', '\n\tLEFT') \
         .replace('INNER', '\n\tINNER') \
         .replace('INSERT', '\n\tINSERT') \
         .replace('DELETE', '\n\tDELETE')
     return sql
 class ColorFormatter(logging.Formatter):
     def __init__(self, *args, **kwargs):
         # can't do super(...) here because Formatter is an old school class
         logging.Formatter.__init__(self, *args, **kwargs)
         self.plain = not getattr(sys.stderr, 'isatty', lambda: False)()
     def format(self, record):
         """
         Changes record's levelname to use with COLORS enum
         """
         def_record = logging.Formatter.format(self, record)
         if self.plain:
             return def_record
         levelname = record.levelname
         start = COLOR_SEQ % (COLORS[levelname])
         def_record = logging.Formatter.format(self, record)
         end = RESET_SEQ
         colored_record = ''.join([start, def_record, end])
         return colored_record
 class ColorFormatterSql(logging.Formatter):
     def __init__(self, *args, **kwargs):
         # can't do super(...) here because Formatter is an old school class
         logging.Formatter.__init__(self, *args, **kwargs)
         self.plain = not getattr(sys.stderr, 'isatty', lambda: False)()
     def format(self, record):
         """
         Changes record's levelname to use with COLORS enum
         """
         def_record = format_sql(logging.Formatter.format(self, record))
         if self.plain:
             return def_record
         start = COLOR_SEQ % (COLORS['SQL'])
         def_record = format_sql(logging.Formatter.format(self, record))
         end = RESET_SEQ
         colored_record = ''.join([start, def_record, end])
         return colored_record

0 comments (0 inline, 0 general)