Raymond Hettinger
e5eaac6064
GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669)
2023-04-22 09:18:25 -05:00
Raymond Hettinger
7d20783d45
Minor improvements to the functools docs ( #103672 )
...
* Use an f-string for improved readability
* Put version notes in chronological order
2023-04-21 20:53:50 -05:00
Jason R. Coombs
3e0fec7e07
Sync with importlib_metadata 6.5 (GH-103584)
2023-04-20 22:12:48 -04:00
Adrien
4898415df7
gh-98641: Document difference between task group and gather ( #103644 )
...
The purpose of the comments is to rule out the implication that asyncio.TaskGroup is a drop-in replacement / better alternative to asyncio.gather().
2023-04-20 07:07:41 -07:00
Pablo Galindo Salgado
1ef61cf71a
gh-102856: Initial implementation of PEP 701 ( #102855 )
...
Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
Co-authored-by: Batuhan Taskaya <isidentical@gmail.com>
Co-authored-by: Marta Gómez Macías <mgmacias@google.com>
Co-authored-by: sunmy2019 <59365878+sunmy2019@users.noreply.github.com>
2023-04-19 11:18:16 -05:00
Kumar Aditya
da2273fec7
GH-88342: clarify that `asyncio.as_completed` accepts generators yielding tasks ( #103626 )
2023-04-19 15:51:53 +05:30
Nikita Sobolev
f4d087964e
gh-103582: Remove last references to `argparse.REMAINDER` from docs ( #103586 )
2023-04-18 23:02:48 -06:00
Ethan Furman
700ec657c8
gh-103596: [Enum] do not shadow mixed-in methods/attributes (GH-103600)
...
For example:
class Book(StrEnum):
title = auto()
author = auto()
desc = auto()
Book.author.desc is Book.desc
but
Book.author.title() == 'Author'
is commonly expected. Using upper-case member names avoids this confusion and possible performance impacts.
Co-authored-by: samypr100 <3933065+samypr100@users.noreply.github.com>
2023-04-18 16:19:23 -07:00
zyckk4
4e04393b2f
[Doc] Fix a typo in optparse.rst ( #103504 )
2023-04-18 16:51:26 +05:30
yuki
c3d015ce62
gh-101100: Fix broken reference `__format__` in `string.rst` ( #103531 )
2023-04-18 16:48:53 +05:30
Pradyun Gedam
ece20dba12
gh-95299: Stop installing setuptools as a part of ensurepip and venv ( #101039 )
...
Remove the bundled setuptools wheel from ensurepip, and stop installing setuptools in environments created by venv.
Co-Authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-17 23:43:34 -05:00
Giampaolo Rodola
ff3303e49c
gh-48330: address review comments to PR-12271 ( #103209 )
...
address review comments to PR-12271
Signed-off-by: Giampaolo Rodola <g.rodola@gmail.com>
2023-04-17 00:19:44 +02:00
Ethan Furman
2194071540
gh-103365: [Enum] STRICT boundary corrections (GH-103494)
...
STRICT boundary:
- fix bitwise operations
- make default for Flag
2023-04-13 08:24:33 -07:00
Skip Montanaro
330a942b63
gh-67230: add quoting rules to csv module (GH-29469)
...
Add two quoting styles for csv dialects.
They will help to work with certain databases in particular.
Automerge-Triggered-By: GH:merwok
2023-04-12 15:32:30 -07:00
Nick Burns
f2b7ecb778
gh-103417: use time.monotonic in the example for sched.scheduler ( #103418 )
2023-04-12 01:59:21 -07:00
Bar Harel
8f54302ab4
gh-103357: Add logging.Formatter defaults support to logging.config fileConfig and dictConfig (GH-103359)
2023-04-12 08:35:56 +01:00
Tian Gao
449bf2a76b
gh-103237: Polish pdb docs ( #103238 )
2023-04-11 23:18:34 -07:00
Tian Gao
2f41a009b7
gh-103143: Polish pdb help messages and doc strings (GH-103144)
...
* Made all the command part of the docstring match the official documentation
* Always have a space between the command and the description in docstring
* Added a helper function to format the help message
Before:
```
(Pdb) h a
a(rgs)
Print the argument list of the current function.
(Pdb) h commands
commands [bpnumber]
(com) ...
(com) end
(Pdb)
...
(Pdb) h interact
interact
Start an interactive interpreter whose global namespace
contains all the (global and local) names found in the current scope.
```
After
```
(Pdb) h a
Usage: a(rgs)
Print the argument list of the current function.
(Pdb) h commands
Usage: (Pdb) commands [bpnumber]
(com) ...
(com) end
(Pdb)
...
(Pdb) h interact
Usage: interact
Start an interactive interpreter whose global namespace
contains all the (global and local) names found in the current scope.
```
Automerge-Triggered-By: GH:brandtbucher
2023-04-11 15:40:30 -07:00
Nikita Sobolev
50b4b15984
gh-87864: Use correct function definition syntax in the docs ( #103312 )
2023-04-11 16:50:25 +03:00
Alex Waygood
e071f00aae
gh-103373: `__mro_entries__` docs: improve cross references ( #103398 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-11 11:25:45 +01:00
Irit Katriel
78b763f630
gh-103176: sys._current_exceptions() returns mapping to exception instances instead of exc_info tuples ( #103177 )
2023-04-11 09:38:37 +01:00
C.A.M. Gerlach
75b6ab80da
Doc: Avoid error lexing multiprocessing docs code block on Pygments 2.15.0 ( #103421 )
2023-04-10 20:57:36 -07:00
raylu
8b1b17134e
gh-103059: Clarify gc.freeze documentation ( #103058 )
2023-04-10 10:30:32 -06:00
James Hilton-Balfe
ecad802e3f
Fix old behaviour in typing documentation ( #103400 )
2023-04-09 22:55:32 +01:00
Raymond Hettinger
f65fdbb8fd
Itertool recipe improvements (GH-103399)
2023-04-09 14:17:37 -05:00
mara004
975d220bbe
ctypes docs: fix missing `not` in variadic functions section ( #102611 )
2023-04-09 13:56:52 +05:30
yuki
83af8f2686
Docs: Fix broken reference `__getitem__` in `string.rst` ( #103371 )
2023-04-09 07:32:16 +05:30
Ezio Melotti
3310b94d3d
gh-100574: add examples/links to the `strptime`/`strftime` docs ( #100575 )
2023-04-08 11:46:47 +03:00
Alex Waygood
644136563d
gh-74690: Document changes made to runtime-checkable protocols in 3.12 ( #103348 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-04-07 22:06:37 +01:00
Oleg Iarygin
f0424ba4b6
gh-103266: Fix a typo in example code for bisect() function ( #103267 )
2023-04-06 17:34:19 -07:00
Brandt Bucher
b4978ff872
GH-88691: Shrink the CALL caches (GH-103230)
2023-04-05 14:15:49 -07:00
Olivier Gayot
fdd0fff277
gh-102899: Fix doc link for getting filesystem error handler ( #102901 )
2023-04-05 16:54:43 +02:00
Serhiy Storchaka
a28d4edb23
gh-100408: Fix a traceback in multiprocessing example ( #100409 )
2023-04-05 12:43:26 +01:00
C.A.M. Gerlach
c396b6ddf3
gh-81762: Clarify and simplify description of print's flush param ( #103264 )
2023-04-05 12:16:36 +01:00
Michael Handler
1a8f862e32
gh-66897: Upgrade HTTP CONNECT to protocol HTTP/1.1 ( #8305 )
...
* bpo-22708: Upgrade HTTP CONNECT to protocol HTTP/1.1 (GH-NNNN)
Use protocol HTTP/1.1 when sending HTTP CONNECT tunnelling requests;
generate Host: headers if one is not already provided (required by
HTTP/1.1), convert IDN domains to punycode in HTTP CONNECT requests.
* Refactor tests to pass under -bb (fix ByteWarnings); missed some lines >80.
* Use consistent 'tunnelling' spelling in Lib/http/client.py
* Lib/test/test_httplib: Remove remnant of obsoleted test.
* Use dict.copy() not copy.copy()
* fix version changed
* Update Lib/http/client.py
Co-authored-by: bgehman <bgehman@users.noreply.github.com>
* Switch to for/else: syntax, as suggested
* Don't use for: else:
* Sure, fine, w/e
* Oops
* 1nm to the left
---------
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: bgehman <bgehman@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-04 21:55:24 -07:00
Tim Burke
bceb9e00ad
Improve some grammar in the socket docs ( #103254 )
2023-04-04 23:46:46 +01:00
Charles Machalow
935aa45235
GH-75586: Make shutil.which() on Windows more consistent with the OS (GH-103179)
2023-04-04 23:24:13 +01:00
Ethan Furman
5ffc1e5a21
gh-98298, gh-74730: [Enum] update docs (GH-103163)
...
fix FlagBoundary statements
add warning about reloading modules and enum identity
2023-04-03 14:57:42 -07:00
Nouran Ali
55decb72c4
gh-102994: Profile docs has typo in example ( #103074 )
2023-04-02 15:44:16 -07:00
Charlie Zhao
32937d6aa4
gh-103109: Document ignore_warnings() test support helper ( #103110 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-03 00:18:25 +02:00
Giampaolo Rodola
6883007a86
bpo-4080: unittest durations ( #12271 )
2023-04-03 00:12:51 +02:00
Alex Waygood
6d59c9e32e
gh-102433: Use `inspect.getattr_static` in `typing._ProtocolMeta.__instancecheck__` ( #103034 )
2023-04-02 14:22:19 +01:00
James De Bias
b0422e140d
gh-102871: Remove obsolete browsers from webbrowser ( #102872 )
2023-03-31 11:02:47 -04:00
Petr Viktorin
f6405a4662
Quote literal tokens in standard format specifier grammar (GH-102902)
...
Reported by Damian Dureck: https://mail.python.org/archives/list/docs@python.org/thread/UZTWBJIXC3MBKTHXVTIBPGDPKBNWZ5LN/
2023-03-31 14:40:38 +02:00
gaogaotiantian
c1e71ce56f
Minor docs improvements fix for `codeop` ( #103123 )
2023-03-30 15:51:36 -07:00
Hugo van Kemenade
f192a558f5
gh-101100: Fix Sphinx warning in gc.rst and refactor docs clean list ( #103116 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-30 21:03:50 +03:00
Shantanu
fda95aa194
gh-103099: Link mypy docs from typing.rst ( #103100 )
2023-03-30 01:32:09 -07:00
gaogaotiantian
027223db96
Update pdb docs for arguments ( #102965 )
2023-03-25 14:31:45 -07:00
Peter Jiping Xie
0708437ad0
gh-103025: fix two ctypes doc issues ( #103026 )
2023-03-25 09:12:00 +00:00
JakobDev
64cb1a4f0f
gh-100131: Add optional delete parameter to tempfile.TemporaryDirectory() ( #100132 )
...
Add optional delete parameter to tempfile.TemporaryDirectory().
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-03-24 14:52:06 -07:00
Amin Alaee
f2e5a6ee62
gh-102873: logging.LogRecord docs: improve description of `msg` parameter ( #102875 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-24 15:00:32 +00:00
Hugo van Kemenade
6a1c49a717
gh-101100: Test docs in nit-picky mode ( #102513 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-24 13:23:35 +02:00
MonadChains
413b7db8a4
gh-94684: uuid: support bytes in the name argument to uuid3/5 ( #94709 )
...
RFC 4122 does not specify that name should be a string, so for completness the functions should also support a name given as a raw byte sequence.
2023-03-23 17:42:43 -06:00
Brandt Bucher
0444ae2487
GH-100982: Break up COMPARE_AND_BRANCH (GH-102801)
2023-03-23 15:25:09 -07:00
Raymond Hettinger
16f6165b71
Minor readability improvement to the factor() recipe (GH-102971)
2023-03-23 14:46:15 -05:00
Nikita Sobolev
b6132085ca
gh-98239: Document that `inspect.getsource()` can raise `TypeError` ( #101689 )
2023-03-23 19:35:02 +00:00
Alex Waygood
58d2b30c01
gh-102936: typing: document performance pitfalls of protocols decorated with `@runtime_checkable` ( #102937 )
2023-03-23 18:18:53 +00:00
Raymond Hettinger
4695709143
Move binomialvariate() to a section for discrete distributions (GH-102955)
2023-03-23 12:10:12 -05:00
JosephSBoyle
f13fdacadf
gh-102810 Improve the sphinx docs for `asyncio.Timeout` ( #102934 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 16:43:13 +00:00
Erlend E. Aasland
08254be6c5
Docs: fixup incorrect escape char in sqlite3 docs ( #102945 )
2023-03-23 14:21:32 +01:00
Kevin Kirsche
9b19d3936d
gh-102921: [doc] Clarify `exc` argument name in `BaseExceptionGroup` is plural ( #102922 )
2023-03-22 18:14:05 +00:00
Irit Katriel
3468c768ce
gh-102859: Remove JUMP_IF_FALSE_OR_POP and JUMP_IF_TRUE_OR_POP ( #102870 )
2023-03-22 18:10:48 +00:00
Kristján Valur Jónsson
04adf2df39
gh-102780: Fix uncancel() call in asyncio timeouts ( #102815 )
...
Also use `raise TimeOut from <CancelledError instance>` so that the CancelledError is set
in the `__cause__` field rather than in the `__context__` field.
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-22 10:52:10 -07:00
Benjamin Fogle
af9c34f6ef
gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers ( #96932 )
2023-03-22 15:08:41 +01:00
Erlend E. Aasland
7b2d53dacc
Docs: improve accuracy of sqlite3.Connection.interrupt() ( #102904 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 12:50:00 +01:00
Erlend E. Aasland
c24f1f1e87
Docs: improve the accuracy of the sqlite3.connect() timeout param ( #102900 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 12:37:13 +01:00
gaogaotiantian
e0c63b7267
Docs: improve accuracy of pdb alias example ( #102892 )
2023-03-22 12:34:52 +01:00
David Poirier
41ef502d74
Add link to `sys.exit` function documentation ( #102805 )
...
* Add link to `sys.exit` function documentation
* Update Doc/library/os.rst
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Update Doc/library/os.rst
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
---------
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 06:58:31 +09:00
Raymond Hettinger
0214c7ad90
Tweak polynomial itertool recipes (GH-102880)
2023-03-21 13:21:57 -05:00
wim glenn
4bb1dd3c5c
gh-102876: remove superfluous parens from itertools.batched recipe (GH-102877)
...
remove superfluous parens from itertools.batched recipe
2023-03-21 12:06:18 -05:00
Raymond Hettinger
1a5a14183e
The pow() variant further improves accuracy (GH-102866)
2023-03-21 00:02:14 -05:00
Raymond Hettinger
4075fe1d8d
Remove itermediate list. Expand docstring. (GH-102862)
2023-03-20 20:40:04 -05:00
Raymond Hettinger
094cf392f4
Add itertool recipe for polynomial evaluation. (GH-102852)
2023-03-20 17:14:29 -05:00
Alan Williams
5e6661bce9
gh-72346: Added isdst deprecation warning to email.utils.localtime (GH-91450)
2023-03-19 19:20:20 -05:00
Irit Katriel
d51a6dc28e
gh-102828: add onexc arg to shutil.rmtree. Deprecate onerror. ( #102829 )
2023-03-19 18:33:51 +00:00
Irit Katriel
e1e9bab006
gh-102778: Add sys.last_exc, deprecate sys.last_type, sys.last_value,sys.last_traceback ( #102779 )
2023-03-18 11:47:11 +00:00
Kumar Aditya
4f5774f648
GH-78530: add support for generators in `asyncio.wait` ( #102761 )
2023-03-17 06:58:43 +05:30
Mark Dickinson
405739f916
Fix outdated note about 'int' rounding or truncating ( #102736 )
2023-03-16 20:34:42 +00:00
Steve Dower
0f175766e2
gh-99726: Improves correctness of stat results for Windows, and uses faster API when available (GH-102149)
...
This deprecates `st_ctime` fields on Windows, with the intent to change them to contain the correct value in 3.14. For now, they should keep returning the creation time as they always have.
2023-03-16 17:27:21 +00:00
Raymond Hettinger
b0ec6253c9
GH-102653: Make recipe docstring show the correct distribution ( #102742 )
2023-03-16 09:32:18 -05:00
Julien Palard
61b9ff35cb
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-03-15 16:10:03 +01:00
Tom Levy
8647ba4b63
Remove misformatted exclamation marks in docs ( #102694 )
...
Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.
(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)
The exclamation marks in venv.rst were introduced in #98350 . See
comments [2] and [3] for additional discussion.
[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047
Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-03-15 09:06:32 +02:00
Paul Watson
80abd62647
gh-102354: change python3 to python in docs examples ( #102696 )
2023-03-14 12:40:12 -06:00
Joongi Kim
7bdb331b67
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
2023-03-14 11:07:59 +09:00
Blind4Basics
61479d4684
gh-102627: Replace address pointing toward malicious web page ( #102630 )
...
* Replace known bad address pointing toward a malicious web page.
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-03-13 15:35:37 -07:00
Hugo van Kemenade
78e4e6c3d7
gh-101100: Fix Sphinx warnings in `turtle` module ( #102340 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-13 11:24:52 +02:00
Виталий Дмитриев
f6ca71a422
Fix duplicated words in the docs (GH-102629)
...
With grep utility found some duplicated words
Automerge-Triggered-By: GH:AlexWaygood
2023-03-12 11:03:59 -07:00
Guido van Rossum
e6210621be
Fixes duplicated word ( #102623 )
...
In line 1627, the end of the sentence reads "only that that it may be." but it should read "only that it may be" (or alternatively "only that that may be").
Co-authored-by: Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
2023-03-12 09:58:02 -07:00
Thomas Krennwallner
ced13c96a4
gh-79940: add introspection API for asynchronous generators to `inspect` module ( #11590 )
2023-03-11 18:49:40 +05:30
Brandt Bucher
08b67fb34f
GH-90997: Shrink the LOAD_GLOBAL caches ( #102569 )
2023-03-10 17:01:16 -08:00
Nikita Sobolev
b48be8fa18
gh-102103: add `module` argument to `dataclasses.make_dataclass` ( #102104 )
2023-03-10 17:26:46 -07:00
Steve Dower
12226bec25
gh-102519: Add doc updates for os.listdrives, listvolumes and listmounts (GH-102585)
2023-03-10 15:41:32 +00:00
Owain Davies
53dceb53ad
gh-86509: Add link to Lib/_threading_local.py in threading docs ( #101824 )
2023-03-10 13:22:02 +01:00
sblondon
7d801f245e
Remove or update bitbucket links (GH-101963)
...
Since Mercurial removal from bitbucket.org, some links are broken.
They are replaced by github.com or webarchive.org links if available. Otherwise, they are removed.
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-03-08 11:24:39 +01:00
Nikita Sobolev
1f557f94c2
gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules ( #102526 )
2023-03-08 08:19:05 +00:00
Marcin Wieczorek
061325e0d2
Fix style in argparse.rst ( #101733 )
2023-03-07 23:25:28 -08:00
Hyunkyun Moon
d3ca042c99
gh-95672: Fix versionadded indentation of get_pagesize in test.rst (gh-102455)
2023-03-06 22:56:19 +09:00
Barney Gale
6716254e71
GH-101362: Optimise PurePath(PurePath(...)) (GH-101667)
...
The previous `_parse_args()` method pulled the `_parts` out of any supplied `PurePath` objects; these were subsequently joined in `_from_parts()` using `os.path.join()`. This is actually a slower form of joining than calling `fspath()` on the path object, because it doesn't take advantage of the fact that the contents of `_parts` is normalized!
This reduces the time taken to run `PurePath("foo", "bar")` by ~20%, and the time taken to run `PurePath(p, "cheese")`, where `p = PurePath("/foo", "bar", "baz")`, by ~40%.
Automerge-Triggered-By: GH:AlexWaygood
2023-03-05 15:50:21 -08:00
Sergey B Kirpichev
5da379ca7d
Move around example in to_bytes() to avoid confusion ( #101595 )
...
Moves an example to be closer to the sentence that refers to it.
2023-03-05 09:31:56 +00:00
Wagner Alberto
cb944d0be8
Add import of `unittest.mock.Mock` in documentation ( #102346 )
2023-03-03 22:55:31 +05:30