gh-109350: Fix outdated captured output in unittest.mock documentation #109353
Conversation
This file contains hidden or 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
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
awaiting review
docs
ragulpr
force-pushed
the
unittest-mock-docs
branch
from
cee4fb3 to
03cbebf
Compare
ragulpr
commented
Sep 12, 2023
Doc/library/unittest.mock.rst
Outdated
Comment on lines
959
to
962
| >>> mock.method.assert_awaited_once() | ||
| Traceback (most recent call last): | ||
| ... | ||
| AssertionError: Expected mock to have been awaited once. Awaited 2 times. | ||
| AssertionError: Expected method to have been awaited once. Awaited 0 times. |
Contributor
Author
There was a problem hiding this comment.
This is the actual but likely not the intended output, if called with mock.assert_awaited_once() rather than mock.method.assert_awaited_once() it yields the output that was documented. Should I change it immediately or spawn separate issue?
cjw296
approved these changes
Sep 15, 2023
Contributor
cjw296
left a comment
cjw296
left a comment
There was a problem hiding this comment.
Fantastic, thanks for this!
Doc/library/unittest.mock.rst
Outdated
Comment on lines
959
to
962
| >>> mock.method.assert_awaited_once() | ||
| Traceback (most recent call last): | ||
| ... | ||
| AssertionError: Expected mock to have been awaited once. Awaited 2 times. | ||
| AssertionError: Expected method to have been awaited once. Awaited 0 times. |
Run with
```
import asyncio
import unittest
from unittest.mock import Mock, MagicMock, AsyncMock, patch, call, sentinel
mock = AsyncMock()
async def main():
await mock()
asyncio.run(main())
mock.assert_awaited_once()
asyncio.run(main())
mock.assert_awaited_once()
```
Contributor
Author
|
Done! It's not much but it's something 😁 EDIT: Not my fault builds are failing |
cjw296
approved these changes
Sep 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #109350
Updates the captured output/exceptions that are not reflecting the current (more readable) exceptions (Doc/library/unittest.mock.rst, Doc/library/unittest.mock-examples.rst) .
I ran this @ Python 3.13.0a0, I'm sure it can be backported far back but I'm not up to the task right now.
📚 Documentation preview 📚: https://cpython-previews--109353.org.readthedocs.build/