Commit graph

25414 commits

Author SHA1 Message Date
Miss Islington (bot)
aed28b7feb
xml.dom.minidom docs: fix typo (GH-93437)
(cherry picked from commit 639e35108b)

Co-authored-by: Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
2022-06-30 10:15:00 -07:00
Miss Islington (bot)
b3d69ffeb3
GH-90908: Document asyncio.TaskGroup (GH-94359) (GH-94456)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit b6ec6d4041)

Co-authored-by: Guido van Rossum <guido@python.org>
2022-06-30 18:27:15 +02:00
Irit Katriel
ecc8e77cc1
[3.11] gh-89038: [doc] update dis.findlinestarts documentation for changes related to PEP-626 (GH-94247) (GH-94450)
(cherry picked from commit d68f2d27bb)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-30 16:18:30 +01:00
Miss Islington (bot)
5084a64d38
bpo-92336: [doc] clarify that the dfile is read by the traceback display code (GH-94409)
(cherry picked from commit 68fb03249f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-29 13:53:42 -07:00
Miss Islington (bot)
cbd562ff4e
Docs: Update SyntaxError message in REPL example for list comprehension (GH-93901) (GH-94425)
(cherry picked from commit 22b783aba0)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2022-06-29 19:22:11 +02:00
Mark Shannon
3b4f5ed168
[3.11] GH-93516: Backport GH-93769 (GH-94231)
* Store offset of first traceable instruction to avoid having to recompute it all the time when tracing.
2022-06-28 16:30:22 +01:00
Miss Islington (bot)
3937dbfaf8
gh-61585: Clarify import scope in modules tutorial (GH-93455) (GH-94373)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
(cherry picked from commit 4b854b7466)
2022-06-28 12:29:38 +02:00
Miss Islington (bot)
926bf235da
[3.11] gh-86404: [doc] Fix missing space in idle documentation. (GH-94366) (GH-94369)
This should have been spotted by sphinx-lint, tracked here:

https://github.com/sphinx-contrib/sphinx-lint/issues/39
(cherry picked from commit bc7f6fcdf1)


Co-authored-by: Julien Palard <julien@palard.fr>

Automerge-Triggered-By: GH:JulienPalard
2022-06-28 03:11:36 -07:00
Miss Islington (bot)
64365d0df9
gh-91860: Add docs for typing.dataclass_transform field specifier params (GH-94354) (GH-94372)
(cherry picked from commit 81ac9ac492)

Co-authored-by: Erik De Bonte <erikd@microsoft.com>
2022-06-28 12:10:42 +02:00
Miss Islington (bot)
1d2c8ff38f
gh-82006: IDLE doc improvements (GH-94349)
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e08bf)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-06-27 16:24:08 -07:00
Irit Katriel
575997af62
[3.11] gh-85023: [doc] clarify parameters vs arguments explanation in FAQ (GH-94282) (GH-94311)
(cherry picked from commit d71f5adc41)

Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>

Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>
2022-06-26 23:00:52 +01:00
Irit Katriel
ad23df97ed
[3.11] [doc] fix typo in reference to tp_descr_get and tp_descr_set (GH-94140) (GH-94293)
(cherry picked from commit 32d595fdcd)

Co-authored-by: Max Bachmann <kontakt@maxbachmann.de>

Co-authored-by: Max Bachmann <kontakt@maxbachmann.de>
2022-06-26 11:11:19 +01:00
Miss Islington (bot)
4ec1f8d643
gh-70474: [doc] fix wording of GET_ANEXT doc (GH-94048)
(cherry picked from commit 9af6b75298)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-25 15:51:19 -07:00
Miss Islington (bot)
8b77681469
bpo-39971: Change examples to be runnable (GH-32172)
(cherry picked from commit c57a1c76d7)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-06-25 13:59:43 -07:00
Erlend Egeberg Aasland
0a1517dc41
[3.11] gh-90016: Reword sqlite3 adapter/converter docs (GH-93095) (#94272)
Also add adapters and converter recipes.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com.
(cherry picked from commit bd3c1c187e)
2022-06-25 22:55:17 +02:00
Miss Islington (bot)
251193e7fb
Docs: Remove Provides [...] from multiprocessing.shared_memory description (GH-92761)
(cherry picked from commit a91ffcf3fa)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-24 10:15:25 -07:00
Ken Jin
852b4d4bcd
[3.11] gh-93382: Cache result of PyCode_GetCode in codeobject (GH-93383) (#93493)
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
2022-06-23 17:24:49 +01:00
Julien Palard
5a692ca5d2
[3.11] gh-86404: [doc] Fix missing backtick and double target name. (GH-94120) (GH-94159)
(cherry picked from commit 11e865c74b)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-06-23 11:13:11 +02:00
Miss Islington (bot)
321acd4138
gh-91456: [Enum] Deprecate default auto() behavior with mixed value types (GH-91457)
When used with plain Enum, auto() returns the last numeric value assigned, skipping any incompatible member values (such as strings); starting in 3.13 the default auto() for plain Enums will require all the values to be of compatible types, and will return a new value that is 1 higher than any existing value.

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
(cherry picked from commit fb1e9506c1)

Co-authored-by: Oscar R <89599049+oscar-LT@users.noreply.github.com>
2022-06-22 23:46:33 -07:00
Miss Islington (bot)
00a25f87f3
Closes gh-94152: Update pyvideo.org URL (GH-94075)
The URL is now https://pyvideo.org, which uses HTTPS and avoids a redirect.
(cherry picked from commit 7c439dca13)

Co-authored-by: partev <petrosyan@gmail.com>
2022-06-22 20:43:02 -07:00
Miss Islington (bot)
5bca4bba98
gh-94114: Remove obsolete reference to python.org mirrors (GH-94115)
* gh-94114
(cherry picked from commit 8661c5053f)

Co-authored-by: partev <petrosyan@gmail.com>
2022-06-22 10:05:04 -07:00
Mark Shannon
3ece6e6feb
[3.11] GH-93516: Backport GH-93769: Speedup line number checks when tracing (GH-94127)
Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
2022-06-22 16:32:02 +01:00
Miss Islington (bot)
c1bfff4f6b
gh-74696: Do not change the current working directory in shutil.make_archive() if possible (GH-93160) (GH-94105)
It is no longer changed when create a zip or tar archive.

It is still changed for custom archivers registered with shutil.register_archive_format()
if root_dir is not None.

Co-authored-by: Γ‰ric <merwok@netwok.org>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fda4b2f063)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-06-22 11:18:15 +02:00
Miss Islington (bot)
331e24455a
bpo-30535: [doc] state that sys.meta_path is not empty by default (GH-94098) (GH-94099)
Co-authored-by: Windson yang <wiwindson@outlook.com>
(cherry picked from commit 6575841266)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-21 23:04:51 +01:00
Miss Islington (bot)
41964de01b
gh-92611: Add details on replacements for cgi utility funcs (GH-92792) (GH-93967)
Per [suggestions on a Discourse thread](https://discuss.python.org/t/pep-594-take-2-removing-dead-batteries-from-the-standard-library/13508/51), discussed in GH-92611 and as a followup to PR GH-92612 , this PR add additional specific per-function replacement information for the utility functions in the `cgi` module deprecated by PEP 594 (PEP-594).

(cherry picked from commit 71354adff0)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-06-21 14:51:27 -07:00
Miss Islington (bot)
736f545cd3
Tutorial: specify match cases don't fall through (GH-93615) (GH-94083)
(cherry picked from commit dd5cf84f24)

Co-authored-by: max <36980911+pr2502@users.noreply.github.com>
2022-06-21 21:52:47 +02:00
Łukasz Langa
c76e6f745c
[3.11] gh-93240: clarify wording in IO tutorial (GH-93276) (GH-94082)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit 51d673176a)

Co-authored-by: paulreece <96156234+paulreece@users.noreply.github.com>
2022-06-21 21:51:15 +02:00
Łukasz Langa
49687b0054
[3.11] gh-93675: Fix typos in Doc/ (GH-93676) (GH-94079)
Closes GH-93675
(cherry picked from commit 830513754d)

Co-authored-by: luzpaz <luzpaz@users.noreply.github.com>
2022-06-21 21:22:27 +02:00
Miss Islington (bot)
63e127f33d
gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)
(cherry picked from commit f62ff97f31)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-21 21:06:05 +02:00
Miss Islington (bot)
cc42716275
gh-86986: ο»Ώο»ΏDrop compatibility support for Sphinx 2 (GH-93737)
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
(cherry picked from commit 0efe3a1636)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-21 10:50:47 -07:00
Miss Islington (bot)
e6ad59934e
gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-92754)
(cherry picked from commit 61f24e7885)

Co-authored-by: Matthias KΓΆppe <mkoeppe@math.ucdavis.edu>
2022-06-20 07:14:47 -07:00
Victor Stinner
96254a9acd
gh-93937, C API: Move PyFrame_GetBack() to Python.h (#93938) (#94000)
Move the follow functions and type from frameobject.h to pyframe.h,
so the standard <Python.h> provide frame getter functions:

* PyFrame_Check()
* PyFrame_GetBack()
* PyFrame_GetBuiltins()
* PyFrame_GetGenerator()
* PyFrame_GetGlobals()
* PyFrame_GetLasti()
* PyFrame_GetLocals()
* PyFrame_Type

Remove #include "frameobject.h" from many C files. It's no longer
needed.

(cherry picked from commit 27b9894033)
2022-06-20 15:47:41 +02:00
Miss Islington (bot)
b99f398bfb
gh-61162: Clarify sqlite3 connection context manager docs (GH-93890)
Explicitly note that transactions are only closed if there is an open
transation at `__exit__`, and that transactions are not implicitly
opened during `__enter__`.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:erlend-aasland
(cherry picked from commit 8e08978141)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-19 13:27:46 -07:00
Miss Islington (bot)
8b068c4b0c
gh-93925: Improve clarity of sqlite3 commit/rollback, and close docs (GH-93926)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 6446592c89)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-06-19 12:44:48 -07:00
Miss Islington (bot)
0c826d3623
What's new in 3.10: fix link to issue (GH-93968)
* What's new in 3.10: fix link to issue

* What's new in 3.10: fix link to GH issue

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 59c1b33805)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-06-19 02:12:06 -07:00
Kumar Aditya
5ee86d4306
gh-91877: Fix WriteTransport.get_write_buffer_{limits,size} docs (#92338) (#93806)
- Amend docs for WriteTransport.get_write_buffer_limits
- Add docs for WriteTransport.get_write_buffer_size

Co-authored-by: Sanket Shanbhag <TechieBoy@users.noreply.github.com>
2022-06-17 10:18:00 +02:00
Miss Islington (bot)
40c257d64f
gh-93857: Fix broken audit-event targets in sqlite3 docs (GH-93859)
Corrected targets for the following audit-events:

- sqlite3.enable_load_extension => sqlite3.Connection.enable_load_extension
- sqlite3.load_extension => sqlite3.Connection.load_extension
(cherry picked from commit ce4d11f98b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 07:09:37 -07:00
Miss Islington (bot)
528569319f
gh-87260: Update sqlite3 signature docs to reflect actual implementation (GH-93840)
Align the docs for the following methods with the actual implementation:

- sqlite3.complete_statement()
- sqlite3.Connection.create_function()
- sqlite3.Connection.create_aggregate()
- sqlite3.Connection.set_progress_handler()
(cherry picked from commit d31834688b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 03:35:48 -07:00
Erlend Egeberg Aasland
9775ac3f07
[3.11] gh-89018: Improve documentation of sqlite3 exceptions (GH-27645) (#93836)
- Order exceptions as in PEP 249
- Reword descriptions, so they match the current behaviour

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit bb0b768946)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 11:36:55 +02:00
Miss Islington (bot)
cde0dadd34
gh-93183: Adjust wording in socket docs (GH-93832)
package => packet

Co-authored-by: Victor Norman
(cherry picked from commit cdd3984307)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 01:44:14 -07:00
Miss Islington (bot)
cbfbe248e3
gh-90300: split --help output into separate options (GH-30331)
Make --help output shorter and add new help options.

--help-env, --help-xoptions and --help-all command-line options are
added to complement --help.
(cherry picked from commit 8aa9d40b00)

Co-authored-by: Γ‰ric <earaujo@caravan.coop>
2022-06-14 12:15:42 -07:00
Miss Islington (bot)
8dc5df4e21
[3.11] gh-91162: Support splitting of unpacked arbitrary-length tuple over TypeVar and TypeVarTuple parameters (alt) (GH-93412) (GH-93746)
For example:

  A[T, *Ts][*tuple[int, ...]] -> A[int, *tuple[int, ...]]
  A[*Ts, T][*tuple[int, ...]] -> A[*tuple[int, ...], int]
(cherry picked from commit 3473817106)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-06-14 21:15:56 +03:00
Miss Islington (bot)
536af65e96
Change list to view object (GH-93661)
(cherry picked from commit 5d8e7a1240)

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
2022-06-11 04:20:52 -07:00
Miss Islington (bot)
2e0e3ce0a1
gh-86404: [doc] A make sucpicious false positive. (GH-93710)
(cherry picked from commit bc3b31ea77)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-06-11 04:06:44 -07:00
Miss Islington (bot)
36ece2effb
gh-90153: whatsnew: "z" option in format spec (GH-93624)
Add what's new entry for PEP 682 in Python 3.11.
(cherry picked from commit 010284b46b)

Co-authored-by: John Belmonte <john@neggie.net>
2022-06-11 03:14:24 -07:00
Miss Islington (bot)
3a202de3bb
gh-91317: Document that Path does not collapse initial // (GH-32193)
Documentation for `pathlib` says:

> Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:

However, it omits that initial double slashes also aren't collapsed.

Later, in documentation of `PurePath.drive`, `PurePath.root`, and `PurePath.name` it mentions UNC but:

- this abbreviation says nothing to a person who is unaware about existence of UNC (Wikipedia doesn't help either by [giving a disambiguation page](https://en.wikipedia.org/wiki/UNC))
- it shows up only if a person needs to use a specific property or decides to fully learn what the module provides.

For context, see the BPO entry.
(cherry picked from commit 78f1a43694)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-10 16:07:19 -07:00
Miss Islington (bot)
62cae22c0d
gh-93391: fix typo in array docs (GH-93392) (GH-93394)
Fixes GH-93391

(cherry picked from commit fc694364cc)

Co-authored-by: ynfle <23086821+ynfle@users.noreply.github.com>
2022-06-10 16:12:51 +02:00
Miss Islington (bot)
cc6149fe15
πŸ“ Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) (GH-93399)
This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
(cherry picked from commit 8241a6971e)

Co-authored-by: Noah Kantrowitz <noah@coderanger.net>
2022-06-10 16:11:15 +02:00
Miss Islington (bot)
f0a89e6507
gh-93372: Fix typo in os.rename documentation (GH-93401) (GH-93403)
(cherry picked from commit e7aab7c92a)

Co-authored-by: Wei-Ting Yang <74453331+Yang-Wei-Ting@users.noreply.github.com>
2022-06-10 16:10:14 +02:00
Miss Islington (bot)
25444124e3
gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) (GH-93604)
Nowadays everything that *is* in the Limited API has a note added
automatically.
These notes could mislead people to think that these functions
could never be added to the limited API. Remove them.

(cherry picked from commit 2c3fe5eeb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2022-06-10 16:04:23 +02:00