From: beavailable <beavailable@proton.me>
Date: Wed, 1 Feb 2023 11:03:59 +0000 (+0800)
Subject: gh-101317: Add `ssl_shutdown_timeout` parameter for `asyncio.StreamWriter.start_tls... 
X-Git-Tag: v3.12.0a5~54
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cc407b9de645ab7c137df8ea2409a005369169a5;p=thirdparty%2FPython%2Fcpython.git

gh-101317: Add `ssl_shutdown_timeout` parameter for `asyncio.StreamWriter.start_tls` (#101335)

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
---

diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index c1ae8abb9abc..533bdec8e039 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -335,7 +335,7 @@ StreamWriter
       returns immediately.
 
    .. coroutinemethod:: start_tls(sslcontext, \*, server_hostname=None, \
-                          ssl_handshake_timeout=None)
+                          ssl_handshake_timeout=None, ssl_shutdown_timeout=None)
 
       Upgrade an existing stream-based connection to TLS.
 
@@ -350,8 +350,16 @@ StreamWriter
         handshake to complete before aborting the connection.  ``60.0`` seconds
         if ``None`` (default).
 
+      * *ssl_shutdown_timeout* is the time in seconds to wait for the SSL shutdown
+        to complete before aborting the connection. ``30.0`` seconds if ``None``
+        (default).
+
       .. versionadded:: 3.11
 
+      .. versionchanged:: 3.12
+         Added the *ssl_shutdown_timeout* parameter.
+
+
    .. method:: is_closing()
 
       Return ``True`` if the stream is closed or in the process of
diff --git a/Lib/asyncio/streams.py b/Lib/asyncio/streams.py
index 0f9098b41956..7d13e961bd2d 100644
--- a/Lib/asyncio/streams.py
+++ b/Lib/asyncio/streams.py
@@ -378,7 +378,8 @@ class StreamWriter:
 
     async def start_tls(self, sslcontext, *,
                         server_hostname=None,
-                        ssl_handshake_timeout=None):
+                        ssl_handshake_timeout=None,
+                        ssl_shutdown_timeout=None):
         """Upgrade an existing stream-based connection to TLS."""
         server_side = self._protocol._client_connected_cb is not None
         protocol = self._protocol
@@ -386,7 +387,8 @@ class StreamWriter:
         new_transport = await self._loop.start_tls(  # type: ignore
             self._transport, protocol, sslcontext,
             server_side=server_side, server_hostname=server_hostname,
-            ssl_handshake_timeout=ssl_handshake_timeout)
+            ssl_handshake_timeout=ssl_handshake_timeout,
+            ssl_shutdown_timeout=ssl_shutdown_timeout)
         self._transport = new_transport
         protocol._replace_writer(self)
 
diff --git a/Misc/NEWS.d/next/Library/2023-01-26-01-25-56.gh-issue-101317.vWaS1x.rst b/Misc/NEWS.d/next/Library/2023-01-26-01-25-56.gh-issue-101317.vWaS1x.rst
new file mode 100644
index 000000000000..f1ce0e0a5276
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2023-01-26-01-25-56.gh-issue-101317.vWaS1x.rst
@@ -0,0 +1,2 @@
+Add *ssl_shutdown_timeout* parameter for :meth:`asyncio.StreamWriter.start_tls`.
+