]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-141938: document treatment of `OSError` raised by `HTTPConnection.getresponse...
authorBénédikt Tran <10796600+picnixz@users.noreply.github.com>
Sun, 14 Dec 2025 10:12:20 +0000 (11:12 +0100)
committerGitHub <noreply@github.com>
Sun, 14 Dec 2025 10:12:20 +0000 (11:12 +0100)
Doc/library/http.client.rst

index 7c258b324d98674654b6ddc96e6f531143421782..ddf3d40d221fcd79173ac76f4513b3dc6a477bdf 100644 (file)
@@ -319,6 +319,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.
 
@@ -334,16 +340,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)