summaryrefslogtreecommitdiffstats
path: root/Doc/library/socket.rst
Commit message (Collapse)AuthorAgeFilesLines
* [3.8] [doc] Fix a few margins due to bad markup (GH-23619). (GH-23860)Andre Delfino2020-12-221-5/+5
| | | | | (cherry picked from commit 96a09df64483b70c4215c7025a19b9d2f1636c55) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-40901: Describe what "interface name" means on Windows (GH-20694)Miss Skeleton (bot)2020-10-191-0/+19
| | | | | (cherry picked from commit f85658a09878c658ae0e0590bfa30e4ce51c9a04) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) 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 (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a) (cherry picked from commit 8f88190af529543c84d5dc78f19abbfd73335cf4)
* bpo-39348: Fix code highlight for the SOCK_NONBLOCK example (GH-18018)Miss Islington (bot)2020-01-161-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 (cherry picked from commit fad8b5674c66d9e00bb788e30adddb0c256c787b) Co-authored-by: Oz N Tiram <oz.tiram@noris.de>
* Remove use of deprecated `array.fromstring` method (GH-17332)Miss Islington (bot)2019-11-261-2/+2
| | | | | (cherry picked from commit 386d00cc341b549800776b906bfc6b20ea40c7db) Co-authored-by: David Coles <coles.david@gmail.com>
* [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003)Serhiy Storchaka2019-10-301-3/+3
| | | | | Also fix some other formatting. (cherry picked from commit e835b31d2b212c3c7820364398979cae2a9740b2)
* bpo-37085: Expose SocketCAN bcm_msg_head flags (GH-13646)Miss Islington (bot)2019-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. (cherry picked from commit 31c4fd2a10d90beaa37d630e5f74a471e14e089d) Co-authored-by: karl ding <karlding@users.noreply.github.com>
* bpo-37390: Add audit event table to documentations (GH-14406)Miss Islington (bot)2019-06-271-15/+15
| | | | | | Also updates some (unreleased) event names to be consistent with the others. (cherry picked from commit 44f91c388a6f4da9ed3300df32ca290b8aa104ea) Co-authored-by: Steve Dower <steve.dower@python.org>
* 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
| | |
* | | Issue #21818: Fixed references to classes that have names matching with moduleSerhiy Storchaka2016-12-021-1/+1
|\ \ \ | |/ / | | | | | | names.
| * | Issue #21818: Fixed references to classes that have names matching with moduleSerhiy Storchaka2016-12-021-1/+1
| |\ \ | | |/ | | | | | | names.
| | * Issue #21818: Fixed references to classes that have names matching with moduleSerhiy Storchaka2016-12-021-1/+1
| | | | | | | | | | | | names.
* | | Issue #19795: Mark up None as literal text.Serhiy Storchaka2016-10-191-2/+2
|\ \ \ | |/ /
| * | Issue #19795: Mark up None as literal text.Serhiy Storchaka2016-10-191-2/+2
| |\ \ | | |/
* | | Issue #28332: Deprecated silent truncations in socket.htons and socket.ntohs.Serhiy Storchaka2016-10-021-0/+12
|/ / | | | | | | Original patch by Oren Milman.
* | Merge: #26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.R David Murray2016-09-071-0/+2
|\ \ | |/
| * #26209: Clarify type of *localaddr*/*remoteadr* in smtpd docs.R David Murray2016-09-071-0/+2
| |
* | Issue #27744: correct comment and markupChristian Heimes2016-09-051-1/+1
| |
* | Issue #27744: Add AF_ALG (Linux Kernel crypto) to socket module.Christian Heimes2016-09-051-6/+49
| |
* | #26907: add some missing getsockopt constants.R David Murray2016-08-241-0/+4
| | | | | | | | Patch by Christian Heimes, reviewed by Martin Panter.
* | Issue #27626: Merge spelling fixes from 3.5Martin Panter2016-07-281-1/+1
|\ \ | |/
| * Issue #27626: Spelling fixes in docs, comments and internal namesMartin Panter2016-07-281-1/+1
| | | | | | | | Based on patch by Ville Skyttä.
* | Issue #26536: socket.ioctl now supports SIO_LOOPBACK_FAST_PATH. Patch by ↵Steve Dower2016-06-171-1/+12
| | | | | | | | Daniel Stokes.
* | Merge Issue #22558.Terry Jan Reedy2016-06-111-0/+3
|\ \ | |/