pytest-dev / pytest-dev/pytest
caplog: add convenience caplog.message() method?
Open
Nobody has claimed this yet.
plugin: logging
type: enhancement
- Dominant language
- Python
- Stars
- 14.5k
- Forks
- 3.4k
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 35
Description
After adjusting my test codebase for #3579 I noticed I do this a lot:
assert len(caplog.records) == 1
assert caplog.messages[0] == 'foobar'
With a quick GitHub search it looks like I'm not the only one.
What about adding a caplog.message() convenience method which does the len assertion and returns the only message?
cc @wcooley
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue concerns the caplog fixture, especially caplog.records and caplog.messages; start by locating its implementation and existing caplog tests. Check how singleton-record assertions are currently written, then verify that the proposed convenience method asserts one record and returns its message.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100