From 24a610984da381008237de6c3165b4e0aa4ec10c Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Thu, 8 Oct 2015 06:34:01 +0300 Subject: Issue #16802: Document fileno parameter of socket.socket() Patch by Henrik Heimbuerger and Bar Harel. --- Doc/library/socket.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index 271dda8..638a77e 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -369,7 +369,11 @@ The following functions all create :ref:`socket objects `. :const:`SOCK_DGRAM`, :const:`SOCK_RAW` or perhaps one of the other ``SOCK_`` constants. The protocol number is usually zero and may be omitted or in the case where the address family is :const:`AF_CAN` the protocol should be one - of :const:`CAN_RAW` or :const:`CAN_BCM`. + of :const:`CAN_RAW` or :const:`CAN_BCM`. If *fileno* is specified, the other + arguments are ignored, causing the socket with the specified file descriptor + to return. Unlike :func:`socket.fromfd`, *fileno* will return the same + socket and not a duplicate. This may help close a detached socket using + :meth:`socket.close()`. The newly created socket is :ref:`non-inheritable `. -- cgit v0.12