Write all log output to stderr (do not pollute stdout) #1337
Conversation
* Affects logger.info and logger.debug * complies now to the behavior of pythons's standard logging package
| for line in tools.wrapLine(msg): | ||
| syslog.syslog(syslog.LOG_INFO, 'INFO: ' + line) | ||
|
|
||
| def debug(msg, parent = None, traceDepth = 0): | ||
| if DEBUG: | ||
| msg = '%s %s' %(_debugHeader(parent, traceDepth), msg) | ||
| print('%sDEBUG%s: %s' %(bcolors.OKBLUE, bcolors.ENDC, msg), file = sys.stdout) | ||
| # Why does this code differ from eg. "error()" |
There was a problem hiding this comment.
In error() an error message is written to syslog no matter if debug mode is on or not. But if DEBUG then debug infos are added to the error messgae.
In debug() there is no need to add debug infos to the message because the message itself is of type DEBUG.
There was a problem hiding this comment.
What is irritating to me is that DEBUG is not a severity threshold for logging but a flag to inject additional call stack information ("_debugHeader") but for a single severity level debug() it is also a threshold.
I do not know any logging framework that works like that (and don't understand why this makes sense).
Perhaps the idea was to work like -v vs. -vv verbosity switches (the more "v"s the chattier is the output ;-)
There was a problem hiding this comment.
Maybe we misunderstand here each other? e.g. in Python's own logging package logging.DEBUG is a threshold.
But you are deeper in that part of the code. It was just a quick and dirty night shift thought. 😄
| @@ -55,14 +55,16 @@ def warning(msg , parent = None, traceDepth = 0): | |||
| def info(msg , parent = None, traceDepth = 0): | |||
| if DEBUG: | |||
| msg = '%s %s' %(_debugHeader(parent, traceDepth), msg) | |||
| print('%sINFO%s: %s' %(bcolors.OKGREEN, bcolors.ENDC, msg), file=sys.stdout) | |||
| print('%sINFO%s: %s' %(bcolors.OKGREEN, bcolors.ENDC, msg), file=sys.stderr) | |||
| for line in tools.wrapLine(msg): | |||
| syslog.syslog(syslog.LOG_INFO, 'INFO: ' + line) | |||
|
|
|||
| def debug(msg, parent = None, traceDepth = 0): | |||
| if DEBUG: | |||
There was a problem hiding this comment.
I would revert that if.
def debug()
if not DEBUG:
return
In that case you can save the indention of the following lines.
Clearer code IMHO.
There was a problem hiding this comment.
Ah, I see. Yes, would be possible, but why change existing code that works ;-)
Background
Our logging system pollutes the normal (non-logging) stdout output with logging output, we need a clear separation here
(eg. logging to stderr instead of stdout) otherwise we can never separate normal from (partially random) logging output in unit tests.
Standard python's logger package says:
https://docs.python.org/3/howto/logging.html