summaryrefslogtreecommitdiffstats
path: root/Doc/library/socket.rst
Commit message (Collapse)AuthorAgeFilesLines
* bpo-40635: Fix getfqdn() docstring and docs (GH-27971)Miss Islington (bot)2021-08-261-2/+3
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit fdcb675eed47b1f6054fae381af4388b16a6fff4) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
* bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) ↵Miss Islington (bot)2021-07-261-5/+5
| | | | | | | | (GH-27380) Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit 11749e2dc20ad6a76e9a39e948853e89b2b4bbed) Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
* bpo-34932: Add socket.TCP_KEEPALIVE for macOS (GH-25079)Miss Islington (bot)2021-07-141-0/+2
| | | | | (cherry picked from commit d59d7374a364c4e5c2b9a83d8e4543ee494285b8) Co-authored-by: Shane Harvey <shnhrv@gmail.com>
* [3.10] bpo-44559: [Enum] revert enum module to 3.9 (GH-27010)Ethan Furman2021-07-041-2/+2
| | | * [Enum] revert enum module to 3.9
* bpo-44077: Expose IP_RECVTOS in the socket module (GH-25992)Miss Islington (bot)2021-06-201-0/+3
| | | | | | Co-authored-by: Pablo Galindo <pablogsal@gmail.com> (cherry picked from commit a317778fd58b1c6b250feffbdb4ecf15e293ef48) Co-authored-by: Georg Sauthoff <mail@georg.so>
* bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right ↵Saiyang Gou2021-04-221-23/+26
| | | | section (GH-22608)
* bpo-40066: Enum: modify `repr()` and `str()` (GH-22392)Ethan Furman2021-03-311-2/+2
| | | | | | | | | * Enum: streamline repr() and str(); improve docs - repr() is now ``enum_class.member_name`` - stdlib global enums are ``module_name.member_name`` - str() is now ``member_name`` - add HOW-TO section for ``Enum`` - change main documentation to be an API reference
* bpo-43571: Add IPPROTO_MPTCP macro (GH-24946)Rui Cunha2021-03-201-0/+3
| | | Add IPPROTO_MPTCP constant when defined in the system headers.
* bpo-42393: Raise OverflowError iso. DeprecationWarning on overflow in ↵Erlend Egeberg Aasland2020-12-311-10/+6
| | | | socket.ntohs and socket.htons (GH-23980)
* [doc] Fix a few margins due to bad markup (GH-23619)Andre Delfino2020-12-171-5/+5
|
* bpo-42413: socket.timeout is now an alias of TimeoutError (GH-23413)Christian Heimes2020-11-201-1/+6
| | | Signed-off-by: Christian Heimes <christian@python.org>
* bpo-40901: Describe what "interface name" means on Windows (GH-20694)Jakub Stasiak2020-10-191-0/+19
|
* bpo-40204: Add :noindex: in the documentation (GH-21859)Victor Stinner2020-08-131-0/+2
| | | | | | | | | | Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them
* bpo-40291: Add support for CAN_J1939 sockets (GH-19538)karl ding2020-04-291-1/+18
| | | | Add support for CAN_J1939 sockets that wrap SAE J1939 protocol functionality provided by Linux 5.4+ kernels.
* bpo-25780: Expose CAN_RAW_JOIN_FILTERS in the socket module (GH-19190)Zackery Spytz2020-04-091-0/+11
| | | Co-Authored-By: Stefan Tatschner <stefan@rumpelsepp.org>
* bpo-34788: Add support for scoped IPv6 addresses (GH-13772)opavlyuk2020-02-261-10/+10
| | | Automerge-Triggered-By: @asvetlov
* bpo-39348: Fix code highlight for the SOCK_NONBLOCK example (GH-18018)Oz N Tiram2020-01-151-1/+3
| | | | | | | | | | | The previous double colon was wrongly place directly after Therefore. Which produced a block without syntax highlighting. This fixes it by separating the double colon from the text. As a result, sphinx now properly highlights the python code. https://bugs.python.org/issue39348
* Remove use of deprecated `array.fromstring` method (GH-17332)David Coles2019-11-261-2/+2
|
* bpo-38600: NULL -> ``NULL``. (GH-17001)Serhiy Storchaka2019-10-301-3/+3
| | | Also fix some other formatting.
* bpo-28724: Add methods send_fds and recv_fds to the socket module (GH-12889)Joannah Nanjekye2019-09-111-0/+23
| | | | | | | The socket module now has the socket.send_fds() and socket.recv.fds() functions. Contributed by Joannah Nanjekye, Shinya Okano (original patch) and Victor Stinner. Co-Authored-By: Victor Stinner <vstinner@redhat.com>
* bpo-37085: Expose SocketCAN bcm_msg_head flags (#13646)karl ding2019-07-311-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | Expose the CAN_BCM SocketCAN constants used in the bcm_msg_head struct flags (provided by <linux/can/bcm.h>) under the socket library. This adds the following constants with a CAN_BCM prefix: * SETTIMER * STARTTIMER * TX_COUNTEVT * TX_ANNOUNCE * TX_CP_CAN_ID * RX_FILTER_ID * RX_CHECK_DLC * RX_NO_AUTOTIMER * RX_ANNOUNCE_RESUME * TX_RESET_MULTI_IDX * RX_RTR_FRAME * CAN_FD_FRAME The CAN_FD_FRAME flag was introduced in the 4.8 kernel, while the other ones were present since SocketCAN drivers were mainlined in 2.6.25. As such, it is probably unnecessary to guard against these constants being missing.
* bpo-37390: Add audit event table to documentations (GH-14406)Steve Dower2019-06-271-15/+15
| | | Also updates some (unreleased) event names to be consistent with the others.
* bpo-37345: Add formal UDPLITE support (GH-14258)Gabe Appleton2019-06-241-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | At the moment you can definitely use UDPLITE sockets on Linux systems, but it would be good if this support were formalized such that you can detect support at runtime easily. At the moment, to make and use a UDPLITE socket requires something like the following code: ``` >>> import socket >>> a = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, 136) >>> b = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, 136) >>> a.bind(('localhost', 44444)) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.setsockopt(136, 10, 16) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.setsockopt(136, 10, 32) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.setsockopt(136, 10, 64) >>> b.sendto(b'test'*256, ('localhost', 44444)) ``` If you look at this through Wireshark, you can see that the packets are different in that the checksums and checksum coverages change. With the pull request that I am submitting momentarily, you could do the following code instead: ``` >>> import socket >>> a = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDPLITE) >>> b = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDPLITE) >>> a.bind(('localhost', 44444)) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.set_send_checksum_coverage(16) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.set_send_checksum_coverage(32) >>> b.sendto(b'test'*256, ('localhost', 44444)) >>> b.set_send_checksum_coverage(64) >>> b.sendto(b'test'*256, ('localhost', 44444)) ``` One can also detect support for UDPLITE just by checking ``` >>> hasattr(socket, 'IPPROTO_UDPLITE') ``` https://bugs.python.org/issue37345
* bpo-37007: Implement socket.if_nametoindex(), if_indextoname() and ↵Zackery Spytz2019-05-291-3/+12
| | | | if_nameindex() on Windows (GH-13522)
* Fix typo in docs for socket.CAN_RAW_FD_FRAMES (GH-13635)karl ding2019-05-281-1/+1
| | | | There is an extra "one" in the text description for the constant socket.CAN_RAW_FD_FRAMES
* bpo-36842: Implement PEP 578 (GH-12613)Steve Dower2019-05-231-0/+28
| | | Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
* bpo-20582: add link for manpage for flags on getnameinfo() (GH-11977)Emmanuel Arias2019-04-111-0/+2
|
* BPO-17561: set create_server backlog default to None (GH-12735)Giampaolo Rodola2019-04-091-1/+1
| | | | | | | | | It turns out doing socket.listen(0) does not equal to "choose a reasonable default". It actually means "set backlog to 0". As such set backlog=None as the default for socket.create_server. Fixes the following BB failures: https://github.com/python/cpython/pull/11784#issuecomment-481036369 Ref. BPO-1756, GH-11784.
* bpo-35934: Add socket.create_server() utility function (GH-11784)Giampaolo Rodola2019-04-081-1/+44
|
* bpo-11233: Create availability directive for documentation (GH-9692)Cheryl Sabella2018-10-121-27/+27
| | | | | | Replace "Availability: xxx" with ".. availability:: xxx" in the doc. Original patch by Georg Brandl. Co-Authored-By: Georg Brandl <georg@python.org>
* bpo-31425: fix versionadded in docs and add attribution in NEWS (GH-9595)Tal Einat2018-09-261-1/+1
|
* bpo-31425: Expose AF_QIPCRTR in socket module (GH-3706)Bjorn Andersson2018-09-261-0/+14
| | | | | | The AF_QIPCRTR address family was introduced in Linux v4.7. Co-authored-by: Bjorn Andersson <bjorn.andersson@linaro.org>
* closes bpo-25041: Document AF_PACKET socket address format. (GH-4092)Cheryl Sabella2018-09-121-10/+35
|
* bpo-33921: Clarify how to bind to all interfaces using socket (GH-7877)johnthagen2018-07-281-6/+7
| | | Clarify how to bind to all interfaces using socket
* bpo-32394: Remove some TCP options on old version Windows. (GH-5523)animalize2018-02-261-0/+7
|
* bpo-32221: makeipaddr(): remove interface part + speedup (GH-5449) (#5449)Коренберг Марк2018-02-121-0/+15
|
* bpo-28134: Auto-detect socket values from file descriptor (#1349)Christian Heimes2018-01-291-4/+9
| | | | | | | | | | | | | | | 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>
* bpo-32373: Add socket.getblocking() method. (#4926)Yury Selivanov2018-01-281-0/+10
|
* Revert "bpo-32221: makeipaddr(): remove interface part + speedup (GH-4724)" ↵Yury Selivanov2018-01-281-15/+0
| | | | | (#5394) This reverts commit 47c0b1f7d4115e6f15e6776c1f91d28e7d96fe0c.
* bpo-32221: makeipaddr(): remove interface part + speedup (GH-4724)Коренберг Марк2018-01-271-0/+15
|
* bpo-32454: socket closefd (#5048)Christian Heimes2018-01-271-0/+8
| | | | | Add close(fd) function to the socket module Signed-off-by: Christian Heimes <christian@python.org>
* bpo-32331: Fix socket.type when SOCK_NONBLOCK is available (#4877)Yury Selivanov2017-12-191-0/+22
|
* bpo-27584: New addition of vSockets to the python socket module (#2489)caavery2017-09-061-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-27584: New addition of vSockets to the python socket module Support for AF_VSOCK on Linux only * bpo-27584: Fixes for V2 Fixed syntax and naming problems. Fixed #ifdef AF_VSOCK checking Restored original aclocal.m4 * bpo-27584: Fixes for V3 Added checking for fcntl and thread modules. * bpo-27584: Fixes for V4 Fixed white space error * bpo-27584: Fixes for V5 Added back comma in (CID, port). * bpo-27584: Fixes for V6 Added news file. socket.rst now reflects first Linux introduction of AF_VSOCK. Fixed get_cid in test_socket.py. Replaced PyLong_FromLong with PyLong_FromUnsignedLong in socketmodule.c Got rid of extra AF_VSOCK #define. Added sockaddr_vm to sock_addr. * bpo-27584: Fixes for V7 Minor cleanup. * bpo-27584: Fixes for V8 Put back #undef AF_VSOCK as it is necessary when vm_sockets.h is not installed.
* bpo-30987 - Support for ISO-TP protocol in SocketCAN (#2956)Pier-Yves Lessard2017-08-281-3/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added support for CAN_ISOTP protocol * Added unit tests for CAN ISOTP * Updated documentation for ISO-TP protocol * Removed trailing whitespace in documentation * Added blurb NEWS.d file * updated Misc/ACKS * Fixed broken unit test that was using isotp const outside of skippable section * Removed dependecy over third party project * Added implementation for getsockname + unit tests * Missing newline at end of ACKS file * Accidentally inserted a type in ACKS file * Followed tiran changes review #1 recommendations * Added spaces after comma
* bpo-29728: Provide socket.TCP_NOTSENT_LOWAT (#477)Nathaniel J. Smith2017-03-231-0/+3
| | | | | * Provide socket.TCP_NOTSENT_LOWAT * New TCP option available on recent MacOS and Linux. * Document addition of TCP_NOTSENT_LOWAT
* Merge 3.6Victor Stinner2017-01-231-2/+2
|\
| * Issue #26273: Document TCP_USER_TIMEOUT and TCP_CONGESTIONVictor Stinner2017-01-231-2/+2
| |
* | Merge doc fixes from 3.6Martin Panter2017-01-141-2/+2
|\ \ | |/
| * Merge doc fixes from 3.5Martin Panter2017-01-141-2/+2
| |\
| | * Avoid line breaks after hyphens, otherwise they are turned into spacesMartin Panter2017-01-141-2/+2
| | |