Skip to content

Commit 0f93b2f

Browse files
[3.14] pythongh-134664: document cleanup_socket parameter in asyncio.start_unix_server (pythonGH-134750) (python#134779)
pythongh-134664: document `cleanup_socket` parameter in `asyncio.start_unix_server` (pythonGH-134750) (cherry picked from commit 92ea1eb) Co-authored-by: Shamil <ashm.tech@proton.me>
1 parent b6e624a commit 0f93b2f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

Doc/library/asyncio-stream.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,17 @@ and work with streams:
171171
.. function:: start_unix_server(client_connected_cb, path=None, \
172172
*, limit=None, sock=None, backlog=100, ssl=None, \
173173
ssl_handshake_timeout=None, \
174-
ssl_shutdown_timeout=None, start_serving=True)
174+
ssl_shutdown_timeout=None, start_serving=True, cleanup_socket=True)
175175
:async:
176176
177177
Start a Unix socket server.
178178

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

181+
If *cleanup_socket* is true then the Unix socket will automatically
182+
be removed from the filesystem when the server is closed, unless the
183+
socket has been replaced after the server has been created.
184+
181185
See also the documentation of :meth:`loop.create_unix_server`.
182186

183187
.. note::
@@ -198,6 +202,9 @@ and work with streams:
198202
.. versionchanged:: 3.11
199203
Added the *ssl_shutdown_timeout* parameter.
200204

205+
.. versionchanged:: 3.13
206+
Added the *cleanup_socket* parameter.
207+
201208

202209
StreamReader
203210
============

0 commit comments

Comments
 (0)