Clearer error message if async context manager used synchronously #212
Conversation
Carreau
force-pushed
the
async-async-with
branch
from
f4878c3
to
047c305
Compare
trio/_util.py
Outdated
| @@ -135,6 +136,13 @@ def __init__(self, func, args, kwds): | |||
| if sys.exc_info()[1] is not value: | |||
| raise | |||
|
|
|||
| def __enter__(self): | |||
| raise RuntimeError("The function `{}` create an async context manager, use with `async with` and not `with`.".format(self._func_name)) | |||
There was a problem hiding this comment.
"use 'async with {func_name}(...)', not 'with {func_name}(...)'".format(name=self._func_name)"(and 80 column limit!)
trio/_util.py
Outdated
| def __enter__(self): | ||
| raise RuntimeError("The function `{}` create an async context manager, use with `async with` and not `with`.".format(self._func_name)) | ||
|
|
||
| def __exit__(self): |
|
Hum, also unawaited coroutines. I need to fix the test. |
Carreau
force-pushed
the
async-async-with
branch
from
047c305
to
386b4e5
Compare
Codecov Report
@@ Coverage Diff @@
## master #212 +/- ##
==========================================
+ Coverage 99.01% 99.06% +0.04%
==========================================
Files 59 63 +4
Lines 8012 8407 +395
Branches 569 606 +37
==========================================
+ Hits 7933 8328 +395
Misses 62 62
Partials 17 17
Continue to review full report at Codecov.
|
Otherwise it says it does not have `__enter__` which is obvious for advanced pythonista. Still a tiny bit clearer is likely better. I guess this _might_ fool static type checkers, but I'm unaware of any that would flag that.
Carreau
force-pushed
the
async-async-with
branch
from
386b4e5
to
ab22313
Compare
|
If it does create a problem for static type checkers then it should be fixable by adding an explicit annotation to Something else we might want to think about is coming up with a more standard/comprehensive way of doing this kind of checking, like a decorator we can put on all our context managers and iterators. But that doesn't need to block this; this case is a bit special because we can give a nice error message. |
trio/_util.py
Outdated
| raise RuntimeError("use 'async with {func_name}(...)', not 'with {func_name}(...)'".format(func_name=self._func_name)) | ||
|
|
||
| def __exit__(self): | ||
| assert False, """Never called, but should be defined""" # pragma: no-cover |
There was a problem hiding this comment.
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
trio/_core/tests/test_run.py
Outdated
| with pytest.raises(RuntimeError) as excinfo: | ||
| on = _core.open_nursery() | ||
| with on as nursery: | ||
| pass # pragma: no-cover |
There was a problem hiding this comment.
Also needs an extra space before # and removal of the -
|
Oo, I figured out how to fix the nitpicks through github. Let's see what the CI thinks... |
|
Thanks! |
|
Thanks ! |
Otherwise it says it does not have
__enter__which is obvious foradvanced pythonista. Still a tiny bit clearer is likely better.
I guess this might fool static type checkers, but I'm unaware of any
that would flag that.