]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.15] gh-89696: Fix `loop.sock_connect` docs on address resolution (GH-153651) ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 13 Jul 2026 10:09:39 +0000 (12:09 +0200)
committerGitHub <noreply@github.com>
Mon, 13 Jul 2026 10:09:39 +0000 (15:39 +0530)
gh-89696: Fix `loop.sock_connect` docs on address resolution (GH-153651)
(cherry picked from commit 1fece4457032382947c7c2a5c9e95dc106ca7a7d)

Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Doc/library/asyncio-eventloop.rst

index 79c9516cda2d60b05b2946ee920159e8d5f82c76..865f5e3be39a86899192469a7ea168adf0aaf8d6 100644 (file)
@@ -1156,12 +1156,21 @@ convenient.
 
    *sock* must be a non-blocking socket.
 
+   With :class:`SelectorEventLoop`, *address* does not need to be resolved:
+   for :const:`~socket.AF_INET` and :const:`~socket.AF_INET6` sockets,
+   ``sock_connect`` first checks whether *address* is already resolved by
+   calling :func:`socket.inet_pton`, and uses :meth:`loop.getaddrinfo` to
+   resolve it if it is not.
+
+   :class:`ProactorEventLoop`, the default event loop on Windows, does not
+   resolve *address*.  The host must already be a numeric IP address; passing
+   a host name raises :exc:`OSError`.  Resolve the address with
+   :meth:`loop.getaddrinfo` first, or use :meth:`loop.create_connection`,
+   which resolves the address on every platform.
+
    .. versionchanged:: 3.5.2
-      ``address`` no longer needs to be resolved.  ``sock_connect``
-      will try to check if the *address* is already resolved by calling
-      :func:`socket.inet_pton`.  If not,
-      :meth:`loop.getaddrinfo` will be used to resolve the
-      *address*.
+      With :class:`SelectorEventLoop`, ``address`` no longer needs to be
+      resolved.
 
    .. seealso::