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

GH-79033: docs: Minor improvement to asyncio.Server.wait_closed() #111260

Closed
wants to merge 1 commit into from

Conversation

Dreamsorcerer
Copy link
Contributor

@Dreamsorcerer Dreamsorcerer commented Oct 24, 2023

@gvanrossum Just a small followup from #98582.

In aiohttp, for some reason it was originally written as calling wait_closed() before cancelling the open connections. So, from that wording in the Python documentation I always assumed that it was waiting for the sockets to stop listening, rather than waiting for the connections to be closed. Clearly this was wrong, and it actually did nothing, and aiohttp's shutdown should have been broken long ago.

In particular, the close() method says 'The sockets that represent existing incoming client connections are left open.'.
So, saying that it waits for close() to complete, which itself says connections are left open was a little confusing.


📚 Documentation preview 📚: https://cpython-previews--111260.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2023
@AlexWaygood AlexWaygood changed the title docs: Minor improvement to asyncio.Server.wait_closed() GH-79033: docs: Minor improvement to asyncio.Server.wait_closed() Oct 24, 2023
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

This phrasing is fine, and we should merge it.

Note, however, that there's another chapter to the wait_closed litany:
#79033 (comment)

@Dreamsorcerer
Copy link
Contributor Author

Superseded by #111336.

@Dreamsorcerer Dreamsorcerer deleted the patch-8 branch October 26, 2023 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants