Capture warnings into log-helper #799
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Encountered an example where a 3rd-party library issued a warning that messed up the json output. Create test to reproduce this.
We set logging.captureWarnings to True and use our logging framework for python's builtin warnings logger. Warnings from that logger will have "type=warning" per default (as opposed to "type=msg").
Warning message includes source file and line number, hope this is not dependent on python version..
Need to make sure that json output is formatted since e.g. warning messages
are created like this:
log.warning('%s', actual_message)
so without proper formatting the message is just "%s".
Also test that exception info is added as usual.
Use a standard logging.Formatter to do %-formatting and other stuff (i.e. the regular formatter job) before converting to Json.
If there is an error in log-handling (e.g. wrong args to logger call) do not fail or raise but produce something helpful
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Warnings can mess-up the output of oletools, a recent example is the Deprecation Warning of cryptography for python2. Human readers have no trouble ignoring these but automated tests or other tools that use oletools in a pipeline, in particular with json-formatted output, get into trouble.
However, python offers a solution, which is logging.captureWarnings. By enabling this, the log-helper can deal with unexpected warnings.