summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* Update copyright year to 2022. (GH-30335) (GH-31477)Miss Islington (bot)2022-02-212-2/+2
| | | | | | Automerge-Triggered-By: GH:benjaminp (cherry picked from commit ba00f0d93a4aea85ae8089f139856a7c450584d7) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 ↵Ned Deily2022-02-211-1/+1
| | | | (GH-31476)
* bpo-41028: use generic version links in Docs index.Ned Deily2022-01-022-8/+6
|
* [3.7] bpo-44394: Update libexpat copy to 2.4.1 (GH-26945) (GH-28042)Łukasz Langa2021-08-311-14/+18
| | | | | | | | | | | | Update the vendored copy of libexpat to 2.4.1 (from 2.2.8) to get the fix for the CVE-2013-0340 "Billion Laughs" vulnerability. This copy is most used on Windows and macOS. Co-authored-by: Victor Stinner <vstinner@python.org> Co-authored-by: Łukasz Langa <lukasz@langa.pl>. (cherry picked from commit 3fc5d84046ddbd66abac5b598956ea34605a4e5d)
* [3.7] bpo-43882 - Mention urllib.parse changes in Whats New section for ↵Senthil Kumaran2021-05-201-0/+10
| | | | | 3.7.11 (GH-26267) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.7] bpo-43882 - urllib.parse should sanitize urls containing ASCII newline ↵Miss Islington (bot)2021-05-061-0/+13
| | | | | | | | | | | | and tabs. (GH-25923) Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 76cd81d60310d65d01f9d7b48a8985d8ab89c8b4) Co-authored-by: Senthil Kumaran <senthil@uthcode.com> (cherry picked from commit 515a7bc4e13645d0945b46a8e1d9102b918cd407) Co-authored-by: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
* [3.7] bpo-43285 Make ftplib not trust the PASV response. (GH-24838) ↵Miss Islington (bot)2021-03-161-0/+9
| | | | | | | | | | | | | | | | | | | | (GH-24881) (GH-24883) The IPv4 address value returned from the server in response to the PASV command should not be trusted. This prevents a malicious FTP server from using the response to probe IPv4 address and port combinations on the client network. Instead of using the returned address, we use the IP address we're already connected to. This is the strategy other ftp clients adopted, and matches the only strategy available for the modern IPv6 EPSV command where the server response must return a port number and nothing else. For the rare user who _wants_ this ugly behavior, set a `trust_server_pasv_ipv4_address` attribute on your `ftplib.FTP` instance to True.. (cherry picked from commit 0ab152c6b5d95caa2dc1a30fa96e10258b5f188e) Co-authored-by: Gregory P. Smith <greg@krypto.org> (cherry picked from commit 664d1d16274b47eea6ec92572e1ebf3939a6fa0c)
* [3.7] bpo-43293: Doc: move note about GIL to top of threading module ↵Guanzhong Chen2021-02-261-12/+12
| | | | | | | | | | | | | (GH-24622) (#24642) The note about the GIL was buried pretty deep in the threading documentation, and this made it hard for first time users to discover why their attempts at using threading to parallelizing their application did not work. In this commit, the note is moved to the top of the module documention for visibility.. (cherry picked from commit 32181be6081f6c70a1e0bd0540050805c8e88e83) Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
* Add a warning block around the get_referrers() documentation (GH-24511) ↵Miss Islington (bot)2021-02-161-4/+5
| | | | | | | (GH-24544) (cherry picked from commit 813db24f7c2c536d587d1832c3c52b44fa9e242e) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* [3.7] bpo-42967: only use '&' as a query string separator (GH-24297) (GH-24531)Senthil Kumaran2021-02-154-5/+53
| | | | | | | | | | | | | | bpo-42967: [security] Address a web cache-poisoning issue reported in urllib.parse.parse_qsl(). urllib.parse will only us "&" as query string separator by default instead of both ";" and "&" as allowed in earlier versions. An optional argument seperator with default value "&" is added to specify the separator. Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Co-authored-by: Adam Goldschmidt <adamgold7@gmail.com> (cherry picked from commit fcbe0cb04d35189401c0c880ebfb4311e952d776)
* Bring Python into the new year. (GH-24036) (GH-24052)Miss Islington (bot)2021-01-012-2/+2
| | | | | (cherry picked from commit de6f20a6de48d63066b2cf5b317f50629f01d74a) Co-authored-by: Dong-hee Na <donghee.na@python.org>
* bpo-17140: Document multiprocessing's ThreadPool (GH-23812) (GH-23836)Miss Islington (bot)2020-12-181-0/+40
| | | | | | | | Up until now, the `multiprocessing.pool.ThreadPool` class has gone undocumented, despite being a public class in multiprocessing that is included in `multiprocessing.pool.__all__`. (cherry picked from commit 84ebcf271a2cc8bfd1762acb279502b8b6ef236e) Co-authored-by: Matt Wozniski <mwozniski@bloomberg.net>
* [3.7] Remove 3.5 from Doc version switcher in master. (GH-22886) (#22890)larryhastings2020-10-222-2/+0
| | | (cherry picked from commit 283f9a253b4ff4df728558205629b3bb3af6e47f)
* bpo-41455: Provide a link to how the third generation is collected in the GC ↵Miss Islington (bot)2020-08-121-3/+3
| | | | | | | | docs (GH-21703) (GH-21788) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com> (cherry picked from commit 82ca8fada15b121866530f2cdac1b7055be4a244) Co-authored-by: Yaroslav Pankovych <31005942+P-Alban@users.noreply.github.com>
* bpo-41475: Fix note in "What's new in 3.7" (GH-21733) (GH-21835)Miss Islington (bot)2020-08-121-1/+1
| | | | | (cherry picked from commit 76643c10ede2813ca921464fe839e81caee21a84) Co-authored-by: Ram Rachum <ram@rachum.com>
* bpo-40204: Pin Sphinx version to 2.3.1 in Doc/MakefileNed Deily2020-06-171-1/+1
|
* [3.7] bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) ↵Miss Islington (bot)2020-06-131-1/+1
| | | | | | | | | | (GH-20861) (cherry picked from commit dea3223740127ac13f984c1d38f127ab6701af44) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Automerge-Triggered-By: @brettcannon
* bpo-40025: Require _generate_next_value_ to be defined before members (GH-19762)Miss Islington (bot)2020-06-111-0/+4
| | | | require `_generate_next_value_` to be defined before members (cherry picked from commit d9a43e20facdf4ad10186f820601c6580e1baa80)
* [3.7] bpo-40895: Update weakref documentation to remove old warnings ↵Antoine Pitrou2020-06-101-14/+0
| | | | | | | | | | | | | | | | | (GH-20687) (GH-20793) The doccumentation at https://docs.python.org/3.10/library/weakref.html cautions that the `WeakKeyDictionary` and `WeakValueDictionary` are susceptible to the problem of dictionary mutation during iteration. These notes present the user with a problem that has no easy solution. I dug into the implementation and found that fortunately, Antoine Pitrou already addressed this challenge (10 years ago!) by introducing an `_IterationGuard` context manager to the implementation, which delays mutation while an iteration is in progress. I asked for confirmation and @pitrou agreed that these notes could be removed: https://github.com/python/cpython/commit/c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438. (cherry picked from commit 1642c0ef750f96664a98cadb09301d492098d2fb) Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* [3.7] Revert bpo-39576: docs: set context for decimal arbitrary precision ↵Stefan Krah2020-06-081-58/+8
| | | | | arithmetic (GH-20746) This reverts commit 00e45877e33d32bb61aa13a2033e3bba370bda4d.
* [3.7] Revert bpo-39576: Clarify the word size for the 32-bit build. (GH-20744)Stefan Krah2020-06-081-2/+2
| | | This reverts commit 24c570bbb82a7cb70576c253a73390accfa7ed78.
* bpo-22021: Update root_dir and base_dir documentation in shutil (GH-10367)Miss Islington (bot)2020-06-081-3/+47
| | | | | | | | Also added an example in shutil in order to make more clear how they are to be used. Initially reported by Weinan Li on bpo. (cherry picked from commit 7633371dace67aaa21eb4b86f889441571ec4167) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* Fix spacing in docs for tarfile (GH-20629)Miss Islington (bot)2020-06-041-1/+1
| | | | | | | | | | | | | | | | | | | | Before ``` content.txt is 42 bytes in size and isa regular file. folder is 420 bytes in size and isa directory. magic is 4200 bytes in size and issomething else. ``` After: ``` content.txt is 42 bytes in size and is a regular file. folder is 420 bytes in size and is a directory. magic is 4200 bytes in size and is something else. ``` Automerge-Triggered-By: @orsenthil (cherry picked from commit 7a280197f4162e5fcdde6f34701a9fa6e669190d) Co-authored-by: Harsha Laxman <HarshaLaxman@users.noreply.github.com>
* Ensure correct version of Sphinx is used for Windows builds (GH-20582)Miss Islington (bot)2020-06-011-1/+1
| | | | | (cherry picked from commit fe5dd78182dbf4937bcc2b113ca7526bfad0192b) Co-authored-by: Steve Dower <steve.dower@python.org>
* bpo-40831: Remove an incorrect statement in the Windows docs (GH-20570)Miss Islington (bot)2020-06-011-3/+1
| | | | | (cherry picked from commit c8966667bbdb284c3780ef6cec8a3870935a6bb7) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40798: Generate a different message for already removed elements (GH-20483)Miss Islington (bot)2020-05-302-2/+12
| | | | | (cherry picked from commit 735d902b363b759df9ff00e58bbf4f7e2bde78cd) Co-authored-by: Florian Dahlitz <f2dahlitz@freenet.de>
* closes bpo-29017: Update the bindings for Qt information with PySide2 (GH-20149)Miss Islington (bot)2020-05-301-5/+6
| | | | | | Reference to PySide has been removed has it is for Qt 4, which has reached end of life. (cherry picked from commit 4649202ea75d48e1496e99911709824ca2d3170e) Co-authored-by: Samuel Gaist <samuel.gaist@idiap.ch>
* Improve IO tutorial's "Old string formatting" section (GH-16251)Miss Islington (bot)2020-05-281-5/+5
| | | | | | | | * Use a more universal explanation of string interpolation rather than specifically referencing sprintf(), which depends on the reader having a C background. Co-authored-by: Kyle Stanley <aeros167@gmail.com> (cherry picked from commit eaca2aa117d663acf8160a0b4543ee2c7006fcc7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.7] bpo-38580: Document that select() accepts iterables, not just ↵Tal Einat2020-05-261-3/+3
| | | | | | | sequences (GH-16832) (cherry picked from commit 372ee27d4958302dac7ad6a8711f6fd04771b2e6) Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
* bpo-39301: State that floor division is used for right shift operations ↵Miss Islington (bot)2020-05-261-4/+2
| | | | | | | | | | | | (GH-20347) (GH-20416) * bpo-39301: State that floor division is used for right shift operations * Remove "without overflow check" (cherry picked from commit af7553ac95a96713be847dd45bc5a8aeb0a75955) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40439: Update broken link in lexical analysis docs (GH-20184)Miss Islington (bot)2020-05-231-1/+1
| | | | | | Automerge-Triggered-By: @csabella (cherry picked from commit af23f0d3cf19343512e6ca1fe1d46a5dbe425719) Co-authored-by: Matteo Bertucci <matteobertucci2004@gmail.com>
* [3.7] [doc] Remove references to obsolete BuildApplet on macOS (GH-20023) ↵Miss Islington (bot)2020-05-211-8/+2
| | | | | | | | | | (GH-20306) (cherry picked from commit 7864f11cdf12807555d62c7a132c191eb41ecc02) Co-authored-by: Andre Delfino <adelfino@gmail.com> Automerge-Triggered-By: @ned-deily
* [3.7] Doc: Python 3.10 in sidebar and version switcher. (GH-20209) (GH-20223)Miss Islington (bot)2020-05-192-2/+4
| | | | | | | | (cherry picked from commit 19e3e0026417caa92ffe21a67157363b45da9aa2) Co-authored-by: Julien Palard <julien@palard.fr> Automerge-Triggered-By: @JulienPalard
* bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145)Miss Islington (bot)2020-05-191-4/+8
| | | | | (cherry picked from commit 46545000c2a30b46aed717b546bc09e5bae7148f) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* Doc: change 'Posix' for 'POSIX' (GH-20001)Miss Islington (bot)2020-05-173-6/+6
| | | | | (cherry picked from commit 65460565df99fbda6a74b6bb4bf99affaaf8bd95) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) (#20099)Miss Islington (bot)2020-05-152-4/+5
| | | | | | | | | | | | * Document exec symbol for codeop.compile_command * Remove extra statements Co-authored-by: nanjekyejoannah <joannah.nanjekye@ibm.com> (cherry picked from commit 7ba1f75f3f02b4b50ac6d7e17d15e467afa36aac) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
* Make the first dataclass example more useful (GH-19994) (GH-19998)Miss Islington (bot)2020-05-081-0/+2
| | | | | | | (cherry picked from commit 2effef7453986bf43a6d921cd471a8bc0722c36a) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* bpo-40419: timeit CLI docs now mention 1,2,5,10,... trials instead of powers ↵Miss Islington (bot)2020-05-021-1/+2
| | | | | | | of 10 (GH-19752) (cherry picked from commit 766352320fd736e2c8ed545b4cc57563f61a0b9d) Co-authored-by: Sander <svr003@gmail.com>
* [3.7] bpo-39435: Fix docs for pickle.loads (GH-18160). (GH-19844)Antoine Pitrou2020-05-011-2/+2
| | | | | | | (cherry picked from commit 289842ae820f99908d3a345f1f3b6d4e5b4b97fc) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: @pitrou
* bpo-40348: Fix typos in the programming FAQ (GH-19729)Miss Islington (bot)2020-04-271-2/+2
| | | | | (cherry picked from commit caf1aadf3d020f742ba3d7fcf678ca700224914b) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* [3.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros ↵Zachary Ware2020-04-272-1/+34
| | | | | | | | | | | | (GH-16607) (GH-19728) Adds a short description of `PyDoc_STRVAR` and `PyDoc_STR` to "Useful macros" section of C-API docs. Currently, there is [one lone mention](https://docs.python.org/3/c-api/module.html?highlight=pydoc_strvarGH-c.PyModuleDef) in the C-API reference, despite the fact that `PyDoc_STRVAR` is ubiquitous to `Modules/`. Additionally, this properly uses `c:macro` within `Doc/c-api/module.rst` to link.. (cherry picked from commit b54e46cb57ebac5c525a9a6be241412cd57bc935) Co-authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
* bpo-39285: Clarify example for PurePath.match (GH-19458)Miss Islington (bot)2020-04-191-1/+3
| | | | | | | | | | | | | | Fixes Issue39285 The example incorrectly returned True for match. Furthermore the example is ambiguous in its usage of PureWindowsPath. Windows is case-insensitve, however the underlying match functionality utilizes fnmatch.fnmatchcase. Automerge-Triggered-By: @pitrou (cherry picked from commit c12375aa0b838d34067efa3f1b9a1fbc632d0413) Co-authored-by: Tim Lo <timlo@users.noreply.github.com>
* bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)Miss Islington (bot)2020-04-181-3/+3
| | | | | | Automerge-Triggered-By: @pitrou (cherry picked from commit 482259d0dcf27714a84cf56b93977320bea7e093) Co-authored-by: Furkan Önder <furkantahaonder@gmail.com>
* Fix parameter names in assertIn() docs (GH-18829)Miss Islington (bot)2020-04-171-3/+3
| | | | | | The names "member" and "container" for the arguments are also used in the module and shown with the help() function, and are immediately understandable in this context, contrary to "first" and "second". (cherry picked from commit a388bbd3f129364c39843f63e92f08bc53c71905) Co-authored-by: Christoph Zwerschke <cito@online.de>
* [3.7] Improved documentation for `BUILD_CONST_KEY_MAP` (GH-19454) (GH-19496)Miss Islington (bot)2020-04-131-3/+3
| | | | | | | | (cherry picked from commit 85dd6bb1f61f7edcd6ac0b640a98644531690a0e) Co-authored-by: laike9m <laike9m@users.noreply.github.com> Automerge-Triggered-By: @zhangyangyu
* bpo-38501: Add a warning section to multiprocessing.Pool docs about resource ↵Miss Islington (bot)2020-04-111-1/+12
| | | | | | | managing (GH-19466) (cherry picked from commit 7ec43a73092d43c6c95e7dd2669f49d54b57966f) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-40204: Pin Sphinx version to 1.8.2 in Doc/Makefile (GH-19442) (GH-19443)Victor Stinner2020-04-091-1/+1
| | | (cherry picked from commit 37a257c0ae0d4ba746397ae7584db887b175ab24)
* Fix misinformation about NaN != NaN comparison (GH-19357) (GH-19384)Miss Islington (bot)2020-04-051-2/+3
| | | | | | (cherry picked from commit 810f68f1282c917fc1ad6af540a9f08524dfe310) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* bpo-40131: Fix source and target order in zipapp example (GH-19290) (GH-19340)Miss Islington (bot)2020-04-031-1/+1
| | | | | | (cherry picked from commit bd6a4c3d72828d3d0e13922e165998539d24f8bc) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40122: Updated documentation for dis.findlabels() (GH-19274)Miss Islington (bot)2020-04-031-1/+1
| | | | | (cherry picked from commit b74468e233a5137ff518e61eff65ca2d8833e38a) Co-authored-by: laike9m <laike9m@users.noreply.github.com>