-
Notifications
You must be signed in to change notification settings - Fork 152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add cleanup code to event_loop that mimics the behavior of asyncio.run #309
Open
Askaholic
wants to merge
7
commits into
pytest-dev:main
Choose a base branch
from
Askaholic:event-loop-task-cleanup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8a63a65
Add cleanup code to event_loop that mimics the behavior of asyncio.run
Askaholic effc2e5
Skip cleanup if the loop was closed in the test
Askaholic 046154d
Add test for verifying task cancellation
Askaholic a43a7b5
Move cleanup code to pytest_fixture_post_finalizer
Askaholic b7f1a16
test: Close event_loop in test_event_loop_scope/test_4 to avoid side-…
seifertm 03ee1b1
fix: Yield loop from event_loop fixture to avoid violating function s…
seifertm 5024eb8
refactor: Ignore mypy problem when calling asyncio.runners._cancel_al…
seifertm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
from textwrap import dedent | ||
|
||
|
||
def test_task_canceled_on_test_end(testdir): | ||
seifertm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
testdir.makepyfile( | ||
dedent( | ||
"""\ | ||
import asyncio | ||
import pytest | ||
|
||
pytest_plugins = 'pytest_asyncio' | ||
|
||
@pytest.mark.asyncio | ||
async def test_a(): | ||
loop = asyncio.get_event_loop() | ||
|
||
async def run_forever(): | ||
while True: | ||
await asyncio.sleep(0.1) | ||
|
||
loop.create_task(run_forever()) | ||
""" | ||
) | ||
) | ||
testdir.makefile( | ||
".ini", | ||
pytest=dedent( | ||
"""\ | ||
[pytest] | ||
asyncio_mode = strict | ||
filterwarnings = | ||
error | ||
""" | ||
), | ||
) | ||
result = testdir.runpytest_subprocess() | ||
result.assert_outcomes(passed=1) | ||
result.stderr.no_fnmatch_line("Task was destroyed but it is pending!") |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bunch of people implement their own
event_loop
fixture, in order to control fixture scope. If we change the fixture definition, we'd have to inform them to adjust as well.Asking users to remove
loop.close()
to benefit from the new cleanup code is an easy sell. Adding a call togc.collect
in the event_loop fixture not so much.Is there away around the
gc.collect
call in the fixture code?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose the call to
gc.collect
isn't directly related to task cleanup. I added this in my codebase because there were some tests that opened sockets and never closed them. Having the garbage collector run during the test teardown would make sure that the correct test failed when running pytest with-W error
. But this is unrelated to pytest-asyncio so maybe it doesn't belong here.