[Python-checkins] bpo-45693: Document `port` parameter to `loop.create_server` (GH-29760)
miss-islington
webhook-mailer at python.org
Wed Nov 24 14:44:09 EST 2021
https://github.com/python/cpython/commit/d71c7bc7339eb82de493c66ebbbfa1cad250ac78
commit: d71c7bc7339eb82de493c66ebbbfa1cad250ac78
branch: main
author: Jim Crist-Harif <jcristharif at gmail.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-11-24T11:43:57-08:00
summary:
bpo-45693: Document `port` parameter to `loop.create_server` (GH-29760)
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
files:
M Doc/library/asyncio-eventloop.rst
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index c4408f122c378..5a3369415a745 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -631,6 +631,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
More information about the Python-checkins
mailing list