diff options
| author | Christian Heimes <christian@python.org> | 2018-01-29 21:37:58 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-01-29 21:37:58 (GMT) |
| commit | b6e43af669f61a37a29d8ff0785455108e6bc29d (patch) | |
| tree | 3a6c733b60cf579c43b18cabdc9a7a3ce113f81b /Doc/library/socket.rst | |
| parent | 72a0d218dcc94a3cc409a9ef32dfcd5a7bbcb43c (diff) | |
| download | cpython-b6e43af669f61a37a29d8ff0785455108e6bc29d.zip cpython-b6e43af669f61a37a29d8ff0785455108e6bc29d.tar.gz cpython-b6e43af669f61a37a29d8ff0785455108e6bc29d.tar.bz2 | |
bpo-28134: Auto-detect socket values from file descriptor (#1349)
Fix socket(fileno=fd) by auto-detecting the socket's family, type,
and proto from the file descriptor. The auto-detection can be overruled
by passing in family, type, and proto explicitly.
Without the fix, all socket except for TCP/IP over IPv4 are basically broken:
>>> s = socket.create_connection(('www.python.org', 443))
>>> s
<socket.socket fd=3, family=AddressFamily.AF_INET6, type=SocketKind.SOCK_STREAM, proto=6, laddr=('2003:58:bc4a:3b00:56ee:75ff:fe47:ca7b', 59730, 0, 0), raddr=('2a04:4e42:1b::223', 443, 0, 0)>
>>> socket.socket(fileno=s.fileno())
<socket.socket fd=3, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=0, laddr=('2003:58:bc4a:3b00::%2550471192', 59730, 0, 2550471192), raddr=('2a04:4e42:1b:0:700c:e70b:ff7f:0%2550471192', 443, 0, 2550471192)>
Signed-off-by: Christian Heimes <christian@python.org>
Diffstat (limited to 'Doc/library/socket.rst')
| -rw-r--r-- | Doc/library/socket.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index faa260e..7f0d4ed 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -461,10 +461,15 @@ The following functions all create :ref:`socket objects <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`, :const:`CAN_BCM` or :const:`CAN_ISOTP`. 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 + of :const:`CAN_RAW`, :const:`CAN_BCM` or :const:`CAN_ISOTP` + + If *fileno* is specified, the values for *family*, *type*, and *proto* are + auto-detected from the specified file descriptor. Auto-detection can be + overruled by calling the function with explicit *family*, *type*, or *proto* + arguments. This only affects how Python represents e.g. the return value + of :meth:`socket.getpeername` but not the actual OS resource. 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 <fd_inheritance>`. |