summaryrefslogtreecommitdiffstats
path: root/Doc/library
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] Docs: specify XML document name in xml.etree.elementtree example ↵Miss Islington (bot)2024-04-011-1/+1
| | | | | | | (GH-24223) (#117430) (cherry picked from commit 9dae05ee59eeba0e67af2a46f2a2907c9f8d7e4a) Co-authored-by: Moshe Kaplan <mosheekaplan@gmail.com>
* [3.11] Docs: add more links to PIPE in subprocess docs (GH-25416) (#117428)Miss Islington (bot)2024-04-011-5/+8
| | | | | (cherry picked from commit fc2071687b708598264a3403b7f9104667c1092f) Co-authored-by: Matthew Davis <7035647+mdavis-xyz@users.noreply.github.com>
* [3.11] GH-115986 Docs: promote pprint.pp usage as a default (GH-116614) ↵Miss Islington (bot)2024-03-241-15/+18
| | | | | | | (#117197) Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] gh-101760: Improve the imaplib.IMAP4 example (GH-101764) (#117192)Miss Islington (bot)2024-03-241-1/+1
| | | | | Co-authored-by: LilKS <1244886+LilKS@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] docs: fix over-linking in dataclasses.rst (GH-117005) (#117164)Carol Willing2024-03-221-78/+85
| | | | | | | | | | | | | | * docs: fix over-linking in dataclasses.rst (#117005) (cherry picked from commit 0907871d43bffb613cbd560224e1a9db13d06c06) * [3.11] docs: fix over-linking in dataclasses.rst (GH-117005) (cherry picked from commit 0907871d43bffb613cbd560224e1a9db13d06c06) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> --------- Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.11] gh-75988: Fix issues with autospec ignoring wrapped object ↵infohash2024-03-221-0/+120
| | | | | | | | | | | | | | | | | (GH-115223) (#117124) gh-75988: Fix issues with autospec ignoring wrapped object (#115223) * set default return value of functional types as _mock_return_value * added test of wrapping child attributes * added backward compatibility with explicit return * added docs on the order of precedence * added test to check default return_value (cherry picked from commit 735fc2cbbcf875c359021b5b2af7f4c29f4cf66d)
* [3.11] gh-101100: Fix Sphinx warnings in `library/pydoc.rst` (GH-116913) ↵Miss Islington (bot)2024-03-191-7/+7
| | | | | | (#117038) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] gh-116851: Remove "from ctypes import *" from a ctypes example ↵Miss Islington (bot)2024-03-161-1/+0
| | | | | | | | | (GH-116852) (GH-116906) It is confusing, because libc is not imported from ctypes, but defined in previous examples, which already contain the import. (cherry picked from commit 744c0777952f1e535d1192ee15b286aa67b61533) Co-authored-by: jnchen <caojingchen@live.com>
* [3.11] gh-90095: Ignore empty lines and comments in `.pdbrc` (GH-116834) ↵Miss Islington (bot)2024-03-151-1/+2
| | | | | | | | (#116855) gh-90095: Ignore empty lines and comments in `.pdbrc` (GH-116834) (cherry picked from commit a50cf6c3d76b34e2ee9f92a248f1b0df24e407f6) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
* [3.11] gh-98731: Improvements to the logging documentation (GH-101618) ↵Miss Islington (bot)2024-03-131-85/+67
| | | | | (GH-116733) (cherry picked from commit 7f418fb111dec325b5c9fe6f6e96076049322f02)
* [3.11] Docs: fix broken links (GH-116651) (#116701)Mariusz Felisiak2024-03-132-2/+2
| | | (cherry picked from commit 3f1b6efee95c06f8912bcea4031afacdbc0d5684)
* [3.11] gh-116535: Fix distracting "TypeError" in example code (gh-116538) ↵Miss Islington (bot)2024-03-091-2/+2
| | | | | | | | (gh-116552) gh-116535: Fix distracting "TypeError" in example code (gh-116538) (cherry picked from commit db8f423f58e336eb6180a70d9886b443d7203c2c) Co-authored-by: Declan <5962877+dec1@users.noreply.github.com>
* [3.11] GH-116218 Docs: Add availability information for the 'resource' ↵Miss Islington (bot)2024-03-091-0/+2
| | | | | | | | | | module (GH-116256) (#116534) GH-116218 Docs: Add availability information for the 'resource' module (GH-116256) Add availability data to 'resource' module Docs (cherry picked from commit 03f86b1b626ac5b0df1cc74d8f80ea11117aec8c) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>
* [3.11] gh-105535 Document potential performance trap during enum creation ↵Miss Islington (bot)2024-03-091-0/+7
| | | | | | | | | (GH-107119) (GH-116512) (cherry picked from commit 601f3a7b3391e9d219a8ec44a6c56d00ce584d2a) Co-authored-by: Nicolas A. Oyarzabal <79150521+nicky-eng@users.noreply.github.com> Co-authored-by: Ethan Furman <ethan@stoneleaf.us> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] gh-115664: Fix ordering of more versionadded and versionchanged ↵Serhiy Storchaka2024-03-0713-46/+33
| | | | | | | | directives (GH-116298) (GH-116450) (GH-116452) (cherry picked from commit 1e75fe146857b5e6624bd3281675cf20cc356273) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 808a77612fb89b125d25efac2788522a100e8a6d)
* [3.11] gh-115398: Expose Expat >=2.6.0 reparse deferral API (CVE-2023-52425) ↵Sebastian Pipping2024-03-062-0/+75
| | | | | | | | | | | | | | | | | | | | | | | | | (GH-115623) (#116268) Allow controlling Expat >=2.6.0 reparse deferral (CVE-2023-52425) by adding five new methods: - `xml.etree.ElementTree.XMLParser.flush` - `xml.etree.ElementTree.XMLPullParser.flush` - `xml.parsers.expat.xmlparser.GetReparseDeferralEnabled` - `xml.parsers.expat.xmlparser.SetReparseDeferralEnabled` - `xml.sax.expatreader.ExpatParser.flush` Based on the "flush" idea from #115138 (comment) . - Please treat as a security fix related to CVE-2023-52425. (cherry picked from commit 6a95676) (cherry picked from commit 73807eb) (cherry picked from commit eda2963) --------- Includes code suggested-by: Snild Dolkow <snild@sony.com> and by core dev Serhiy Storchaka. Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.11] gh-115986: Fix inaccuracies in pprint docs (GH-116104) (#116383)Miss Islington (bot)2024-03-051-2/+2
| | | | | | Amend wording after gh-116019 was merged. (cherry picked from commit e205c5cd8f1a49d0ef126123312ee8a40d1416b6) Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>
* [3.11] chore: fix typos (GH-116345) (#116375)Terry Jan Reedy2024-03-051-1/+1
| | | | | Co-authored-by: cui fliter <imcusg@gmail.com> (cherry picked from commit e7ba6e9dbe5433b4a0bcb0658da6a68197c28630)
* [3.11] gh-115777: Fix double versionadded directives (GH-116269) (GH-116362)Miss Islington (bot)2024-03-056-24/+8
| | | | | (cherry picked from commit 0064dfa0919cc93257c351a609f99461f6e4e3ac) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-104711: Add security warning to the CGIHTTPRequestHandler document ↵AN Long2024-03-041-0/+6
| | | | | (GH-115915) (cherry picked from commit dac8ff4c401f75e65a5eef1514f2d7987e63bbfe)
* [3.11] gh-116281: Remove wrong '\' from '\*' in some doc signatures ↵Terry Jan Reedy2024-03-032-2/+2
| | | | | | | | | (GH-116282) (#116289) gh-116281: Remove wrong '\' from '\*' in some doc signatures (#116282) (cherry picked from commit 4859ecb8609b51e2f6b8fb1b295e9ee0f83e1be6) Co-authored-by: HarryLHW 123lhw321@gmail.com
* [3.11] gh-116035: Document that both tzinfo and fold are ignored in ↵Miss Islington (bot)2024-03-011-2/+8
| | | | | | | | comparisons if tzinfo is the same (GH-116187) (GH-116217) This mostly restores information removed in c12240ed28aac6494750e00143bc550c4d6d8ad1 (GH-114749). (cherry picked from commit 05b04903a14279421ecdc6522b8202822de6ebb5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-115811: Update documentation to add some Logger attributes. ↵Miss Islington (bot)2024-03-011-0/+36
| | | | | (GH-116109) (GH-116186) (cherry picked from commit 3b6f4cadf19e6a4edd2cbbbc96a0a4024b395648)
* [3.11] gh-115881: Document feature_version limitations (#115980) (#116174)Shantanu2024-03-011-6/+9
|
* [3.11] Fix rendering of null character in ast.rst (GH-116080) (#116161)Miss Islington (bot)2024-02-291-1/+1
| | | | | | Fix rendering of null character in ast.rst (GH-116080) (cherry picked from commit c04a981ff414b101736688773dbe24f824ca32ce) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.11] gh-73580: Docs for tunnelling TLS through TLS (GH-22539) (GH-116150)Miss Islington (bot)2024-02-291-0/+3
| | | | | (cherry picked from commit 91c3c64237f56bde9d1c1b8127fdcb02a112b5a4) Co-authored-by: Carl Bordum Hansen <carl@bordum.dk>
* [3.11] Docs: mark up NotImplemented using the :data: role throughout the ↵Miss Islington (bot)2024-02-298-23/+23
| | | | | | | docs (GH-116135) (#116148) (cherry picked from commit dbe44f150cd161bd327ed662e527a4c93829fb3e) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.11] gh-115937: Remove implementation details from inspect.signature() ↵Miss Islington (bot)2024-02-291-3/+7
| | | | | | | | | | | docs (GH-116086) (#116107) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b642fc3089e4f98e4bf6b09dd362e6b27d) Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.11] GH-115986 Reorder pprint docs and amend some references (#116019) ↵Erlend E. Aasland2024-02-281-85/+89
| | | | | | | | | | | | | | | (#116064) (cherry picked from commit 6c1c94dc517b77afcebb25436a4b7b0d13b6eb4d) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout. Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>
* [3.11] doc: Use super() in subclassed JSONEncoder examples (GH-115565) ↵Miss Islington (bot)2024-02-281-2/+2
| | | | | | | | | | | (GH-116046) doc: Use super() in subclassed JSONEncoder examples (GH-115565) Replace calls to `json.JSONEncoder.default(self, obj)` by `super().default(obj)` within the examples of the documentation. (cherry picked from commit 647053fed182066d3b8c934fb0bf52ee48ff3911) Co-authored-by: Jan Max Meyer <jmm@phorward.de>
* [3.11] gh-115315: Update time.rst to include microseconds field (%f) in ↵Miss Islington (bot)2024-02-271-6/+16
| | | | | | | chart (GH-115316) (#115991) Co-authored-by: Tahoma Software <bacon@tahoma.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] Doc: Clarify the return type of Event.wait when timeout is used ↵Miss Islington (bot)2024-02-261-10/+7
| | | | | | | (GH-104168) (GH-115939) (cherry picked from commit 37f5d06b1bf830048c09ed967bb2cda945d56541) Co-authored-by: Phil Elson <pelson.pub@gmail.com>
* [3.11] gh-115921: Change 'equation' to 'expression' in random.rst ↵Miss Islington (bot)2024-02-261-1/+2
| | | | | | | | (GH-115927) (#115929) In uniform function entry. (cherry picked from commit de0b4f95cbfe1f868514029289597204074c05c8) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.11] gh-101100: Fix broken xrefs in fcntl module doc (GH-115691) (#115925)Carol Willing2024-02-261-15/+26
| | | | | | | | | | | | | | | | | | | | | | | | * clean up fcntl module doc * simplify * a few changes, based on suggestion by CAM-Gerlach * nitpick ignore for a couple other C functions mentioned in the fcntl module doc * more changes, especially related to LOCK_* constants * :data: back to :const: * Apply suggestions from code review --------- (cherry picked from commit 84a275c4a2c8a22d198c6f227d538e6b27bbb029) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.11] gh-103417: Fix the scheduler example (GH-111497) (GH-115909)Miss Islington (bot)2024-02-251-1/+1
| | | | | | | | Arguments to enterabs() are specified as Unix time. If the scheduler use the time.monotonic timer, the code will take decades to complete. (cherry picked from commit cb287d342139509e03a2dbe5ea2608627fd3a350) Co-authored-by: mauricelambert <50479118+mauricelambert@users.noreply.github.com>
* [3.11] Add an example of of custom `__repr__` (GH-112761) (#115901)Miss Islington (bot)2024-02-251-0/+10
| | | | | | | | | | Added to repr entry in Doc/library/functions.rst. --------- (cherry picked from commit 5770006ffac2abd4f1c9fd33bf5015c9ef023576) Co-authored-by: Oh seungmin <tmdals179@gmail.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* [3.11] Erase some unnecessary quotes on data model doc (GH-113521) (#115897)Miss Islington (bot)2024-02-251-1/+0
| | | | | | | Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug. (cherry picked from commit f7455864f22369cc23bf3428624f310305cac999) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
* [3.11] Update http.cookiejar document for cookie object attributes ↵Miss Islington (bot)2024-02-231-0/+5
| | | | | | | | (GH-101885) (#115834) Update http.cookiejar document for cookie object attributes (GH-101885) (cherry picked from commit a3859422d15d98892fd53499916bd424f841404f) Co-authored-by: NewUserHa <32261870+NewUserHa@users.noreply.github.com>
* [3.11] gh-54358: Clarify data chunking in pyexpat (GH-31629) (GH-115865)Miss Islington (bot)2024-02-231-2/+6
| | | | | | (cherry picked from commit 462a2fc09d9e5f7cdd3a8f2faed73e5bc2c93349) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Éric Araujo <merwok@netwok.org>
* [3.11] gh-115399: Document CVE-2023-52425 under "XML vulnerabilities" ↵Miss Islington (bot)2024-02-211-0/+13
| | | | | | | | (GH-115400) (GH-115761) Doc/library/xml.rst: Document CVE-2023-52425 under "XML vulnerabilities" (cherry picked from commit fbd40ce46e7335a5dbaf48a3aa841be22d7302ba) Co-authored-by: Sebastian Pipping <sebastian@pipping.org>
* [3.11] gh-112020: Document the meaning of empty bytes returned by ↵Miss Islington (bot)2024-02-201-2/+3
| | | | | | | socket.recv() (GH-112055) (GH-115723) (cherry picked from commit e71468ba4f5fb2da0cefe9e923b01811cb53fb5f) Co-authored-by: talcs <talh8787@gmail.com>
* [3.11] gh-115664: Fix versionadded and versionchanged directives in ↵Serhiy Storchaka2024-02-191-16/+15
| | | | | multiprocessing.rst (GH-115665) (GH-115682) (cherry picked from commit 8f602981ba95273f036968cfc5ac28fdcd1808fa)
* [3.11] gh-115664: Fix chronological ordering of versionadded and ↵Brian Schubert2024-02-195-15/+11
| | | | | | versionchanged directives (GH-115676) (#115681) Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
* [3.11] Fix typo in multiprocessing docs (GH-115650) (#115680)Miss Islington (bot)2024-02-191-1/+1
| | | | | (cherry picked from commit 57d31ec3598429789492e0b3544efaaffca5799f) Co-authored-by: Naglis Jonaitis <827324+naglis@users.noreply.github.com>
* [3.11] gh-115652: Fix indentation in the documentation of ↵Miss Islington (bot)2024-02-191-5/+5
| | | | | | | multiprocessing.get_start_method (GH-115658) (GH-115660) (cherry picked from commit d504968983c5cd5ddbdf73ccd3693ffb89e7952f) Co-authored-by: Daniel Haag <121057143+denialhaag@users.noreply.github.com>
* [3.11] Docs: Add explanation about little/big endian (GH-109841) (#115647)Miss Islington (bot)2024-02-191-0/+15
| | | | | | | | Docs: Add explanation about little/big endian (GH-109841) (cherry picked from commit 177b9cb52e57da4e62dd8483bcd5905990d03f9e) Co-authored-by: Simon A. Eugster <simon.eu@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.11] gh-115572: Move `codeobject.replace()` docs to the data model … ↵Kirill Podoprigora2024-02-181-7/+1
| | | | | | | | | | | | | | (#115632) * [3.11] gh-115572: Move `codeobject.replace()` docs to the data model (GH-115631) (cherry picked from commit 0c80da4c14d904a367968955544dd6ae58c8101c) Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com> * Remove note about copy.replace --------- Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com>
* [3.11] Document use of ANY in test assertions (GH-94060) (GH-115608)Miss Islington (bot)2024-02-171-0/+8
| | | | | (cherry picked from commit 04005f5021a17b191dae319faaadf1c942af3fe9) Co-authored-by: Thomas Grainger <tagrain@gmail.com>
* [3.11] gh-101699: Explain using Match.expand with \g<0> (GH-101701) (GH-115584)Miss Islington (bot)2024-02-171-1/+2
| | | | | | | | | | Update documentation for re library to explain that a backreference `\g<0>` is expanded to the entire string when using Match.expand(). Note that numeric backreferences to group 0 (`\0`) are not supported. (cherry picked from commit d2d78088530433f475d9304104bbc0dac2536edd) Co-authored-by: Stevoisiak <S.Vascellaro@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-87688: Amend SSLContext.hostname_checks_common_name docs ↵Miss Islington (bot)2024-02-171-1/+1
| | | | | | | (GH-100517) (GH-115595) (cherry picked from commit debb1386be024181c8c003c5cbf61608024aee09) Co-authored-by: Rami <72725910+ramikg@users.noreply.github.com>