Mercurial > libervia-backend
annotate src/core/log.py @ 993:301b342c697a
core: use of the new core.log module:
/!\ this is a massive refactoring and was largely automated, it probably did bring some bugs /!\
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 19 Apr 2014 19:19:19 +0200 |
| parents | f51a1895275c |
| children | 652c01ca69b1 |
| rev | line source |
|---|---|
| 991 | 1 #!/usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SàT: a XMPP client | |
| 5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) | |
| 6 | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 """High level logging functions""" | |
| 21 # XXX: this module use standard logging module when possible, but as SàT can work in different cases where logging is not the best choice (twisted, pyjamas, etc), it is necessary to have a dedicated module. In addition additional feature like environment variable and color are also managed. | |
| 22 | |
| 23 from sat.core.constants import Const as C | |
| 24 from sat.core import exceptions | |
| 25 | |
| 26 _backend = None | |
| 27 _loggers = {} | |
| 28 | |
| 29 | |
| 30 class Logger(object): | |
| 31 """ High level logging class """ | |
| 32 | |
| 33 def __init__(self, name): | |
| 34 self._name = name | |
| 35 | |
| 36 def debug(self, msg): | |
| 37 print msg | |
| 38 | |
| 39 def info(self, msg): | |
| 40 print msg | |
| 41 | |
| 42 def warning(self, msg): | |
| 43 print msg | |
| 44 | |
| 45 def error(self, msg): | |
| 46 print msg | |
| 47 | |
| 48 def critical(self, msg): | |
| 49 print msg | |
| 50 | |
| 51 | |
| 52 def _configureStdLogging(logging, level=None, colors=False, force_colors=False): | |
| 53 """Configure standard logging module | |
| 54 @param logging: standard logging module | |
| 55 @param colors: if True use ANSI colors to show log levels | |
| 56 @param force_colors: if True ANSI colors are used even if stdout is not a tty | |
| 57 """ | |
| 58 FORMAT = '%(message)s' | |
| 59 if level is None: | |
| 60 level = logging.DEBUG | |
| 61 import sys | |
| 62 with_color = colors & (sys.stdout.isatty() or force_colors) | |
| 63 if not colors and force_colors: | |
| 64 raise ValueError("force_colors can't be used if colors is False") | |
| 65 | |
| 66 class SatFormatter(logging.Formatter): | |
| 67 u"""Formatter which manage SàT specificities""" | |
| 68 | |
| 69 def __init__(self, fmt=None, datefmt=None): | |
| 70 super(SatFormatter, self).__init__(fmt, datefmt) | |
| 71 | |
| 72 def format(self, record): | |
| 73 s = super(SatFormatter, self).format(record) | |
| 74 if with_color: | |
| 75 if record.levelno == logging.DEBUG: | |
| 76 fmt = (C.ANSI_FG_CYAN, s, C.ANSI_RESET) | |
| 77 elif record.levelno == logging.WARNING: | |
| 78 fmt = (C.ANSI_FG_YELLOW, s, C.ANSI_RESET) | |
| 79 elif record.levelno == logging.ERROR: | |
| 80 fmt = (C.ANSI_FG_RED, | |
| 81 C.ANSI_BLINK, | |
| 82 r'/!\ ', | |
| 83 C.ANSI_BLINK_OFF, | |
| 84 s, | |
| 85 C.ANSI_RESET) | |
| 86 elif record.levelno == logging.CRITICAL: | |
| 87 fmt = (C.ANSI_BOLD, | |
| 88 C.ANSI_FG_RED, | |
| 89 'Guru Meditation ', | |
| 90 C.ANSI_NORMAL_WEIGHT, | |
| 91 s, | |
| 92 C.ANSI_RESET) | |
| 93 else: | |
| 94 fmt = s | |
| 95 s = ''.join(fmt) | |
| 96 | |
| 97 return s | |
| 98 | |
| 99 root_logger = logging.getLogger() | |
| 100 if len(root_logger.handlers) == 0: | |
| 101 hdlr = logging.StreamHandler() | |
| 102 formatter = SatFormatter(FORMAT) | |
| 103 hdlr.setFormatter(formatter) | |
| 104 root_logger.addHandler(hdlr) | |
| 105 root_logger.setLevel(level) | |
| 106 else: | |
| 107 root_logger.warning(u"Handler already set on root logger") | |
| 108 | |
| 109 def configure(backend=C.LOG_BACKEND_STANDARD): | |
| 110 """Configure logging bejaviour | |
| 111 @param backend: can be: | |
| 112 C.LOG_BACKEND_STANDARD: use standard logging module | |
| 113 C.LOG_BACKEND_TWISTED: use twisted logging module (with standard logging observer) | |
| 114 C.LOG_BACKEND_BASIC: use a basic print based logging | |
| 115 """ | |
| 116 global _backend | |
| 117 if _backend is not None: | |
| 118 raise exceptions.InternalError("Logging can only be configured once") | |
| 119 _backend = backend | |
| 120 | |
|
992
f51a1895275c
core (log): twisted backend use logging methods instead of log.msg
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
121 if backend in (C.LOG_BACKEND_TWISTED, C.LOG_BACKEND_STANDARD): |
|
f51a1895275c
core (log): twisted backend use logging methods instead of log.msg
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
122 if backend == C.LOG_BACKEND_TWISTED: |
|
f51a1895275c
core (log): twisted backend use logging methods instead of log.msg
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
123 from twisted.python import log |
|
f51a1895275c
core (log): twisted backend use logging methods instead of log.msg
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
124 observer = log.PythonLoggingObserver() |
|
f51a1895275c
core (log): twisted backend use logging methods instead of log.msg
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
125 observer.start() |
| 991 | 126 global getLogger |
| 127 global debug | |
| 128 global info | |
| 129 global warning | |
| 130 global error | |
| 131 global critical | |
| 132 import logging | |
| 133 _configureStdLogging(logging, colors=True) | |
| 134 getLogger = logging.getLogger | |
| 135 debug = logging.debug | |
| 136 info = logging.info | |
| 137 warning = logging.warning | |
| 138 error = logging.error | |
| 139 critical = logging.critical | |
| 140 | |
| 141 elif backend == C.LOG_BACKEND_BASIC: | |
| 142 pass | |
| 143 | |
| 144 else: | |
| 145 raise ValueError("unknown backend") | |
| 146 | |
| 147 | |
| 148 def getLogger(name=C.LOG_BASE_LOGGER): | |
| 149 return _loggers.setdefault(name, Logger(name)) | |
| 150 | |
| 151 _root_logger = getLogger() | |
| 152 | |
| 153 def debug(msg): | |
| 154 _root_logger.debug(msg) | |
| 155 | |
| 156 def info(msg): | |
| 157 _root_logger.info(msg) | |
| 158 | |
| 159 def warning(msg): | |
| 160 _root_logger.warning(msg) | |
| 161 | |
| 162 def error(msg): | |
| 163 _root_logger.error(msg) | |
| 164 | |
| 165 def critical(msg): | |
| 166 _root_logger.critical(msg) |