Commit graph

11882 commits

Author SHA1 Message Date
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)
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
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)
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)
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)
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)
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)
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
Miss Islington (bot)
a64e71eece
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:09 -08:00
Miss Islington (bot)
420b7e8f43
[3.11] gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) (GH-99702)
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:16:59 +00:00
Miss Islington (bot)
05147dc383
gh-99662: fix typo in typing.TypeVarTuple docs (GH-99672)
(cherry picked from commit 1bf983ce7e)

Co-authored-by: GabrielAnguita <60579349+GabrielAnguita@users.noreply.github.com>
2022-11-21 20:09:49 -08:00
Miss Islington (bot)
bb4c091583
[3.11] GH-95815: Document less specific error for os.remove (GH-99571) (#99641)
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>

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
2022-11-21 12:04:55 +01:00
Miss Islington (bot)
a15ab1ec65
Doc: Make functions.html readable again. (GH-99476)
(cherry picked from commit 858cb79486)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-11-19 02:58:32 -08:00
Miss Islington (bot)
82ab9e6b79
gh-99553: fix bug where an ExceptionGroup subclass can wrap a BaseException (GH-99572)
(cherry picked from commit c8c6113398)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-11-18 08:10:55 -08:00
Gregory P. Smith
51c68cf466
[3.11] gh-98930: improve the docstring of signal.strsignal (GH-99290) (#99449)
Improves the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.

Closes GH-98930

Co-authored-by: Gregory P. Smith <greg@krypto.org>.
(cherry picked from commit 88385b8564)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2022-11-13 12:21:19 -08:00
Miss Islington (bot)
edf744990e
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:48:52 -08:00
Miss Islington (bot)
944ac46b88
[3.11] gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395) (GH-99415)
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
(cherry picked from commit 73a921b070)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-12 10:43:32 -08:00
Miss Islington (bot)
d75b2e2fc8
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:42:44 -08:00
Miss Islington (bot)
17f1c0ab06
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:29:16 -08:00
Miss Islington (bot)
014940ac70
Update reference to the size of PyPI (GH-99076)
Update reference to the size of PyPI

Last changed in 2008 (528576031d).
(cherry picked from commit 58ee5d8677)

Co-authored-by: jmcb <joelsgp@protonmail.com>
2022-11-09 11:36:10 -08:00
Miss Islington (bot)
00147a84fc
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:09:04 -08:00
Miss Islington (bot)
ca944628ac
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:51 -08:00
Miss Islington (bot)
2d00190591
gh-92119: ctypes: Print exception class name instead of its representation (GH-98302)
(cherry picked from commit b9dedfe61d)

Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>
2022-11-07 21:20:06 -08:00
Miss Islington (bot)
c4408d35f6
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:24:02 -08:00
Miss Islington (bot)
be4bab8c2b
gh-93464: [Enum] fix auto() failure during multiple assignment (GH-99148)
* fix auto() failure during multiple assignment

i.e. `ONE = auto(), 'text'` will now have `ONE' with the value of `(1,
'text')`.  Before it would have been `(<an auto instance>, 'text')`
(cherry picked from commit 8feb7ab77c)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2022-11-06 06:30:32 -08:00