Skip to content

[3.14] gh-134664: document cleanup_socket parameter in asyncio.start_unix_server (GH-134750) #134779

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 27, 2025
Merged

[3.14] gh-134664: document cleanup_socket parameter in asyncio.start_unix_server (GH-134750) #134779

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Doc/library/asyncio-stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,17 @@ and work with streams:
.. function:: start_unix_server(client_connected_cb, path=None, \
*, limit=None, sock=None, backlog=100, ssl=None, \
ssl_handshake_timeout=None, \
ssl_shutdown_timeout=None, start_serving=True)
ssl_shutdown_timeout=None, start_serving=True, cleanup_socket=True)
:async:

Start a Unix socket server.

Similar to :func:`start_server` but works with Unix sockets.

If *cleanup_socket* is true then the Unix socket will automatically
be removed from the filesystem when the server is closed, unless the
socket has been replaced after the server has been created.

See also the documentation of :meth:`loop.create_unix_server`.

.. note::
Expand All @@ -198,6 +202,9 @@ and work with streams:
.. versionchanged:: 3.11
Added the *ssl_shutdown_timeout* parameter.

.. versionchanged:: 3.13
Added the *cleanup_socket* parameter.


StreamReader
============
Expand Down
Loading