Skip to content

bpo-41197: Async magic methods in contextlib.closing#21285

Closed
uburuntu wants to merge 10 commits into
python:mainfrom
uburuntu:master
Closed

bpo-41197: Async magic methods in contextlib.closing#21285
uburuntu wants to merge 10 commits into
python:mainfrom
uburuntu:master

Conversation

@uburuntu

@uburuntu uburuntu commented Jul 2, 2020 •
edited
Loading

Copy link
Copy Markdown

Async magic methods in contextlib.closing

I was surprised that contextlib has no async analogue of this closing class, because async scripts often use any kind of closings and I think __aenter__ and __aexit__ methods should be added to contextlib.closing, so that we can use contextlib.closing in async code too.

For example:

class SomeAPI:
    ...

    async def request(self):
        pass

    async def aclose(self):
        await self.session.close()
        

async with closing(SomeAPI()) as api:
    response = await api.request()
    print(response)

Also these methods can be moved to another class (like asyncclosing along the lines of asynccontextmanager).

https://bugs.python.org/issue41197

@uburuntu uburuntu requested a review from 1st1 as a code owner July 2, 2020 18:23
@the-knights-who-say-ni

the-knights-who-say-ni commented Jul 2, 2020

Copy link
Copy Markdown

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@uburuntu

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

ZackerySpytz
ZackerySpytz reviewed Aug 8, 2020
View reviewed changes
Comment thread Lib/test/test_contextlib_async.py Outdated
Comment thread Misc/NEWS.d/next/Library/2020-07-02-22-00-21.bpo-41197.zE6sX-.rst Outdated
1st1
1st1 reviewed Aug 11, 2020
View reviewed changes
Comment thread Lib/contextlib.py Outdated
1st1
1st1 requested changes Aug 11, 2020
View reviewed changes

@1st1 1st1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1, but the closing method should be aclose()

@bedevere-bot

bedevere-bot commented Aug 11, 2020

Copy link
Copy Markdown

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@uburuntu

uburuntu commented Aug 11, 2020

Copy link
Copy Markdown
Author

Thanks for the review.

I have made the requested changes; please review again.

@bedevere-bot

bedevere-bot commented Aug 11, 2020

Copy link
Copy Markdown

Thanks for making the requested changes!

@1st1: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from 1st1 August 11, 2020 11:44
@uburuntu uburuntu mentioned this pull request Sep 29, 2021
Merged
@njsmith

njsmith commented Sep 29, 2021

Copy link
Copy Markdown
Contributor

I think this and #21545 accidentally raced with each other to solve the same problem, and #21545 won the race; its aclosing helper will be shipped in 3.10 next week. (Also having a separate aclosing does seem slightly better than overloading closing to call two different methods depending on context, IMO.) So unfortunately there may not be anything left to do with this except, well... closing it. It sucks when this kind of thing happens, but not much to be done :-(

@uburuntu

uburuntu commented Oct 3, 2021

Copy link
Copy Markdown
Author

@njsmith, thanks for the clarification.

It's depressing, but that's okay. Good luck 🚀

@uburuntu uburuntu closed this Oct 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@1st1 1st1 Awaiting requested review from 1st1

1 more reviewer

@ZackerySpytz ZackerySpytz ZackerySpytz left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

awaiting change review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@uburuntu @the-knights-who-say-ni @bedevere-bot @njsmith @1st1 @ZackerySpytz