Dedicated caplog recording handler #24
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
This was referenced Nov 20, 2015
Merged
abusalimov
force-pushed
the
caplog-rec-handler
branch
from
29db8e6
to
5aabdae
Compare
abusalimov
force-pushed
the
caplog-rec-handler
branch
from
5aabdae
to
e51ddfd
Compare
This makes a distinction between two features / use cases:
1. Inspection: record and check logs emitted by the code being tested
using the `caplog` fixture
2. Reporting: show all logs in case of a failure
Implemented through adding a dedicated log handler for the recording.
As a bonus, simplifies the capturing logic (no more awkward
item.catch_log_handler).
Also move LogCaptureHandler into fixture.py.
We don't need a list of records provided by CatchLogHandler for the reporting facility. So, storing of the records is now only performed for the `caplog` fixture inspecting purposes. Also rename 'CatchLogHandler' to 'RecordingHandler', which in turn, is also turned into a new-style class that uses super() where appropriate.
In case when a log record has mutable objects attached as arguments, the getMessage() method may return different results each time it is called. Instead, use the 'message' field initialized by a formatter upon a record reaches a handler.
abusalimov
force-pushed
the
caplog-rec-handler
branch
from
e51ddfd
to
293058d
Compare
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.
Changes affecting users:
caplog.textalways uses the same formatting, regardless the--log-formatoption. You won't want your tests fail because the user prefers another formatting, after allcaplogdoes not affect captured logs shown in case of a failure (this is still not the case when usingcaplog.at_level/set_level(logger=...)though, but I'm going to address this one too in future)Note: This contains changes that you might happen to review as part of #7, I decided to drop these changes from there eventually.