blob: 758857081c80e13ec772aea668323961478a752b [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é99773352009-09-21 13:41:08 +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:
Tarek Ziadéc7cd1382009-03-31 20:48:31 +000024 if args:
25 msg = msg % args
26 if level in (WARN, ERROR, FATAL):
27 stream = sys.stderr
Georg Brandl1c5a59f2006-04-01 07:46:54 +000028 else:
Tarek Ziadéc7cd1382009-03-31 20:48:31 +000029 stream = sys.stdout
30 stream.write('%s\n' % msg)
31 stream.flush()
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000032
33 def log(self, level, msg, *args):
34 self._log(level, msg, args)
35
36 def debug(self, msg, *args):
37 self._log(DEBUG, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000038
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000039 def info(self, msg, *args):
40 self._log(INFO, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000041
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000042 def warn(self, msg, *args):
43 self._log(WARN, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000044
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000045 def error(self, msg, *args):
46 self._log(ERROR, msg, args)
Tim Peters182b5ac2004-07-18 06:16:08 +000047
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000048 def fatal(self, msg, *args):
49 self._log(FATAL, msg, args)
50
51_global_log = Log()
52log = _global_log.log
53debug = _global_log.debug
54info = _global_log.info
55warn = _global_log.warn
56error = _global_log.error
57fatal = _global_log.fatal
58
59def set_threshold(level):
Fred Drakeedcac8f2004-08-03 18:53:07 +000060 # return the old threshold for use from tests
61 old = _global_log.threshold
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000062 _global_log.threshold = level
Fred Drakeedcac8f2004-08-03 18:53:07 +000063 return old
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000064
65def set_verbosity(v):
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000066 if v <= 0:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000067 set_threshold(WARN)
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000068 elif v == 1:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000069 set_threshold(INFO)
Guido van Rossuma85dbeb2003-02-20 02:09:30 +000070 elif v >= 2:
Jeremy Hylton6fa82a32002-06-04 20:00:26 +000071 set_threshold(DEBUG)