libervia-backend: src/core/log.py annotate

annotate src/core/log.py @ 2354:5129a0506739

jp (shell): fixed use of profile + added EOF handling: - main profile (i.e. the one specified on command line when invocating "jp shell") was not used. It is now added to arguments if the value is not overriden on command line or in use - EOF (i.e. when user press C-d) is now understood as "quit" command

author	Goffi <goffi@goffi.org>
date	Fri, 08 Sep 2017 07:58:10 +0200
parents	7cbffd754b4a
children	8b37a62336c3

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1766 diff changeset	1 #!/usr/bin/env python2
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	3
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	4 # SàT: a XMPP client
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1396 diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	6
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	11
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	16
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	19
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	20 """High level logging functions"""
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	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. Additional feature like environment variables and colors are also managed.
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	22 # TODO: change formatting from "%s" style to "{}" when moved to Python 3
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	23
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	24 from sat.core.constants import Const as C
2154 7cbffd754b4a core (constants), tools (common/ansi): moved ANSI escape codes to a dedicated class, with helper methods Goffi <goffi@goffi.org> parents: 1942 diff changeset	25 from sat.tools.common.ansi import ANSI as A
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	26 from sat.core import exceptions
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	27
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	28 backend = None
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	29 _loggers = {}
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	30 handlers = {}
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	31 COLOR_START = '%(color_start)s'
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	32 COLOR_END = '%(color_end)s'
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	33
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	34
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	35 class Filtered(Exception):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	36 pass
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	37
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	38
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	39 class Logger(object):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	40 """High level logging class"""
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	41 fmt = None # format option as given by user (e.g. SAT_LOG_LOGGER)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	42 filter_name = None # filter to call
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	43 post_treat = None
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	44
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	45 def __init__(self, name):
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	46 if isinstance(name, Logger):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	47 self.copy(name)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	48 else:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	49 self._name = name
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	50
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	51 def copy(self, other):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	52 """Copy values from other Logger"""
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	53 self.fmt = other.fmt
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	54 self.Filter_name = other.fmt
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	55 self.post_treat = other.post_treat
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	56 self._name = other._name
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	57
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	58 def out(self, message, level=None):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	59 """Actually log the message
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	60
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	61 @param message: formatted message
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	62 """
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	63 print message
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	64
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	65 def log(self, level, message):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	66 """Print message
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	67
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	68 @param level: one of C.LOG_LEVELS
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	69 @param message: message to format and print
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	70 """
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	71 try:
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	72 formatted = self.format(level, message)
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	73 if self.post_treat is None:
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	74 self.out(formatted, level)
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	75 else:
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	76 self.out(self.post_treat(level, formatted), level)
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	77 except Filtered:
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	78 pass
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	79
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	80 def format(self, level, message):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	81 """Format message according to Logger.fmt
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	82
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	83 @param level: one of C.LOG_LEVELS
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	84 @param message: message to format
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	85 @return: formatted message
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	86
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	87 @raise: Filtered when the message must not be logged
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	88 """
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	89 if self.fmt is None and self.filter_name is None:
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	90 return message
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	91 record = {'name': self._name,
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	92 'message': message,
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	93 'levelname': level,
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	94 }
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	95 try:
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	96 if not self.filter_name.dictFilter(record):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	97 raise Filtered
1016 0c361fdc76af core (logs): workaround for pyjamas bug Goffi <goffi@goffi.org> parents: 1013 diff changeset	98 except (AttributeError, TypeError): # XXX: TypeError is here because of a pyjamas bug which need to be fixed (TypeError is raised instead of AttributeError)
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	99 if self.filter_name is not None:
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	100 raise ValueError("Bad filter: filters must have a .filter method")
1008 d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	101 try:
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	102 return self.fmt % record
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	103 except TypeError:
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	104 return message
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	105 except KeyError as e:
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	106 if e.args[0] == 'profile':
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	107 # XXX: %(profile)s use some magic with introspection, for debugging purpose only DO NOT use in production
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	108 record['profile'] = configure_cls[backend].getProfile()
1008 d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	109 return self.fmt % record
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	110 else:
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	111 raise e
d70d4fe5c5f8 core (log): added magic %(profile)s key to log_fmt: Goffi <goffi@goffi.org> parents: 1007 diff changeset	112
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	113 def debug(self, msg):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	114 self.log(C.LOG_LVL_DEBUG, msg)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	115
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	116 def info(self, msg):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	117 self.log(C.LOG_LVL_INFO, msg)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	118
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	119 def warning(self, msg):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	120 self.log(C.LOG_LVL_WARNING, msg)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	121
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	122 def error(self, msg):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	123 self.log(C.LOG_LVL_ERROR, msg)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	124
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	125 def critical(self, msg):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	126 self.log(C.LOG_LVL_CRITICAL, msg)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	127
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	128
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	129 class FilterName(object):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	130 """Filter on logger name according to a regex"""
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	131
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	132 def __init__(self, name_re):
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	133 """Initialise name filter
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	134
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	135 @param name_re: regular expression used to filter names (using search and not match)
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	136 """
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	137 assert name_re
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	138 import re
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	139 self.name_re = re.compile(name_re)
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	140
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	141 def filter(self, record):
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	142 if self.name_re.search(record.name) is not None:
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	143 return 1
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	144 return 0
b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	145
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	146 def dictFilter(self, dict_record):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	147 """Filter using a dictionary record
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	148
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	149 @param dict_record: dictionary with at list a key "name" with logger name
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	150 @return: True if message should be logged
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	151 """
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	152 class LogRecord(object):
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	153 pass
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	154 log_record = LogRecord()
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	155 log_record.name = dict_record['name']
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	156 return self.filter(log_record) == 1
325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	157
1010 73a0b7f94674 primitivus: use of new logging system: Goffi <goffi@goffi.org> parents: 1008 diff changeset	158
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	159 class ConfigureBase(object):
1017 0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	160 LOGGER_CLASS = Logger
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	161 _color_location = False # True if color location is specified in fmt (with COLOR_START)
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	162
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	163 def __init__(self, level=None, fmt=None, output=None, logger=None, colors=False, levels_taints_dict=None, force_colors=False, backend_data=None):
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	164 """Configure a backend
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	165
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	166 @param level: one of C.LOG_LEVELS
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	167 @param fmt: format string, pretty much as in std logging. Accept the following keywords (maybe more depending on backend):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	168 - "message"
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	169 - "levelname"
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	170 - "name" (logger name)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	171 @param logger: if set, use it as a regular expression to filter on logger name.
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	172 Use search to match expression, so ^ or $ can be necessary.
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	173 @param colors: if True use ANSI colors to show log levels
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	174 @param force_colors: if True ANSI colors are used even if stdout is not a tty
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	175 """
1129 08f50fdac21b core (logging): new backend_data parameter can be used to transmit specific data to a backend + Twisted backend use this option to know if we are in debug or nodaemon mode Goffi <goffi@goffi.org> parents: 1021 diff changeset	176 self.backend_data = backend_data
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	177 self.preTreatment()
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	178 self.configureLevel(level)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	179 self.configureFormat(fmt)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	180 self.configureOutput(output)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	181 self.configureLogger(logger)
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	182 self.configureColors(colors, force_colors, levels_taints_dict)
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	183 self.postTreatment()
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	184 self.updateCurrentLogger()
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	185
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	186 def updateCurrentLogger(self):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	187 """update existing logger to the class needed for this backend"""
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	188 if self.LOGGER_CLASS is None:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	189 return
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	190 for name, logger in _loggers.items():
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	191 _loggers[name] = self.LOGGER_CLASS(logger)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	192
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	193 def preTreatment(self):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	194 pass
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	195
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	196 def configureLevel(self, level):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	197 if level is not None:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	198 # we deactivate methods below level
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	199 level_idx = C.LOG_LEVELS.index(level)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	200 def dev_null(self, msg):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	201 pass
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	202 for _level in C.LOG_LEVELS[:level_idx]:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	203 setattr(Logger, _level.lower(), dev_null)
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	204
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	205 def configureFormat(self, fmt):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	206 if fmt is not None:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	207 if fmt != '%(message)s': # %(message)s is the same as None
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	208 Logger.fmt = fmt
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	209 if COLOR_START in fmt:
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	210 ConfigureBase._color_location = True
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	211 if fmt.find(COLOR_END,fmt.rfind(COLOR_START))<0:
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	212 # color_start not followed by an end, we add it
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	213 Logger.fmt += COLOR_END
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	214
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	215 def configureOutput(self, output):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	216 if output is not None:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	217 if output != C.LOG_OPT_OUTPUT_SEP + C.LOG_OPT_OUTPUT_DEFAULT:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	218 # TODO: manage other outputs
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	219 raise NotImplementedError("Basic backend only manage default output yet")
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	220
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	221 def configureLogger(self, logger):
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	222 if logger:
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	223 Logger.filter_name = FilterName(logger)
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	224
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	225 def configureColors(self, colors, force_colors, levels_taints_dict):
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	226 if colors:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	227 # if color are used, we need to handle levels_taints_dict
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	228 for level in levels_taints_dict.keys():
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	229 # we wants levels in uppercase to correspond to contstants
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	230 levels_taints_dict[level.upper()] = levels_taints_dict[level]
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	231 taints = self.__class__.taints = {}
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	232 for level in C.LOG_LEVELS:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	233 # we want use values and use constant value as default
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	234 taint_list = levels_taints_dict.get(level, C.LOG_OPT_TAINTS_DICT[1][level])
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	235 ansi_list = []
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	236 for elt in taint_list:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	237 elt = elt.upper()
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	238 try:
2154 7cbffd754b4a core (constants), tools (common/ansi): moved ANSI escape codes to a dedicated class, with helper methods Goffi <goffi@goffi.org> parents: 1942 diff changeset	239 ansi = getattr(A, 'FG_{}'.format(elt))
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	240 except AttributeError:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	241 try:
2154 7cbffd754b4a core (constants), tools (common/ansi): moved ANSI escape codes to a dedicated class, with helper methods Goffi <goffi@goffi.org> parents: 1942 diff changeset	242 ansi = getattr(A, elt)
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	243 except AttributeError:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	244 # we use raw string if element is unknown
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	245 ansi = elt
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	246 ansi_list.append(ansi)
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	247 taints[level] = ''.join(ansi_list)
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	248
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	249 def postTreatment(self):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	250 pass
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	251
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	252 def manageOutputs(self, outputs_raw):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	253 """ Parse output option in a backend agnostic way, and fill handlers consequently
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	254
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	255 @param outputs_raw: output option as enterred in environment variable or in configuration
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	256 """
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	257 if not outputs_raw:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	258 return
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	259 outputs = outputs_raw.split(C.LOG_OPT_OUTPUT_SEP)
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	260 global handlers
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	261 if len(outputs) == 1:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	262 handlers[C.LOG_OPT_OUTPUT_FILE] = [outputs.pop()]
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	263
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	264 for output in outputs:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	265 if not output:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	266 continue
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	267 if output[-1] == ')':
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	268 # we have options
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	269 opt_begin = output.rfind('(')
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	270 options = output[opt_begin+1:-1]
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	271 output = output[:opt_begin]
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	272 else:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	273 options = None
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	274
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	275 if output not in (C.LOG_OPT_OUTPUT_DEFAULT, C.LOG_OPT_OUTPUT_FILE, C.LOG_OPT_OUTPUT_MEMORY):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	276 raise ValueError(u"Invalid output [%s]" % output)
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	277
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	278 if output == C.LOG_OPT_OUTPUT_DEFAULT:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	279 # no option for defaut handler
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	280 handlers[output] = None
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	281 elif output == C.LOG_OPT_OUTPUT_FILE:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	282 if not options:
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	283 ValueError("{handler} output need a path as option" .format(handle=output))
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	284 handlers.setdefault(output, []).append(options)
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	285 options = None # option are parsed, we can empty them
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	286 elif output == C.LOG_OPT_OUTPUT_MEMORY:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	287 # we have memory handler, option can be the len limit or None
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	288 try:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	289 limit = int(options)
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	290 options = None # option are parsed, we can empty them
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	291 except (TypeError, ValueError):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	292 limit = C.LOG_OPT_OUTPUT_MEMORY_LIMIT
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	293 handlers[output] = limit
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	294
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	295 if options: # we should not have unparsed options
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	296 raise ValueError(u"options [{options}] are not supported for {handler} output".format(options=options, handler=output))
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	297
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	298 @staticmethod
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	299 def memoryGet(size=None):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	300 """Return buffered logs
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	301
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	302 @param size: number of logs to return
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	303 """
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	304 raise NotImplementedError
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	305
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	306 @classmethod
3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	307 def ansiColors(cls, level, message):
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	308 """Colorise message depending on level for terminals
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	309
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	310 @param level: one of C.LOG_LEVELS
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	311 @param message: formatted message to log
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	312 @return: message with ANSI escape codes for coloration
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	313 """
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	314
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	315 try:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	316 start = cls.taints[level]
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	317 except KeyError:
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	318 start = ''
7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	319
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	320 if cls._color_location:
1942 7f053e1f0b67 core (logs): taints: Goffi <goffi@goffi.org> parents: 1940 diff changeset	321 return message % {'color_start': start,
2154 7cbffd754b4a core (constants), tools (common/ansi): moved ANSI escape codes to a dedicated class, with helper methods Goffi <goffi@goffi.org> parents: 1942 diff changeset	322 'color_end': A.RESET}
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	323 else:
2154 7cbffd754b4a core (constants), tools (common/ansi): moved ANSI escape codes to a dedicated class, with helper methods Goffi <goffi@goffi.org> parents: 1942 diff changeset	324 return '%s%s%s' % (start, message, A.RESET)
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	325
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	326 @staticmethod
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	327 def getProfile():
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	328 """Try to find profile value using introspection"""
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	329 raise NotImplementedError
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	330
a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	331
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	332 class ConfigureCustom(ConfigureBase):
1017 0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	333 LOGGER_CLASS = None
0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	334
0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	335 def __init__(self, logger_class, args, *kwargs):
0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	336 ConfigureCustom.LOGGER_CLASS = logger_class
0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	337
0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	338
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	339 configure_cls = { None: ConfigureBase,
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	340 C.LOG_BACKEND_CUSTOM: ConfigureCustom
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	341 } # XXX: (key: backend, value: Configure subclass) must be filled when new backend are added
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	342
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	343
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	344 def configure(backend_, **options):
1006 325fd230c15d core (log): added advanced feature to basic backend (colors/formatting/level and logger filtering) Goffi <goffi@goffi.org> parents: 1005 diff changeset	345 """Configure logging behaviour
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	346 @param backend: can be:
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	347 C.LOG_BACKEND_BASIC: use a basic print based logging
1017 0ea97f483464 core (log): added "custom" backend Goffi <goffi@goffi.org> parents: 1016 diff changeset	348 C.LOG_BACKEND_CUSTOM: use a given Logger subclass
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	349 """
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	350 global backend
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	351 if backend is not None:
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	352 raise exceptions.InternalError("Logging can only be configured once")
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	353 backend = backend_
1005 b4af31a8a4f2 core (logs): added formatting, name filter and outputs management: Goffi <goffi@goffi.org> parents: 994 diff changeset	354
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	355 try:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	356 configure_class = configure_cls[backend]
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	357 except KeyError:
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	358 raise ValueError("unknown backend [{}]".format(backend))
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	359 if backend == C.LOG_BACKEND_CUSTOM:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	360 logger_class = options.pop('logger_class')
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	361 configure_class(logger_class, **options)
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	362 else:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	363 configure_class(**options)
994 652c01ca69b1 core (log): configuration and environment variables are now checked for log level and colors: Goffi <goffi@goffi.org> parents: 992 diff changeset	364
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	365 def memoryGet(size=None):
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	366 if not C.LOG_OPT_OUTPUT_MEMORY in handlers:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	367 raise ValueError('memory output is not used')
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	368 return configure_cls[backend].memoryGet(size)
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	369
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	370 def getLogger(name=C.LOG_BASE_LOGGER):
1021 a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	371 try:
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	372 logger_class = configure_cls[backend].LOGGER_CLASS
a836b6da2c5c core (log): moved configuration to core.log_config; this avoid import issues with pyjamas. Goffi <goffi@goffi.org> parents: 1017 diff changeset	373 except KeyError:
1940 3fdacba9da68 core (logs): log color location can now be specified with %(color_start)s and %(color_end)s Goffi <goffi@goffi.org> parents: 1934 diff changeset	374 raise ValueError("This method should not be called with backend [{}]".format(backend))
1007 a7d33c7a8277 core (log): refactoring + twisted backend: Goffi <goffi@goffi.org> parents: 1006 diff changeset	375 return _loggers.setdefault(name, logger_class(name))
991 05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	376
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	377 _root_logger = getLogger()
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	378
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	379 def debug(msg):
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	380 _root_logger.debug(msg)
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	381
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	382 def info(msg):
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	383 _root_logger.info(msg)
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	384
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	385 def warning(msg):
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	386 _root_logger.warning(msg)
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	387
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	388 def error(msg):
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	389 _root_logger.error(msg)
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	390
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	391 def critical(msg):
05e02f8b7eb4 core: logging refactoring, first step: Goffi <goffi@goffi.org> parents: diff changeset	392 _root_logger.critical(msg)

Mercurial > libervia-backend

annotate src/core/log.py @ 2354:5129a0506739