]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-141938: document treatment of `OSError` raised by `HTTPConnection.getrespon...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 14 Dec 2025 10:18:08 +0000 (11:18 +0100)
committerGitHub <noreply@github.com>
Sun, 14 Dec 2025 10:18:08 +0000 (10:18 +0000)
gh-141938: document treatment of `OSError` raised by `HTTPConnection.getresponse` (GH-142339)
(cherry picked from commit 11aef219f5186fcb9b8121651e5bdbd7e84c3a4e)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Doc/library/http.client.rst

index 75aa818ab9f5d711f87566d65804beb46479eff6..14c67a0600f72876a133c895f02e6c20633ee9a5 100644 (file)
@@ -311,6 +311,12 @@ HTTPConnection Objects
       :class:`str` or bytes-like object that is not also a file as the
       body representation.
 
+   .. note::
+
+      Note that you must have read the whole response or call :meth:`close`
+      if :meth:`getresponse` raised an non-:exc:`ConnectionError` exception
+      before you can send a new request to the server.
+
    .. versionchanged:: 3.2
       *body* can now be an iterable.
 
@@ -326,16 +332,15 @@ HTTPConnection Objects
    Should be called after a request is sent to get the response from the server.
    Returns an :class:`HTTPResponse` instance.
 
-   .. note::
-
-      Note that you must have read the whole response before you can send a new
-      request to the server.
-
    .. versionchanged:: 3.5
       If a :exc:`ConnectionError` or subclass is raised, the
       :class:`HTTPConnection` object will be ready to reconnect when
       a new request is sent.
 
+      Note that this does not apply to :exc:`OSError`\s raised by the underlying
+      socket. Instead the caller is responsible to call :meth:`close` on the
+      existing connection.
+
 
 .. method:: HTTPConnection.set_debuglevel(level)