-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
use Contextmanagers to handle StopIteration in generators #12934
Draft
RonnyPfannschmidt
wants to merge
7
commits into
pytest-dev:main
Choose a base branch
from
RonnyPfannschmidt:bug-stopiteration-hook
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.
Draft
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6365848
prepare example test for stopiteration passover issue
RonnyPfannschmidt 195148a
WIP: use contextmanagers instead of yield from
RonnyPfannschmidt 5e974e6
Merge branch 'main' into bug-stopiteration-hook
graingert f4da59b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] cdbb3b5
Merge branch 'main' into bug-stopiteration-hook
graingert 9d71443
add tests for StopIteration processing
graingert 76e3018
Merge branch 'main' into bug-stopiteration-hook
graingert 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
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,10 @@ | ||
from __future__ import annotations | ||
|
||
from typing import Iterator | ||
|
||
import pytest | ||
|
||
|
||
@pytest.hookimpl(wrapper=True) | ||
def pytest_runtest_call() -> Iterator[None]: | ||
yield |
Empty file.
87 changes: 87 additions & 0 deletions
87
testing/example_scripts/hook_exceptions/test_stop_iteration.py
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,87 @@ | ||
""" | ||
test example file exposing mltiple issues with corutine exception passover in case of stopiteration | ||
|
||
the stdlib contextmanager implementation explicitly catches | ||
and reshapes in case a StopIteration was send in and is raised out | ||
""" | ||
|
||
from __future__ import annotations | ||
|
||
from collections.abc import Iterator | ||
from contextlib import contextmanager | ||
|
||
import pluggy | ||
|
||
|
||
def test_stop() -> None: | ||
raise StopIteration() | ||
|
||
|
||
hookspec = pluggy.HookspecMarker("myproject") | ||
hookimpl = pluggy.HookimplMarker("myproject") | ||
|
||
|
||
class MySpec: | ||
"""A hook specification namespace.""" | ||
|
||
@hookspec | ||
def myhook(self, arg1: int, arg2: int) -> int: # type: ignore[empty-body] | ||
"""My special little hook that you can customize.""" | ||
|
||
|
||
class Plugin_1: | ||
"""A hook implementation namespace.""" | ||
|
||
@hookimpl | ||
def myhook(self, arg1: int, arg2: int) -> int: | ||
print("inside Plugin_1.myhook()") | ||
raise StopIteration() | ||
|
||
|
||
class Plugin_2: | ||
"""A 2nd hook implementation namespace.""" | ||
|
||
@hookimpl(wrapper=True) | ||
def myhook(self) -> Iterator[None]: | ||
return (yield) | ||
|
||
|
||
def try_pluggy() -> None: | ||
# create a manager and add the spec | ||
pm = pluggy.PluginManager("myproject") | ||
pm.add_hookspecs(MySpec) | ||
|
||
# register plugins | ||
pm.register(Plugin_1()) | ||
pm.register(Plugin_2()) | ||
|
||
# call our ``myhook`` hook | ||
results = pm.hook.myhook(arg1=1, arg2=2) | ||
print(results) | ||
|
||
|
||
@contextmanager | ||
def my_cm() -> Iterator[None]: | ||
try: | ||
yield | ||
except Exception as e: | ||
print(e) | ||
raise StopIteration() | ||
|
||
|
||
def inner() -> None: | ||
with my_cm(): | ||
raise StopIteration() | ||
|
||
|
||
def try_context() -> None: | ||
inner() | ||
|
||
|
||
mains = {"pluggy": try_pluggy, "context": try_context} | ||
|
||
if __name__ == "__main__": | ||
import sys | ||
|
||
if len(sys.argv) == 2: | ||
mains[sys.argv[1]]() |
Oops, something went wrong.
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.