Commit graph

25977 commits

Author SHA1 Message Date
Miss Islington (bot)
fe828ec709
gh-91081: Add note on WeakKeyDictionary behavior when deleting a replaced entry (GH-91499)
(cherry picked from commit c615286e85)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Pieter Eendebak <P.T.eendebak@tudelft.nl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-20 19:34:17 -08:00
Miss Islington (bot)
23fa1667b3
gh-99991: improve docs on str.encode and bytes.decode (GH-100198)
(cherry picked from commit a2bb3b7f9d)

Co-authored-by: Bisola Olasehinde <horlasehinde@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-20 18:12:53 -08:00
Miss Islington (bot)
1332fdabba
Clarify that every thread has its own default context in contextvars (GH-99246)
(cherry picked from commit cb60b6131b)

Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2022-12-20 03:44:55 -08:00
Miss Islington (bot)
cfa78ecc12
gh-69929: re docs: Add more specific definition of \w (GH-92015)
(cherry picked from commit 36a0b1d0dd)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-12-19 19:14:52 -08:00
Raymond Hettinger
09186676cf
[3.11] GH-98363: Update batched() recipe in docs to match 3.12 (#100323) 2022-12-17 19:10:03 -06:00
Miss Islington (bot)
bf0a334c4e
Docs: Use PY_VERSION_HEX for version comparison (GH-100179)
(cherry picked from commit 0264f634f7)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-12-16 23:49:49 -08:00
Miss Islington (bot)
370498b12e
gh-97909: Fix markup for PyMethodDef members (GH-100089)
(cherry picked from commit 8edcb30c3f)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-16 23:19:45 -08:00
Miss Islington (bot)
e3d85783e5
Document that zipfile's pwd parameter is a bytes object (GH-100209)
(cherry picked from commit 5ee7eb9deb)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2022-12-16 22:54:33 -08:00
Miss Islington (bot)
4c810f92ba
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)
(cherry picked from commit 5234e1cbea)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
2022-12-16 11:14:28 -08:00
Miss Islington (bot)
138c2e6f3f
[3.11] "Compound statement" docs: Fix with-statement step indexing (GH-100286) (GH-100300)
Back in commit 226e6e7d43
an item was added to the list, renumbering all the rest of the
items, but the forward-reference wasn't updated to match.
(cherry picked from commit f23236a92d)

Co-authored-by: Frank Dana <ferdnyc@gmail.com>
2022-12-16 11:01:24 -08:00
Miss Islington (bot)
9d2dcbbccd
[3.11] Remove uninformative itertools recipe (GH-100253) (GH-100275) 2022-12-15 12:47:58 -06:00
Miss Islington (bot)
cb1001ce23
gh-100248: Add missing ssl_shutdown_timeout parameter in asyncio docs (GH-100249)
(cherry picked from commit 9663853800)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2022-12-14 09:07:36 -08:00
Miss Islington (bot)
cd4166fec2
GH-100206: use versionadded for the addition of sysconfig.get_default_scheme (GH-100207)
(cherry picked from commit d3ea82aaf9)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2022-12-13 03:02:41 -08:00
Miss Islington (bot)
60383a3cd8
Fix: typo (Indention) (GH-99904)
Example needed to be indented. Was trying to call a context manger `pr` (from ` with cProfile.Profile() as pr:`) wot perform ` pr.print_stats()` once it had already exited.
(cherry picked from commit 8711b59f7a)

Co-authored-by: jarrodcolburn <jcourtlandcolburn@gmail.com>
Automerge-Triggered-By: GH:AlexWaygood
2022-12-12 04:38:39 -08:00
Miss Islington (bot)
17bc55e043
clarify the 4300-digit limit on int-str conversion (GH-100175)
(cherry picked from commit 935ef59321)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2022-12-12 04:06:48 -08:00
Miss Islington (bot)
71b032635d
gh-70393: Clarify mention of "middle" scope (GH-98839)
(cherry picked from commit 70be5e42f6)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-11 20:25:06 -08:00
Miss Islington (bot)
593c5a0247
gh-100174: [Enum] Correct PowersOfThree example. (GH-100178)
Changed from multiples of 3 to powers of 3 to match the class name.
(cherry picked from commit 868bab0fdc)

Co-authored-by: Beweeted <Beweeted@users.noreply.github.com>
2022-12-11 15:30:25 -08:00
Miss Islington (bot)
606adb4b89
gh-99728: correct typo in datetime format codes documentation (GH-99750)
(cherry picked from commit d5f8a2b6ad)

Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
2022-12-10 02:29:04 -08:00
Miss Islington (bot)
9aca00341a
gh-100049: fix repr for mappingproxy in dictionary view example doc (GH-100052)
(cherry picked from commit 7c0fb71fbf)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-10 01:23:24 -08:00
Miss Islington (bot)
ecb16d5d63
gh-96250: Improve sqlite3 injection attack example (GH-99270)
(cherry picked from commit 41d4ac9da3)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-12-08 12:45:40 -08:00
Miss Islington (bot)
0274a3bc3b
Use sphinxext-opengraph to generate OpenGraph metadata (GH-99931)
(cherry picked from commit f49c735e52)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-08 09:34:52 -08:00
Serhiy Storchaka
3fae04b10e
[3.11] gh-93453: Only emit deprecation warning in asyncio.get_event_loop when a new event loop is created (#99949)
It no longer emits a deprecation warning if the current event loop was set.

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-12-06 16:15:44 +01:00
Miss Islington (bot)
235f5fd2ca
[3.11] gh-100001: Remove doc typo, add versionadded (GH-100042) (#100043)
(cherry picked from commit bed15f87ea)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-12-06 11:34:20 +01:00
Miss Islington (bot)
05031ee1f5
[Enum] Fix typos in the documentation (GH-99960)
(cherry picked from commit 2ae894b6d1)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-12-05 21:46:48 -08:00
Miss Islington (bot)
a726f747e6
gh-100001: Omit control characters in http.server stderr logs. (GH-100002)
Replace control characters in http.server.BaseHTTPRequestHandler.log_message with an escaped \xHH sequence to avoid causing problems for the terminal the output is printed to.
(cherry picked from commit d8ab0a4dfa)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-12-05 13:39:22 -08:00
Miss Islington (bot)
f3a58cece6
[3.11] dataclasses.rst: Prevent horizontal scrolling (gh-100025) (gh-100028)
dataclasses.rst: Prevent horizontal scrolling (gh-100025)
(cherry picked from commit 51ee0a29e9)

Co-authored-by: Ram Rachum <ram@rachum.com>

Co-authored-by: Ram Rachum <ram@rachum.com>
2022-12-05 13:59:34 -05:00
Miss Islington (bot)
7f2bcc7aaa
gh-93464: [Enum] Add versionchanged tag (GH-99997)
(cherry picked from commit e3a3863cb9)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-05 02:45:37 -08:00
Miss Islington (bot)
27218d0799
gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice and suggest other edits (GH-99784)
(cherry picked from commit bf26bdf6ac)

Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
2022-12-03 16:59:06 -08:00
Miss Islington (bot)
f4511d3ee9
[3.11] GH-98906 ``re` module: `search() vs. match()` section should mention `fullmatch()`` (GH-98916) (GH-99912)
GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916)

Mention fullmatch along with search and match.
(cherry picked from commit e0f91deb59)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-11-30 18:14:36 -05:00
Miss Islington (bot)
90701ebaf4
bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491)
(cherry picked from commit 9628136fac)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-11-30 11:53:04 -08:00
Miss Islington (bot)
d7c2e0a537
Docs: improve accuracy of socketserver reference (GH-24767)
(cherry picked from commit 052bc128ac)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-11-29 12:43:09 -08:00
Miss Islington (bot)
fbe388162b
whatsnew-3.10: Mention PEP 647 in the Release highlights section. (GH-99853)
Mention PEP 647 in the Release highlights section.

Also re-ordered the list so it matches the order in the details sections below.
(cherry picked from commit d74a58872c)

Co-authored-by: Yilei "Dolee" Yang <yileiyang@google.com>
2022-11-29 12:41:05 -08:00
Miss Islington (bot)
2e9ea7b44b
gh-90717: Update the documentation for the altchars paremeter in base64 library (GH-94187)
(cherry picked from commit 05dfc539c2)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
2022-11-29 08:29:03 -08:00
Miss Islington (bot)
a2b84bbf77
fnmatch docs: link to fnmatch.filter(), not builtins.filter() (GH-99819)
(cherry picked from commit ca3e611b1f)

Co-authored-by: Matthew Hughes <34972397+matthewhughes934@users.noreply.github.com>
2022-11-28 10:17:07 -08:00
Miss Islington (bot)
5dce4ab736
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)
These slots are marked "should be treated as read-only" in the
table at the start of the document.  That doesn't say anything about
setting them in the static struct.

`tp_bases` docs did say that it should be ``NULL`` (TIL!). If you
ignore that, seemingly nothing bad happens. However, some slots
may not be inherited, depending on which sub-slot structs are present.
(FWIW, NumPy sets tp_bases and is affected by the quirk -- though to
be fair, its DUAL_INHERIT code probably predates tp_bases docs, and
also the result happens to be benign.)

This patch makes things explicit.
It also makes the summary table legend easier to scan.

(cherry picked from commit 219696abb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 03:25:04 -08:00
Miss Islington (bot)
1e327059a3
bpo-41825: restructure docs for the os.wait*() family (GH-22356)
(cherry picked from commit 492dc02b01)

Co-authored-by: Georg Brandl <georg@python.org>
2022-11-28 01:48:52 -08:00
Miss Islington (bot)
f160996412
Docs: both sqlite3 "point examples" now adapt to str (GH-99823)
(cherry picked from commit 276643e207)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-11-27 13:21:00 -08:00
Miss Islington (bot)
366adc7c83
gh-91340: Document multiprocessing.set_start_method force parameter (GH-32339)
GH-91340

https://bugs.python.org/issue47184
(cherry picked from commit dfc2732a57)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
Automerge-Triggered-By: GH:kumaraditya303
2022-11-27 10:05:59 -08:00
Miss Islington (bot)
8bb7fdaee8
doc: Remove backslashes in doctest grammar docs (GH-29346)
(cherry picked from commit 22860dbbc8)

Co-authored-by: George Zhang <geetransit@gmail.com>
2022-11-26 22:46:33 -08:00
Miss Islington (bot)
4ce1a827db
bpo-43327: Fix the docs for PyImport_ImportFrozenModuleObject() (GH-24659)
The docs stated that PyImport_ImportFrozenModuleObject() returns a
new reference, but it actually returns an int.

(cherry picked from commit 62a5dc13e9)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-26 22:37:08 -08:00
Miss Islington (bot)
fe9957241a
gh-99795: Fix typo in importlib.resources.abc (GH-99796)
Changing TraversableReader to TraversableResources at one place of the documentation.

See GH-99795 for more details.
(cherry picked from commit 5f8898216e)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2022-11-26 10:12:23 -08:00
Miss Islington (bot)
f98322920e
[3.11] gh-99502: mention bytes-like objects as input in secrets.compare_digest (GH-99512) (#99791)
gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)

Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.
(cherry picked from commit 47d673d81f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-11-26 15:19:23 +05:30
Miss Islington (bot)
0006d9bf7b
Fix typo in __match_args__ doc (GH-99785)
A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again.
(cherry picked from commit a86d854522)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-11-25 16:10:48 -08:00
Miss Islington (bot)
00755196e3
[3.11] Fix misspelling in docs for http.HTTPMethod (GH-99376) (#99451)
Fix misspelling in docs for http.HTTPMethod (GH-99376)
(cherry picked from commit f0d12ca0e0)

Co-authored-by: Matt Harasymczuk <github.com@haras.pl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-11-25 18:26:50 -05:00
Miss Islington (bot)
f5fa17bef5
gh-64019: Have attribute table in inspect docs link to module attributes instead of listing them (GH-98116)
(cherry picked from commit 7d2dcc53d0)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Michael Anckaert <michael.anckaert@sinax.be>
2022-11-25 14:06:45 -08:00
Miss Islington (bot)
772fc63516
[3.11] gh-85073: Add some missing links to source (GH-99363) (#99586)
gh-85073: Add some missing links to source (GH-99363)

Add some missing links to source from Python docs
(cherry picked from commit 27d8dc2c9d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-11-25 23:19:40 +05:30
Miss Islington (bot)
5b7408490f
gh-96168: Add sqlite3 row factory how-to (GH-99507)
(cherry picked from commit 8749121b07)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-11-25 05:15:09 -08:00
Miss Islington (bot)
d279f38a71
Fix rendering of audioop license in Doc/license.rst (GH-99752)
Also some cosmetic blank line additions for consistency with the
formatting of the rest of the file.
(cherry picked from commit b5b3904f05)

Co-authored-by: Zachary Ware <zach@python.org>
2022-11-24 08:29:21 -08:00
Miss Islington (bot)
609273eb52
gh-99619: fix error in documentation of ExceptionGroup.derive() (GH-99621)
(cherry picked from commit 5d9183c7ad)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-11-23 03:08:22 -08:00
Miss Islington (bot)
b4ae5b76ed
[3.11] gh-99650 : Updated argparse docs (GH-99653) (GH-99705) 2022-11-22 14:17:20 -08:00