python / cpython

Sponsor

Sponsor python/cpython
Notifications
Star 36.8k
Fork 18.2k

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

Jump to bottom

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

Open

uburuntu wants to merge 9 commits into python:master from uburuntu:master

+56 −2

uburuntu commented Jul 2, 2020 •

edited

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 added 3 commits


          enh: handle asynchronous case for contextlib.closing

9905b54


          new: add test for async `closing` (1)

b826fed


          new: add test for async `closing` (2)

9351f92

uburuntu requested a review from 1st1 as a code owner

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

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:

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!

the-knights-who-say-ni added the CLA not signed label

bedevere-bot added the awaiting review label

uburuntu added 2 commits


          enh: add async ctx manager base class

72987db


          new: add blurb news

0386c5a

the-knights-who-say-ni added CLA signed and removed CLA not signed labels

ZackerySpytz reviewed

Lib/test/test_contextlib_async.py Outdated Show resolved Hide resolved

Misc/NEWS.d/next/Library/2020-07-02-22-00-21.bpo-41197.zE6sX-.rst Outdated Show resolved Hide resolved

1st1 reviewed

Lib/contextlib.py Outdated Show resolved Hide resolved

1st1 requested changes

Member

1st1 left a comment

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

bedevere-bot added awaiting changes and removed awaiting review labels

bedevere-bot commented Aug 11, 2020

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 added 4 commits


          fix: use double backquotes around __aenter__ and __aexit__

fb3bd5b


          ref: limit line to 79 chars

ae1b887


          enh: change close to aclose for async case

632a3eb


          ref: add blank lines between methods

c0f1b62

Author

uburuntu commented Aug 11, 2020

Thanks for the review.

I have made the requested changes; please review again.

bedevere-bot added awaiting change review and removed awaiting changes labels

bedevere-bot commented Aug 11, 2020

Thanks for making the requested changes!

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

bedevere-bot requested a review from 1st1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment