gh-134664: Document cleanup_socket parameter in asyncio.start_unix_server() #134750
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nix_server() Document that in Python 3.13, the cleanup_socket parameter was added to asyncio.start_unix_server() with a default value of True. This parameter controls whether the Unix socket is automatically removed from the filesystem when the server is closed.
b092cb5 to
f853464
Compare
f853464 to
587f2d7
Compare
kumaraditya303
approved these changes
May 27, 2025
|
Thanks @ashm-dev for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2025
…t_unix_server` (pythonGH-134750) (cherry picked from commit 92ea1eb) Co-authored-by: Shamil <ashm.tech@proton.me>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2025
…t_unix_server` (pythonGH-134750) (cherry picked from commit 92ea1eb) Co-authored-by: Shamil <ashm.tech@proton.me>
|
GH-134779 is a backport of this pull request to the 3.14 branch. |
|
GH-134780 is a backport of this pull request to the 3.13 branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds documentation for the
cleanup_socketparameter inasyncio.start_unix_server()function, which was added in Python 3.13 with a default value ofTrue. This parameter controls whether the Unix socket is automatically removed from the filesystem when the server is closed.Details
In Python 3.13, a feature was added where Unix sockets are automatically cleaned up by default when using
asyncio.start_unix_server(). This was considered a breaking change, but it wasn't properly documented at the time of implementation.This PR:
cleanup_socketparameter to the function signature in the documentationRelated Issues
Closes #134664
Related to #133354
📚 Documentation preview 📚: https://cpython-previews--134750.org.readthedocs.build/