Commit graph

12728 commits

Author SHA1 Message Date
Miss Islington (bot)
b1da63468e
[3.12] gh-102249: Expand sys.call_tracing documentation (GH-102806) (#111557)
Co-authored-by: Quentin Peter <impact27@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-10-31 18:40:12 +02:00
Miss Islington (bot)
71e138d93e
[3.12] gh-93607: document root attribute of iterparse (GH-99410) (#111555)
Co-authored-by: Prometheus3375 <35541026+Prometheus3375@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-31 16:27:37 +00:00
Miss Islington (bot)
c21387c6b2
[3.12] gh-106861: Docs: Add availability directives to all Unix-only modules (GH-108975) (#111553)
Co-authored-by: xzmeng <aumo@foxmail.com>
2023-10-31 16:22:50 +00:00
Miss Islington (bot)
e5b6744f30
[3.12] gh-111165: Remove documentation for moved functions (GH-111467) (GH-111471)
(cherry picked from commit 4d6bdf8aab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-10-29 19:43:53 +00:00
Miss Islington (bot)
577c808cf9
[3.12] gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst (GH-111222) (#111469)
gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)

* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst



* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3275)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-29 19:39:27 +00:00
Miss Islington (bot)
2e5d4e24eb
[3.12] gh-79033: Try to fix asyncio.Server.wait_closed() again (GH-111336) (#111424)
gh-79033: Try to fix asyncio.Server.wait_closed() again (GH-111336)

* Try to fix asyncio.Server.wait_closed() again

I identified the condition that `wait_closed()` is intended
to wait for: the server is closed *and* there are no more
active connections.

When this condition first becomes true, `_wakeup()` is called
(either from `close()` or from `_detach()`) and it sets `_waiters`
to `None`. So we just check for `self._waiters is None`; if it's
not `None`, we know we have to wait, and do so.

A problem was that the new test introduced in 3.12 explicitly
tested that `wait_closed()` returns immediately when the server
is *not* closed but there are currently no active connections.
This was a mistake (probably a misunderstanding of the intended
semantics). I've fixed the test, and added a separate test that
checks exactly for this scenario.

I also fixed an oddity where in `_wakeup()` the result of the
waiter was set to the waiter itself. This result is not used
anywhere and I changed this to `None`, to avoid a GC cycle.

* Update Lib/asyncio/base_events.py

---------

(cherry picked from commit 2655369559)

Co-authored-by: Guido van Rossum <guido@python.org>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-10-28 18:42:53 +00:00
Miss Islington (bot)
713210985b
[3.12] gh-111276: Clarify docs and comments about the role of LC_CTYPE (GH-111319) (#111391)
Fix locale.LC_CTYPE documentation to no longer mention string.lower() et al. Those functions were removed in Python 3.0:
https://docs.python.org/2/library/string.htmlGH-deprecated-string-functions

Also, fix a comment in logging about locale-specific behavior of `str.lower()`.

(cherry picked from commit 6d42759c5e)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-27 17:15:06 +02:00
Miss Islington (bot)
883233dcc3
[3.12] gh-111343: Fix itertools docs: start arg is optional for count (gh-111344) (gh-111385) 2023-10-27 10:01:00 -05:00
Hugo van Kemenade
7d22e85550
[3.12] gh-111187: Postpone removal version for locale.getdefaultlocale() to 3.15 (GH-111188) (#111323) 2023-10-27 16:08:45 +03:00
Miss Islington (bot)
7cce26bcd9
[3.12] Docs: Add restart_events() and positional arg semantics for sys.monitoring (GH-111291) (#111335)
Docs: Add `restart_events()` and positional arg semantics for `sys.monitoring` (GH-111291)
(cherry picked from commit 3f84a19e62)

Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-25 18:13:05 +00:00
Miss Islington (bot)
ed05bf6006
[3.12] gh-108590: Improve sqlite3 docs on encoding issues and how to handle those (GH-108699) (#111324)
Add a guide for how to handle non-UTF-8 text encodings.
Link to that guide from the 'text_factory' docs.

(cherry picked from commit 1262e41842)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Corvin <corvin@corvin.dev>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-10-25 14:08:10 +00:00
Serhiy Storchaka
5c4f9a1c7e
[3.12] gh-111165: Move test running code from test.support to libregrtest (GH-111166) (GH-111316)
Remove no longer used functions run_unittest() and run_doctest() from
the test.support module.
(cherry picked from commit f6a45a03d0)
2023-10-25 14:56:27 +03:00
Miss Islington (bot)
a4eb2e308d
[3.12] Fix first parameter name in tool functions from sys.monitoring (GH-111286) (#111290)
Fix first parameter name in `tool` functions from `sys.monitoring` (GH-111286)
(cherry picked from commit 8b44f3c54b)

Co-authored-by: Pavel Karateev <lancelote.du.lac@gmail.com>
2023-10-24 21:28:35 +00:00
Miss Islington (bot)
2a28aa10a8
[3.12] GH-111182: Update EnumType.__contains__ docs (GH-111184) (GH-111281)
GH-111182: Update EnumType.__contains__ docs (GH-111184)
(cherry picked from commit c0ea67dd0d)

Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-24 10:52:17 -07:00
Miss Islington (bot)
b180120468
[3.12] Revert "Fix a code snippet typo in asyncio docs (GH-108427)" (GH-111271) (GH-111272)
Revert "Fix a code snippet typo in asyncio docs (GH-108427)" (GH-111271)

This reverts commit 7f31676340.

The change resulted in a tautology and should not have been made.  There
may be an opportunity for additional clarity in this section, but this
change wasn't it :)

(cherry picked from commit c7d68f907a)


Ref: https://github.com/python/cpython/pull/108427#-issuecomment-1777525740

Co-authored-by: Zachary Ware <zach@python.org>
2023-10-24 11:26:31 -05:00
Miss Islington (bot)
edff7c1614
[3.12] gh-111151: Convert monospaced directives to :ref: (GH-111152) (#111269)
gh-111151: Convert monospaced directives to :ref: (GH-111152)
(cherry picked from commit 1198076447)

Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-24 15:30:21 +00:00
Miss Islington (bot)
03c14b04d3
[3.12] Fix typo in sys docs (GH-111196) (#111248)
Co-authored-by: James Tocknell <aragilar+github@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-24 08:12:05 +00:00
Miss Islington (bot)
b622c2dcbe
[3.12] Fix a code snippet typo in asyncio docs (GH-108427) (#111245)
Co-authored-by: A <5249513+Dumeng@users.noreply.github.com>
2023-10-24 06:37:41 +00:00
Miss Islington (bot)
38578dd665
[3.12] gh-101100: Fix Sphinx warnings for fileno (GH-111118) (#111226)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-23 19:19:26 +00:00
Miss Islington (bot)
82c045f301
[3.12] typo: missing line of output in pull parser example (GH-111068) (#111217)
Co-authored-by: Don Patterson <37046246+don-patterson@users.noreply.github.com>
2023-10-23 16:03:54 +00:00
Miss Islington (bot)
6a5aab0cb4
[3.12] gh-106310 - document the __signature__ attribute (GH-106311) (#111145)
Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-23 18:49:12 +03:00
Miss Islington (bot)
06fe8685a1
[3.12] gh-101100: Fix sphinx warnings in library/asyncio-dev.rst (GH-111179) (#111185)
gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst` (GH-111179)

* gh-101100: Fix sphinx warnings in `library/asyncio-dev.rst`

* Update Doc/library/asyncio-eventloop.rst

* Update Doc/library/asyncio-eventloop.rst

---------

(cherry picked from commit 8c689c9b88)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-10-22 10:28:09 -07:00
Miss Islington (bot)
b4c215e82d
[3.12] gh-101100: Fix sphinx warnings in library/codecs.rst (GH-110979) (#111070)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 11:09:18 +03:00
Miss Islington (bot)
909225172a
[3.12] gh-101100: Fix Sphinx warnings in library/tty.rst (GH-111079) (#111097)
gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079)

Fix Sphinx warnings in library/tty.rst
(cherry picked from commit c42c68aa7b)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-20 07:49:41 +03:00
Hugo van Kemenade
41dfae8f86
[3.12] gh-101100: Fix sphinx warnings in library/getpass.rst (GH-110461) (#111080)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-19 15:38:58 +00:00
Miss Islington (bot)
3e9d84c94c
[3.12] gh-109510: Clearly explain "Which Docstrings Are Examined" (GH-109696) (#111077)
Co-authored-by: Unique-Usman <86585626+Unique-Usman@users.noreply.github.com>
Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-10-19 18:35:04 +03:00
Miss Islington (bot)
91a6e98e92
[3.12] GH-101100: Fix reference warnings for `__enter__ and __exit__` (GH-110112) (#111075)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:34:25 +03:00
Miss Islington (bot)
cdcab408a0
[3.12] GH-101100: Fix reference warnings for `__getitem__` (GH-110118) (#111073)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-10-19 18:33:03 +03:00
Brandt Bucher
d312135764
[3.12] GH-103082: Clean up the sys.monitoring docs (GH-111048)
(cherry picked from commit 1991694117)
2023-10-18 23:30:13 +00:00
Miss Islington (bot)
9ef8caf293
[3.12] GH-104232: Fix statement about trace return values (GH-111047)
(cherry picked from commit d9246c7b73)
2023-10-18 23:22:03 +00:00
Miss Islington (bot)
ae838afe35
[3.12] gh-107457: update dis documentation with changes in 3.12 (GH-108900) (#110985)
gh-107457: update dis documentation with changes in 3.12 (GH-108900)
(cherry picked from commit 198aa67d4c)

Co-authored-by: Matthieu Dartiailh <m.dartiailh@gmail.com>
2023-10-18 00:38:42 +02:00
Miss Islington (bot)
744f752f04
[3.12] gh-101100: Fix sphinx warnings in library/time.rst (GH-110862) (#110877)
gh-101100: Fix sphinx warnings in `library/time.rst` (GH-110862)
(cherry picked from commit 12deda7633)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-14 14:28:58 +00:00
Miss Islington (bot)
1a7afa7ef4
[3.12] gh-110703: Add asyncio.wait_for() change notes for 3.11 (GH-110818) (#110826)
gh-110703: Add asyncio.wait_for() change notes for 3.11 (GH-110818)

* Remove redundant versionchanged

* Add missing versionchanged

* Update Doc/library/asyncio-task.rst



---------

(cherry picked from commit f81e36f700)

Co-authored-by: paskozdilar <53006174+paskozdilar@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-10-13 13:24:28 +00:00
Ezio Melotti
7d5a982609
[3.12] gh-110631: Fix reST indentation (GH-110724) (#110738)
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f475)
2023-10-11 23:12:36 +02:00
Miss Islington (bot)
cae968ba17
[3.12] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#110736)
gh-110631: Fix reST indentation in `Doc/library` (GH-110685)

Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f556)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-10-11 23:11:28 +02:00
Hugo van Kemenade
e6c53dd085
[3.12] gh-108826: Document dis module CLI and rename _test function to main (#108827) (#110681)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
2023-10-11 14:47:38 -06:00
Miss Islington (bot)
80e4abe0ce
[3.12] gh-101100: Fix sphinx warnings in library/socketserver.rst (GH-110207) (GH-110623)
(cherry picked from commit 756062b296)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-10 14:10:22 +02:00
Miss Islington (bot)
a7fe709fef
[3.12] gh-110497: Add note about OSError being an alias to IOError in docs (GH-110498) (#110546)
gh-110497: Add note about `OSError` being an alias to `IOError` in docs (GH-110498)
(cherry picked from commit 5e7edac771)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-10-09 11:42:17 +02:00
Miss Islington (bot)
b77f5eea70
[3.12] Fix typo in Doc/library/textwrap.rst (GH-110328) (#110473)
Co-authored-by: InSync <122007197+InSyncWithFoo@users.noreply.github.com>
2023-10-06 14:33:16 +00:00
Miss Islington (bot)
93279cc8b8
[3.12] gh-110383: Swap 'the all' -> 'all the' in socket docs (GH-110434) (#110435)
Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
2023-10-05 14:14:22 -06:00
Miss Islington (bot)
5b66fe8304
[3.12] gh-110383 TimeIt Docs Spelling Fix (GH-110407) (#110409)
gh-110383 TimeIt Docs Spelling Fix (GH-110407)

Make 0.2 second plural
(cherry picked from commit a973bf0f97)

Co-authored-by: Towster15 <105541074+Towster15@users.noreply.github.com>
2023-10-05 17:42:52 +00:00
Miss Islington (bot)
4da8c1b61e
[3.12] Remove duplicate word. (GH-110376) (GH-110377)
Remove duplicate word. (GH-110376)
(cherry picked from commit 313aa861ce)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2023-10-05 04:26:44 +00:00
Miss Islington (bot)
36a7d6becd
[3.12] Add back bltin-boolean-values ref tag (GH-110371) (#110372)
Add back bltin-boolean-values ref tag (GH-110371)

To avoid breaking downstream intersphinx via numpydoc
(cherry picked from commit f7860295b1)

Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
2023-10-04 20:05:21 +00:00
Miss Islington (bot)
7ec34874e3
[3.12] gh-85984: Document change in return type of tty functions (GH-110028) (#110324)
gh-85984: Document change in return type of tty functions (GH-110028)
(cherry picked from commit f02f26e293)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-10-04 13:57:14 +02:00
Miss Islington (bot)
ee2f2bdb30
[3.12] Enhance TypedDict docs around required/optional keys (GH-109547) (#109982)
Enhance TypedDict docs around required/optional keys (GH-109547)

As discussed in comments to GH-109544, the semantics of this attribute
are somewhat confusing. Add a note explaining its limitations and
steering users towards __required_keys__ and __optional_keys__ instead.
(cherry picked from commit f49958c886)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-10-04 13:56:58 +02:00
Adam Turner
4c0f42bbc6
[3.12] Docs: Avoid the deprecated `.. cmdoption::` directive (GH-110292) (#110302)
[3.12] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292).
(cherry picked from commit 77e9aae383)
2023-10-03 20:55:29 +03:00
Miss Islington (bot)
90dea557bb
[3.12] gh-109234: Hint to contextlib.closing in sqlite3 context manager docs (GH-109322) (#110294)
(cherry picked from commit 4227bfa8b2)

Co-authored-by: Lincoln <71312724+Lincoln-developer@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-10-03 16:02:44 +00:00
Raymond Hettinger
221c8d64e6
[3.12] Sync factor() recipe with main branch (gh-110231) 2023-10-02 14:19:46 -05:00
Alex Waygood
25bf0564c4
[3.12] Fix typos in docs and comments (#109619) (#109621)
Fix typos in docs and comments (#109619)

Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
2023-10-02 17:34:49 +00:00
Miss Islington (bot)
b61a4da459
[3.12] gh-109590: Update shutil.which on Windows to prefer a PATHEXT extension on executable files (GH-109995) (#110202)
gh-109590: Update shutil.which on Windows to prefer a PATHEXT extension on executable files (GH-109995)

The default arguments for shutil.which() request an executable file, but extensionless files are not executable on Windows and should be ignored.
(cherry picked from commit 29b875bb93)

Co-authored-by: Charles Machalow <csm10495@gmail.com>
2023-10-02 17:48:30 +02:00