Log the arguments when running a task #24
Conversation
r-owen
force-pushed
the
tickets/DM-7844
branch
3 times, most recently
from
696a850
to
69b0fcc
Compare
Modify the argument parser to log the full details of the command. If run from the command line (e.g. with no args from sys.argv) then log the full command line. If run by calling parseAndRun with args specified (e.g. a unit test) then log <class>.parseAndRun(args).
Define a function instead of assigning a lambda Reorder a few imports
r-owen
force-pushed
the
tickets/DM-7844
branch
from
69b0fcc
to
1dfcc2d
Compare
| argumentParser = cls._makeArgumentParser() | ||
| if config is None: | ||
| config = cls.ConfigClass() | ||
| parsedCmd = argumentParser.parse_args(config=config, args=args, log=log, override=cls.applyOverrides) | ||
| # print this message after parsing the command so the log is fully configured | ||
| parsedCmd.log.info("Running: {}".format(commandAsStr)) |
There was a problem hiding this comment.
This is okay but maybe better parsedCmd.log.info("Running: %s", commandAsStr) as log does the % formatting (and only the % formatting at this moment...)
There was a problem hiding this comment.
My understanding is that delayed formatting is useful primarily when a log message may not be displayed. I would expect info and fatal to always be displayed. Still...it ought to be a harmless change and I guess it is good log style.
There was a problem hiding this comment.
Does delayed %s formatting work for objects such as exceptions? Or must one specify a string representation of the object?
There was a problem hiding this comment.
True, practically it only makes some differences in debugging messages.
There was a problem hiding this comment.
It's the same %s formatting, just done after checking the log level.
There was a problem hiding this comment.
A quick test shows that %s does work on arbitrary objects, as does %r. I just pushed a new commit that changes logging to use deferred formatting in all instances I found in pipe_base (which were all in cmdLineTask.py and argumentParser.py)
| if not self.config.compare(oldConfig, shortcut=False, output=output): | ||
|
|
||
| def logConfigMismatch(msg): | ||
| self.log.fatal("Comparing configuration: " + msg) |
There was a problem hiding this comment.
Similarly, maybe delay the formatting to log?
Also log the command if run from the command line