summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* [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 - 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-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-152-5/+27
| | | | | | | | | | | | | | 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)
* 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>
* 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>
* [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>
* 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>
* [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-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-172-5/+5
| | | | | (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-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-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>
* bpo-40094: Enhance os.WIFEXITED documentation (GH-19244) (GH-19278)Miss Islington (bot)2020-04-011-10/+24
| | | | | (cherry picked from commit 7c72383f95b0cdedf390726069428d7b69ed2597) Co-authored-by: Victor Stinner <vstinner@python.org>
* Document most common signals (GH-19245) (GH-19258)Victor Stinner2020-03-311-0/+106
| | | | | | Document individual signals (only the most common signals): description, default action, availability. (cherry picked from commit 400e1dbcad93061f1f7ab4735202daaa5e731507)
* fix comma location in various places (GH-19233)Miss Islington (bot)2020-03-305-6/+6
| | | | | (cherry picked from commit c49016e67c3255b37599b354a8d7995d40663991) Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com>
* bpo-19698: Document when importlib.machinery.FrozenImporter gained ↵Miss Islington (bot)2020-03-261-0/+4
| | | | | | | | | spec-related methods (GH-19158) (GH-19165) (cherry picked from commit 302e5a8f79514fd84bafbc44b7c97ec636302322) Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com> Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com>
* bpo-40013: Clarify documentation of restval in csv.DictReader (GH-19099) ↵Miss Islington (bot)2020-03-251-1/+2
| | | | | | | | (GH-19142) (cherry picked from commit 4b3252cb764807fdb3a661b458d43e4af55cf4df) Co-authored-by: Juhana Jauhiainen <juhana.jauhiainen@gmail.com>
* [3.7] bpo-39652: Truncate the column name after '[' only if PARSE_COLNAMES ↵Serhiy Storchaka2020-03-211-3/+4
| | | | | | is set. (GH-18942). (GH-19104) (cherry picked from commit b146568dfcbcd7409c724f8917e4f77433dd56e4)
* bpo-39797 Changes to socketserver.BaseServer's shutdown() method. (GH-18929)Miss Islington (bot)2020-03-201-0/+2
| | | | | | Automerge-Triggered-By: @ned-deily (cherry picked from commit 2de7ac97981c30e9c1001b05a771f52a41772c54) Co-authored-by: amaajemyfren <32741226+amaajemyfren@users.noreply.github.com>
* Link to list of keywords in the laguage reference (GH-18024)Miss Islington (bot)2020-03-141-5/+6
| | | | | (cherry picked from commit 33238ec2af379e837cabc3945db5df8e23bf43e9) Co-authored-by: Борис Верховский <boris.verk@gmail.com>
* bpo-39677: dis: rename the operand of MAKE_FUNCTION from `argc` to `flags` ↵Miss Islington (bot)2020-03-141-1/+1
| | | | | | | for 3.6+ (GC-18550) (cherry picked from commit 6672c16b1d7f83789bf3a2016bd19edfd3568e71) Co-authored-by: Taine Zhao <twshere@outlook.com>
* Fix syntax error in an example in the ast documentation and sync docstrings ↵Miss Islington (bot)2020-03-121-1/+1
| | | | | | | (GH-18946) (cherry picked from commit c00c86b90443dbf3534cc4786a0b42b58db6e8af) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* tracemalloc: 'pretty top' example no longer changes the filename (GH-18903)Miss Islington (bot)2020-03-101-3/+1
| | | | | | | | I've used this recipe a couple times and the filename editing has always been less than useful and something I've removed. This is because many modules end up losing which package they are located in, e.g. `util/date.py`. (cherry picked from commit d06eec218eac81225f9017951cddfc211fed9325) Co-authored-by: Adam Johnson <me@adamj.eu>
* bpo-39852: IDLE 'Go to line' deletes selection, updates status (GH-18801)Miss Islington (bot)2020-03-081-1/+3
| | | | | | | | It appears standard that moving the text insert cursor away from a selection clears the selection. Clearing prevents accidental deletion of a possibly off-screen bit of text. The update is for Ln and Col on the status bar. (cherry picked from commit 2522db11df102be3baf25ce9e816ebe8ffdb7fcc) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* IDLE doc: improve Startup failure subsection. (GH-18771)Miss Islington (bot)2020-03-061-7/+10
| | | | | | | | Eliminate repeat of 'Options', reported by Jules Lasne, and improve wording elsewhere. Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit ce305d641074931e4e790f7a83e28f74910644e5) Co-authored-by: Jules Lasne (jlasne) <jules.lasne@gmail.com>
* [3.7] bpo-39808: Improve docs for pathlib.Path.stat() (GH-18719) (GH-18782)Miss Islington (bot)2020-03-041-1/+1
| | | | | | | | (cherry picked from commit 67152d0ed670227b61b5df683655b196ab04ca1a) Co-authored-by: Brett Cannon <54418+brettcannon@users.noreply.github.com> Automerge-Triggered-By: @brettcannon
* Fix misleading statement about mixed-type numeric comparisons (GH-18615) ↵Miss Islington (bot)2020-03-031-2/+4
| | | | | | | | (GH-18737) (cherry picked from commit 9f1cb1bb49476246de5d9ed5fe680301cf7f7571) Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
* [3.7] bpo-39794: Add --without-decimal-contextvar (GH-18702)Stefan Krah2020-02-291-3/+12
| | | | | | | * bpo-39794: Add --without-decimal-contextvar (#18702) (cherry picked from commit 815280eb160af637e1347213659f9236adf78f80)
* bpo-13790: Change 'string' to 'specification' in format doc (GH-18690)Miss Islington (bot)2020-02-281-2/+2
| | | | | (cherry picked from commit 916895f93905f8b8dad677cceff501833f5a633a) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* bpo-39654: Update pyclbr doc to reflect additional information returned ↵Miss Islington (bot)2020-02-241-3/+6
| | | | | | | | | | | (GH-18528) Full nested function and class info makes it a module browser. Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit aea045adb8c90394264908670cbc495c5a41b65e) Co-authored-by: Hakan Çelik <hakancelik96@outlook.com>
* bpo-39576: Clarify the word size for the 32-bit build. (GH-18616) (#18617)Miss Islington (bot)2020-02-231-2/+2
| | | | | | | (cherry picked from commit b76518d43fb82ed9e5d27025d18c90a23d525c90) Authored-by: Stefan Krah <skrah@bytereef.org>
* bpo-39576: docs: set context for decimal arbitrary precision arithmetic ↵Miss Islington (bot)2020-02-211-8/+58
| | | | | | | (GH-18594) (#18596) (cherry picked from commit a025d4ca99fb4c652465368e0b4eb03cf4b316b9) Authored-by: Stefan Krah <skrah@bytereef.org>