Skip to content
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

Clearer error message if async context manager used synchronously #212

Merged
merged 3 commits into from
Jun 15, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions trio/_core/tests/test_run.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@ async def child(x):
await task.wait()
assert task.result.unwrap() == 20

async def test_nursery_warn_use_async_with():
with pytest.raises(RuntimeError) as excinfo:
on = _core.open_nursery()
with on as nursery:
pass # pragma: no-cover
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also needs an extra space before # and removal of the -

excinfo.match(r"use 'async with open_nursery\(...\)', not 'with open_nursery\(...\)'")

# avoid unawaited coro.
async with on:
pass

async def test_child_crash_basic():
exc = ValueError("uh oh")
Expand Down
8 changes: 8 additions & 0 deletions trio/_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ async def __aiter__(*args, **kwargs):
# Copyright © 2001-2017 Python Software Foundation; All Rights Reserved
class _AsyncGeneratorContextManager:
def __init__(self, func, args, kwds):
self._func_name = func.__name__
self._agen = func(*args, **kwds).__aiter__()

async def __aenter__(self):
Expand Down Expand Up @@ -135,6 +136,13 @@ async def __aexit__(self, type, value, traceback):
if sys.exc_info()[1] is not value:
raise

def __enter__(self):
raise RuntimeError("use 'async with {func_name}(...)', not 'with {func_name}(...)'".format(func_name=self._func_name))

def __exit__(self):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# pragma: no-cover

assert False, """Never called, but should be defined""" # pragma: no-cover
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be no cover, not no-cover; it's not actually being recognized right now :-). Also better to put two spaces before the #, and to move it up one line, so:

def __exit__(self):  # pragma: no cover



def acontextmanager(func):
"""Like @contextmanager, but async."""
if not async_generator.isasyncgenfunction(func):
Expand Down