Commit graph

11395 commits

Author SHA1 Message Date
Miss Islington (bot)
2b1cc33db0
[3.10] gh-100583: Improve the pydoc documentation (GH-100590) (#100607)
gh-100583: Improve the `pydoc` documentation  (GH-100590)
(cherry picked from commit 7223d50b97)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-12-29 21:45:13 +05:30
Miss Islington (bot)
4217fafeac
GH-100101: Clarify documentation of zip's strict option (GH-100103)
(cherry picked from commit cf1c098180)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2022-12-28 13:32:44 -08:00
Jelle Zijlstra
1ffc67265f
[3.10] gh-99535: Add test for inheritance of annotations and update documentation (GH-99990) (#100509)
(cherry picked from commit f5b7b19bf1)

Co-authored-by: MonadChains <monadchains@gmail.com>
2022-12-26 20:44:53 -08:00
Shantanu
a167365d85
[3.10] gh-92446: Improve argparse choices docs (GH-94627) (#100529)
Based on the definition of the collections.abc classes, it is more accurate to use "sequence" instead of "container" when describing argparse choices.

(cherry picked from commit ad3c99e521)

Co-authored-by: Guy Yagev <yourlefthandman8@gmail.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-26 01:10:48 -06:00
Miss Islington (bot)
ad8d2ef54f
gh-100472: Fix docs claim that compileall parameters could be bytes (GH-100473)
(cherry picked from commit 046cbc2080)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:29:41 -08:00
Miss Islington (bot)
0dea92409e
gh-100428: Make float documentation more accurate (GH-100437)
Previously, the grammar did not accept `float("10")`.
Also implement mdickinson's suggestion of removing the indirection.
(cherry picked from commit 2e1a9ce989)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-24 12:15:46 -08:00
Miss Islington (bot)
ecfe468a6e
gh-77771: Add enterabs example in sched (GH-92716)
(cherry picked from commit 0f6420640c)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-12-23 21:30:06 -08:00
Gregory P. Smith
88fe8d701a
[3.10] Correct CVE-2020-10735 documentation (GH-100306). (#100477)
(cherry picked from commit 1cf3d78c92)

Co-authored-by: Jeremy Paige <ucodery@gmail.com>
2022-12-23 18:08:27 -08:00
Miss Islington (bot)
561e15b857
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:24 -08:00
Miss Islington (bot)
b3d39c7599
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:11:20 -08:00
Miss Islington (bot)
a757c1b7d3
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:45:48 -08:00
Miss Islington (bot)
b81d1c3be3
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:48 -08:00
Miss Islington (bot)
697a07a854
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:53:20 -08:00
Miss Islington (bot)
958be792a7
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:15:12 -08:00
Miss Islington (bot)
f5f68ff192
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:03:22 -08:00
Miss Islington (bot)
24ed439462
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:40:09 -08:00
Miss Islington (bot)
e6b0bd5948
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:28:51 -08:00
Miss Islington (bot)
92dd53bf94
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:24:46 -08:00
Miss Islington (bot)
8ef6045187
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:32 -08:00
Łukasz Langa
300d812fd1
[3.10] gh-93453: Only emit deprecation warning in asyncio.get_event_loop when a new event loop is created (#100059)
It no longer emits a deprecation warning if the current event loop was set.

(cherry picked from commit 3fae04b10e)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-12-06 18:40:30 +01:00
Miss Islington (bot)
b7ae1d2285
[3.10] gh-100001: Remove doc typo, add versionadded (GH-100042) (#100044)
(cherry picked from commit bed15f87ea)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-12-06 11:34:49 +01:00
Miss Islington (bot)
ec8c06bc28
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:16:14 -08:00
Eric V. Smith
e5075986a7
[3.10] dataclasses.rst: Prevent horizontal scrolling (gh-100025). (gh-100029)
(cherry picked from commit 51ee0a29e9)

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

Co-authored-by: Ram Rachum <ram@rachum.com>
2022-12-05 14:19:09 -05:00
Miss Islington (bot)
e2209cb6ec
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:47 -08:00
Miss Islington (bot)
80f4624f8e
[3.10] GH-98906 ``re` module: `search() vs. match()` section should mention `fullmatch()`` (GH-98916) (GH-99913)
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:47 -05:00
Miss Islington (bot)
3baaa97d6c
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:41:38 -08:00
Steve Dower
ca3c48072b
gh-90717: Update the documentation for the altchars paremeter in base64 library (GH-94187)
Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
2022-11-29 16:43:36 +00:00
Miss Islington (bot)
ab87bcd91f
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:16:34 -08:00
Miss Islington (bot)
72d173599d
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:47:07 -08:00
Jason R. Coombs
3d82b7ed8d
[3.10] gh-99795: Fix typo in importlib.resources.abc (GH-99796) (GH-99800)
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>

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2022-11-26 13:22:13 -05:00
Miss Islington (bot)
1fc2e2aa92
[3.10] gh-99502: mention bytes-like objects as input in secrets.compare_digest (GH-99512) (#99790)
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:08 +05:30
Miss Islington (bot)
aabe83124a
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:21:00 -08:00
Miss Islington (bot)
5252ad2b64
GH-92892: Add section about variadic functions to ctypes documentation (GH-99529)
On some platforms, and in particular macOS/arm64, the calling
convention for variadic arguments is different from the regular
calling convention. Add a section to the documentation to document
this.
(cherry picked from commit bc3a11d21d)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
2022-11-22 10:57:45 -08:00
Miss Islington (bot)
fa6cc9e6df
[3.10] gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) (GH-99703)
gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141)

* nail down a couple examples to have more predictable output

* update a number of things, but this is really just a stash...

* added an applications section to describe typical uses for native and machine-independent formats

* make sure all format strings use a format prefix character

* responding to comments from @gpshead. Not likely finished yet.

* This got more involved than I expected...

* respond to several PR comments
* a lot of wordsmithing
* try and be more consistent in use of ``x`` vs ``'x'``
* expand examples a bit
* update the "see also" to be more up-to-date
* original examples relied on import * so present all examples as if

* reformat based on @gpshead comment (missed before)

* responding to comments

* missed this

* one more suggested edit

* wordsmithing
(cherry picked from commit 22d91c16bb)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2022-11-22 18:17:18 +00:00
Miss Islington (bot)
101dfaedb2
[3.10] GH-95815: Document less specific error for os.remove (GH-99571) (#99639)
GH-95815: Document less specific error for os.remove (GH-99571)

os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in GH-14262.
(cherry picked from commit 1cae31d26b)


Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
2022-11-21 12:05:32 +01:00
Stanley
4572c98ad2
[3.10] gh-85073: Add some missing links to source (GH-99363) (#99589)
(cherry picked from commit 27d8dc2c9d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-11-19 06:44:52 -08:00
Kamil Turek
bc2cdfc815
[3.10] gh-92119: ctypes: Print exception class name instead of its representation (GH-98302) (#99452)
gh-92119: ctypes: Print exception class name instead of its representation (#98302)

(cherry picked from commit b9dedfe61d)
2022-11-13 15:55:58 -08:00
Miss Islington (bot)
5324893599
gh-99392: Fix sqlite3 converter recipes (GH-99393)
(cherry picked from commit dfc1b17a23)

Co-authored-by: naglis <827324+naglis@users.noreply.github.com>
2022-11-12 11:47:59 -08:00
Miss Islington (bot)
ad5159b7de
gh-87604: Clarify in docs that sys.addaudithook is not for sandboxes (GH-99372)
(cherry picked from commit c3c3871415)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-11-11 05:41:41 -08:00
Miss Islington (bot)
f7d3b18ed5
GH-99183: Document behavior of count() for empty substrings (GH-99339)
(cherry picked from commit 2f4af2d99c)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-11-10 13:27:42 -08:00
Miss Islington (bot)
bec131759e
gh-99238: clarify the type of the env dict. (GH-99253)
(cherry picked from commit 2eee9d9cd7)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-11-08 13:08:08 -08:00
Miss Islington (bot)
b51c2832f0
Fix broken link in asyncio-subprocesses doc (GH-99214)
GH- Fix broken link in Doc/library/asyncio-subprocess.rst

This is a trivial fix in documentation to fix a broken link.

There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.htmlGH-asyncio.subprocess.Process) for the function ``wait_for``:

![image](https://user-images.githubusercontent.com/37690409/200388894-fb6b7c42-b2cc-49ec-a239-e3472890db1f.png)

I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs.

This PR fixes the link and the result looks like the following:

![image](https://user-images.githubusercontent.com/37690409/200389483-b4a92105-7d2c-4285-b0fc-78a6dc0be39c.png)
(cherry picked from commit acf4d5d5bd)

Co-authored-by: Mikael Koli <koli.mikael@gmail.com>
Automerge-Triggered-By: GH:AlexWaygood
2022-11-08 08:33:28 -08:00
Miss Islington (bot)
8eb4e2ce3f
gh-94286 Fix documentation of print default param (GH-94297)
(cherry picked from commit 2db55e0c00)

Co-authored-by: Nouran Ali <nouranalimohammed@gmail.com>
2022-11-06 12:23:01 -08:00
Miss Islington (bot)
0f45b2edac
minor edits to locale doc (GH-98537)
(cherry picked from commit c0bf7607a1)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2022-11-04 06:12:47 -07:00
Miss Islington (bot)
3a7e9ea090
Docs: add named to the list of styles in the sqlite3.paramstyle attr docs (GH-99078)
(cherry picked from commit 016c7d37b6)

Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2022-11-03 16:31:33 -07:00
Serhiy Storchaka
22bbb0c4c7
[3.10] gh-98740: Fix validation of conditional expressions in RE (GH-98764) (GH-99046)
In very rare circumstances the JUMP opcode could be confused with the
argument of the opcode in the "then" part which doesn't end with the
JUMP opcode. This led to incorrect detection of the final JUMP opcode
and incorrect calculation of the size of the subexpression.

NOTE: Changed return value of functions _validate_inner() and
_validate_charset() in Modules/_sre/sre.c.  Now they return 0 on success,
-1 on failure, and 1 if the last op is JUMP (which usually is a failure).
Previously they returned 1 on success and 0 on failure.
(cherry picked from commit e9ac890c02)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-11-03 12:18:50 +02:00
Miss Islington (bot)
b9e621b9f4
gh-65002: Make note that null bytes are used to pad bytes (GH-98635)
(cherry picked from commit 8cd21c2c5d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-11-02 19:24:15 -07:00
Jelle Zijlstra
e07086db03
[3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958) (#98986)
[3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958).
(cherry picked from commit 65d1407737)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2022-11-02 09:12:37 +00:00
Miss Islington (bot)
5f0d266af9
gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)
(cherry picked from commit 898d0d9ad8)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-11-01 22:05:28 -07:00
Miss Islington (bot)
1907e5a7cc
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
(cherry picked from commit 880bafc574)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-10-31 08:08:54 -07:00