[Python-checkins] bpo-40901: Describe what "interface name" means on Windows (GH-20694)
Miss Skeleton (bot)
webhook-mailer at python.org
Mon Oct 19 18:49:59 EDT 2020
https://github.com/python/cpython/commit/9308173f880f3c0a6447da8335f3ae68edad3b0f
commit: 9308173f880f3c0a6447da8335f3ae68edad3b0f
branch: 3.9
author: Miss Skeleton (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-10-19T15:49:55-07:00
summary:
bpo-40901: Describe what "interface name" means on Windows (GH-20694)
(cherry picked from commit f85658a09878c658ae0e0590bfa30e4ce51c9a04)
Co-authored-by: Jakub Stasiak <jakub at stasiak.at>
files:
M Doc/library/socket.rst
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 5bcac20a4c604..faf8a76251420 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -1091,6 +1091,19 @@ The :mod:`socket` module also offers various network-related services:
.. versionchanged:: 3.8
Windows support was added.
+ .. note::
+
+ On Windows network interfaces have different names in different contexts
+ (all names are examples):
+
+ * UUID: ``{FB605B73-AAC2-49A6-9A2F-25416AEA0573}``
+ * name: ``ethernet_32770``
+ * friendly name: ``vEthernet (nat)``
+ * description: ``Hyper-V Virtual Ethernet Adapter``
+
+ This function returns names of the second form from the list, ``ethernet_32770``
+ in this example case.
+
.. function:: if_nametoindex(if_name)
@@ -1105,6 +1118,9 @@ The :mod:`socket` module also offers various network-related services:
.. versionchanged:: 3.8
Windows support was added.
+ .. seealso::
+ "Interface name" is a name as documented in :func:`if_nameindex`.
+
.. function:: if_indextoname(if_index)
@@ -1119,6 +1135,9 @@ The :mod:`socket` module also offers various network-related services:
.. versionchanged:: 3.8
Windows support was added.
+ .. seealso::
+ "Interface name" is a name as documented in :func:`if_nameindex`.
+
.. _socket-objects:
More information about the Python-checkins
mailing list