bpo-29302: Implement contextlib.AsyncExitStack.#4790
Conversation
4374de3 to
60000cd
Compare
December 11, 2017 23:17
|
@1st1 I'd like to take a further look at this one before we merge it, but
won't have time until Jan 6th or so (just before the final alpha). Does
that timeline work for you?
|
Sorry, something went wrong.
|
The alternative plan would be to merge this version based on the existing
reviews, and if I have any subsequent changes I want to make, I can do that
any time before the first beta. That's probably a better approach, since
it's more resilient against my being otherwise occupied in the first week
of January.
|
Sorry, something went wrong.
Sure, I think this is worth another look so let's wait. Let's just make sure we don't forget about this before the feature freeze. |
Sorry, something went wrong.
ncoghlan
left a comment
There was a problem hiding this comment.
I like the patch overall, but there's one design concern I have, as well as a backwards compatibility concern:
- for the backwards compatibility issue: calls using keyword arguments mean we can't arbitrarily change parameter names in public APIs
- for the design question, implicitly supporting synchronous context managers in the asynchronous exit stack seems questionable to me.
The design question is one @1st1 and I talked about on the issue tracker (see https://bugs.python.org/issue29302#msg288735 and the next couple of comments), and after seeing the code in PR form, I definitely want to go with the more explicit API:
- add separate
*_syncvariants of all the callback registration APIs in the async exit stack variant rather than trying to guess the user's intent based on the type of the object they passed in (if guessing proves desirable, we can add it later, but if we start with it, we're likely stuck with it even if it proves confusing) - avoid checking for awaitables when unwinding the stack in the async case (either add an awaitable wrapper to the synchronous callbacks as I suggest in this review, or else store a 2-tuple as @1st1 suggested on the tracker)
Sorry, something went wrong.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Sorry, something went wrong.
|
Couple of thoughts:
with Foo:
async with Bar:
with Ham:
...
|
Sorry, something went wrong.
|
Also, we need to get this merged before Jan 29. @Kentzo if you don't have time to work on this in the next few days I can handle this PR myself. |
Sorry, something went wrong.
|
@1st1 So the differences between AsyncExitStack and ExitStack would be:
I like that, since it means registering synchronous context managers and callbacks stays the same regardless of which kind of stack you're using. A note regarding the method names: the synchronous method names are just |
Sorry, something went wrong.
Right.
Yeah, the API consistency for synchronous CMs is great. To be honest I haven't thought about it until you highlighted it, but now I see it as a requirement!
+1. |
Sorry, something went wrong.
|
Please name the close method Regarding the bikeshed, I think my preference FWIW is to make both sync and async explicitly marked, so it's e.g. |
Sorry, something went wrong.
|
@njsmith following this way we should add |
Sorry, something went wrong.
|
The semantics around closing things are much more general and subtle than
sending/receiving. Obviously send/recv are inherently semantically blocking
operations, but close() is non-blocking on a regular socket and blocking on
an SSL socket. Plus in general there are just a lot more kinds of things
that get closed so it's useful to have general cross-type conventions here.
You can't use contextlib.closing with an object whose close is async (or
rather, you can if it calls the method 'close', and it will claim to
succeed without doing anything!). You *can* use async_generator.aclosing on
any object with an async close, but it assumes that the method is called
aclose(), because it's not specific to async generators but that is one of
the original use cases. In some cases you might want to provide both a
synchronous close() and an async aclose() on the same object, e.g. if the
object's native close semantics are synchronous, but the way it's used also
needs to match some generic ABC. (Probably it's *better* it you can handle
this via composition – in trio, trio.socket.socket has a synchronous
close() while trio.SocketStream and trio.SocketListener have async aclose()
methods – but sometimes stuff happens.) So personally at least I find it
very useful to have a conventional protocol for async close that doesn't
overlap with the existing convention for sync close.
…On Jan 20, 2018 04:42, "Andrew Svetlov" ***@***.***> wrote:
@njsmith <https://github.com/njsmith> following this way we should add a
prefix to all async functions everywhere: aclose(), asend(), arecv() etc.
The logic is weird, isn't it? I don't see how context manager is related
to generator.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#4790 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAlOaDSFF_kyr6I6me86pr7c6e5W8fUjks5tMd8zgaJpZM4Q85Ru>
.
|
Sorry, something went wrong.
|
@njsmith Good point regarding close() vs aclose() - I'd forgotten that part of PEP 525. Given that, I agree the method on AsyncExitStack should aclose(), and the synchronous close API should just be missing entirely (as with the other synchronous context management methods). I'm not especially worried about folks having to sprinkle extra "async" mentions through their code to get async context managers to work as expected - that's the default language wide. For example, even though you've written By contrast, I'm definitely not keen on having the correctness of code like This does mean that |
Sorry, something went wrong.
|
I agree with everything Nick said here. |
Sorry, something went wrong.
|
👍 |
Sorry, something went wrong.
|
The Appveyor failures look unrelated to me - closing & reopening to check if they're transient errors. |
Sorry, something went wrong.
|
I'll take a look today/tomorrow, thanks Nick! |
Sorry, something went wrong.
|
@ncoghlan What do you think about adding |
Sorry, something went wrong.
|
@Kentzo Worth considering as a separate issue for 3.8, but I wouldn't rush into it for 3.7. |
Sorry, something went wrong.
1st1
left a comment
There was a problem hiding this comment.
There're multiple formatting issues with the PR. Please fix the code to follow PEP 8. Reformat docstrings to have a short first line ended with a period, optionally followed by an empty line with more paragraphs.
Most importantly, I don't like the design of _shutdown_loop. I think we shouldn't use generator.send/throw here, I'd prefer to copy/paste the code which will make the code easier to read and maintain (generators are complicated!)
/cc @ncoghlan
Sorry, something went wrong.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Sorry, something went wrong.
|
I have made the requested changes; please review again |
Sorry, something went wrong.
|
Merged. Thanks so much Ilya! |
Sorry, something went wrong.
This change is entirely based on the work of @thehesiod discussed at https://bugs.python.org/issue29302
I only changed implementation of
__aexit__:to:
and added tests.
https://bugs.python.org/issue29302