blob: 8ef6b28ea2ec097ae6ab5d9ac9b2e0d3fc8f4809 [file] [log] [blame]
Jeremy Hylton6fa82a32002-06-04 20:00:26 +00001"""A simple log mechanism styled after PEP 282."""
2
3# The class here is styled after PEP 282 so that it could later be
4# replaced with a standard Python logging implementation.
5
6DEBUG = 1
7INFO = 2
8WARN = 3
9ERROR = 4
10FATAL = 5
11
Andrew M. Kuchlinge2d12142002-11-04 14:27:43 +000012import sys
13
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000014class Log:
15
16 def __init__(self, threshold=WARN):
17 self.threshold = threshold
18
19 def _log(self, level, msg, args):
Tarek Ziadé31d46072009-09-21 13:55:19 +000020 if level not in (DEBUG, INFO, WARN, ERROR, FATAL):
21 raise ValueError('%s wrong log level' % str(level))
22
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000023 if level >= self.threshold:
Benjamin Petersond23f8222009-04-05 19:13:16 +000024 if args:
25 msg = msg % args
26 if level in (WARN, ERROR, FATAL):
27 stream = sys.stderr
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000028 else:
Benjamin Petersond23f8222009-04-05 19:13:16 +000029 stream = sys.stdout
Julien Malard0afada12018-09-09 02:01:26 +053030 try:
31 stream.write('%s\n' % msg)
32 except UnicodeEncodeError:
Serhiy Storchaka4b860fd2018-09-23 09:12:59 +030033 # emulate backslashreplace error handler
34 encoding = stream.encoding
35 msg = msg.encode(encoding, "backslashreplace").decode(encoding)
36 stream.write('%s\n' % msg)
Benjamin Petersond23f8222009-04-05 19:13:16 +000037 stream.flush()
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000038
39 def log(self, level, msg, *args):
40 self._log(level, msg, args)
41
42 def debug(self, msg, *args):
43 self._log(DEBUG, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000044
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000045 def info(self, msg, *args):
46 self._log(INFO, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000047
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000048 def warn(self, msg, *args):
49 self._log(WARN, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000050
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000051 def error(self, msg, *args):
52 self._log(ERROR, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000053
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000054 def fatal(self, msg, *args):
55 self._log(FATAL, msg, args)
56
57_global_log = Log()
58log = _global_log.log
59debug = _global_log.debug
60info = _global_log.info
61warn = _global_log.warn
62error = _global_log.error
63fatal = _global_log.fatal
64
65def set_threshold(level):
Fred Drakeedcac8f2004-08-03 18:53:07 +000066 # return the old threshold for use from tests
67 old = _global_log.threshold
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000068 _global_log.threshold = level
Fred Drakeedcac8f2004-08-03 18:53:07 +000069 return old
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000070
71def set_verbosity(v):
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000072 if v <= 0:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000073 set_threshold(WARN)
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000074 elif v == 1:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000075 set_threshold(INFO)
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000076 elif v >= 2:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000077 set_threshold(DEBUG)