]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-45693: Document `port` parameter to `loop.create_server` (GH-29760) (GH-29763)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 24 Nov 2021 20:40:09 +0000 (12:40 -0800)
committerGitHub <noreply@github.com>
Wed, 24 Nov 2021 20:40:09 +0000 (15:40 -0500)
Document the `port` parameter to `loop.create_server` in `asyncio`. In
particular, note that if `host` resolves to multiple network interfaces,
passing in `port=0` will result in a different random unused port being
used for each interface.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit d71c7bc7339eb82de493c66ebbbfa1cad250ac78)

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
Doc/library/asyncio-eventloop.rst

index 4a64475f2a939ee467cbe31eba0dde7b8e21d604..d70aeae766ae3098ed2d80b2950ecb1eabc72831 100644 (file)
@@ -626,6 +626,11 @@ Creating network servers
        assumed and a list of multiple sockets will be returned (most likely
        one for IPv4 and another one for IPv6).
 
+   * The *port* parameter can be set to specify which port the server should
+     listen on. If ``0`` or ``None`` (the default), a random unused port will
+     be selected (note that if *host* resolves to multiple network interfaces,
+     a different random port will be selected for each interface).
+
    * *family* can be set to either :data:`socket.AF_INET` or
      :data:`~socket.AF_INET6` to force the socket to use IPv4 or IPv6.
      If not set, the *family* will be determined from host name