f5fea22886
gh-99650 : Updated argparse docs (GH-99653)
2022-11-22 13:16:06 -08:00
22d91c16bb
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
2022-11-22 18:06:36 +00:00
1b2de89bce
gh-99547: Add isjunction methods for checking if a path is a junction (GH-99548)
2022-11-22 17:19:34 +00:00
bc3a11d21d
GH-92892: Add section about variadic functions to ctypes documentation ( #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.
2022-11-22 11:33:37 +01:00
1bf983ce7e
gh-99662: fix typo in typing.TypeVarTuple docs ( #99672 )
2022-11-21 20:02:55 -08:00
1cae31d26b
GH-95815: Document less specific error for os.remove ( #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 #14262 .
2022-11-21 11:08:06 +01:00
858cb79486
Doc: Make functions.html readable again. (GH-99476)
2022-11-19 11:25:45 +01:00
27d8dc2c9d
gh-85073: Add some missing links to source (GH-99363)
...
Add some missing links to source from Python docs
2022-11-18 11:33:40 -08:00
ed206e39f0
Doc: Fix broken link to emscripten networking website ( #99531 )
...
There was an extra `>` in the url.
2022-11-18 10:57:04 -08:00
c8c6113398
gh-99553: fix bug where an ExceptionGroup subclass can wrap a BaseException (GH-99572)
2022-11-18 15:44:43 +00:00
a0d940d6ac
Misc copyedits in docs on built-in types (GH-24466)
...
# DOC: Improvements in library/stdtypes
This PR does the following:
1. Replaces :meth: by :func: around repr function
2. Adds links to Unicode Standard site
3. Makes explicit "when" you can call the `iskeyword` function. The previous text could cause confusion to readers, especially those with English as a second language. The reader could understand that the `isidentifier` method calls the `iskeyword` function. Now, it is explicit that the dev can do it.
4. Replaces a URL with an inline link.
Automerge-Triggered-By: GH:AlexWaygood
2022-11-17 08:06:00 -08:00
19c1462e8d
gh-99377: Add audit events for thread creation and clear (GH-99378)
2022-11-16 17:15:52 +00:00
f63002755d
GH-99388: add `loop_factory` parameter to `asyncio.run` ( #99462 )
2022-11-14 10:18:51 -08:00
f0d12ca0e0
Fix misspelling in docs for http.HTTPMethod ( #99376 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-11-13 12:46:28 -08:00
88385b8564
gh-98930: improve the docstring of signal.strsignal ( #99290 )
...
Improves the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.
Closes #98930
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2022-11-13 11:41:23 -08:00
c95f554a40
gh-83638: Add sqlite3.Connection.autocommit for PEP 249 compliant behaviour ( #93823 )
...
Introduce the autocommit attribute to Connection and the autocommit
parameter to connect() for PEP 249-compliant transaction handling.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2022-11-12 23:44:41 +01:00
dfc1b17a23
gh-99392: Fix sqlite3 converter recipes ( #99393 )
2022-11-12 20:39:37 +01:00
73a921b070
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-12 10:39:47 -08:00
aa874326d8
GH-94597: add deprecation warnings for subclassing `AbstractChildWatcher` ( #99386 )
2022-11-11 23:17:53 -08:00
c3c3871415
gh-87604: Clarify in docs that sys.addaudithook is not for sandboxes (GH-99372)
2022-11-11 13:35:02 +00:00
2f4af2d99c
GH-99183: Document behavior of count() for empty substrings (GH-99339)
2022-11-10 15:20:01 -06:00
58ee5d8677
Update reference to the size of PyPI ( #99076 )
...
Update reference to the size of PyPI
Last changed in 2008 (528576031d
2022-11-09 11:26:46 -08:00
2eee9d9cd7
gh-99238: clarify the type of the env dict. ( #99253 )
2022-11-08 13:00:31 -08:00
acf4d5d5bd
Fix broken link in `asyncio-subprocesses` doc (GH-99214)
...
# 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.html#asyncio.subprocess.Process ) for the function ``wait_for``:
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:
Automerge-Triggered-By: GH:AlexWaygood
2022-11-08 08:26:06 -08:00
e56e33d271
gh-72719: Remove asyncore and asynchat modules ( #96580 )
...
Remove modules asyncore and asynchat, which were deprecated by PEP 594.
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-11-08 16:48:58 +01:00
b9dedfe61d
gh-92119: ctypes: Print exception class name instead of its representation ( #98302 )
2022-11-07 20:53:59 -08:00
80c08d1cd6
gh-95389: expose popular ETHERTYPE_* constants in the socket module ( #95390 )
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-07 15:27:37 +01:00
e02f1e2df9
Docs: add argument spec to sqlite3 CLI docs ( #99200 )
2022-11-07 14:18:36 +01:00
2db55e0c00
gh-94286 Fix documentation of print default param (GH-94297)
2022-11-06 20:14:58 +00:00
8feb7ab77c
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')`
2022-11-05 18:01:08 -07:00
c0bf7607a1
minor edits to locale doc ( #98537 )
2022-11-04 06:02:11 -07:00
016c7d37b6
Docs: add `named` to the list of styles in the sqlite3.paramstyle attr docs ( #99078 )
2022-11-04 00:21:01 +01:00
a60ddd31be
gh-98401: Invalid escape sequences emits SyntaxWarning ( #99011 )
...
A backslash-character pair that is not a valid escape sequence now
generates a SyntaxWarning, instead of DeprecationWarning. For
example, re.compile("\d+\.\d+") now emits a SyntaxWarning ("\d" is an
invalid escape sequence), use raw strings for regular expression:
re.compile(r"\d+\.\d+"). In a future Python version, SyntaxError will
eventually be raised, instead of SyntaxWarning.
Octal escapes with value larger than 0o377 (ex: "\477"), deprecated
in Python 3.11, now produce a SyntaxWarning, instead of
DeprecationWarning. In a future Python version they will be
eventually a SyntaxError.
codecs.escape_decode() and codecs.unicode_escape_decode() are left
unchanged: they still emit DeprecationWarning.
* The parser only emits SyntaxWarning for Python 3.12 (feature
version), and still emits DeprecationWarning on older Python
versions.
* Fix SyntaxWarning by using raw strings in Tools/c-analyzer/ and
wasm_build.py.
2022-11-03 17:53:25 +01:00
cff1c20667
gh-94199: Remove ssl.wrap_socket() documentation ( #99023 )
...
The function has been removed. In the ssl documentation, replace
references to the ssl.wrap_socket() function with references to the
ssl.SSLContext.wrap_socket() method.
Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
2022-11-03 13:33:33 +01:00
f4adb97506
GH-96793: Implement PEP 479 in bytecode. (GH-99006)
...
* Handle converting StopIteration to RuntimeError in bytecode.
* Add custom instruction for converting StopIteration into RuntimeError.
2022-11-03 11:38:51 +00:00
e9ac890c02
gh-98740: Fix validation of conditional expressions in RE (GH-98764)
...
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.
2022-11-03 09:23:46 +02:00
898d0d9ad8
gh-92679: Clarify asyncio.loop.start_tls parameters ( #92682 )
2022-11-01 21:52:19 -07:00
65d1407737
gh-92871: Postpone the removal of typing.{io,re} to 3.13 ( #98958 )
2022-11-01 20:51:45 -07:00
c1c3be0f9d
Doc: Fix sphinx-lint issues (GH-98911)
...
They were introduced right between GH-98441 and GH-98408.
2022-10-31 16:30:29 +01:00
880bafc574
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
2022-10-31 11:02:02 -04:00
018b2483c4
gh-97966: Update uname docs to clarify the special nature of the platform attribute and to indicate when it became late-bound. ( #97972 )
2022-10-30 11:53:58 -04:00
bfecff5f73
Fix typo in docs (GH-98863)
2022-10-29 15:44:06 -05:00
d10c2b9742
dataclasses docs: consistent indentation (4 spaces) in examples ( #98855 )
2022-10-29 18:06:52 +01:00
0023f51deb
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
2022-10-28 16:31:37 -07:00
e089f23bbb
gh-84538: add strict argument to pathlib.PurePath.relative_to (GH-19813)
...
By default, :meth:`pathlib.PurePath.relative_to` doesn't deal with paths that are not a direct prefix of the other, raising an exception in that instance. This change adds a *walk_up* parameter that can be set to allow for using ``..`` to calculate the relative path.
example:
```
>>> p = PurePosixPath('/etc/passwd')
>>> p.relative_to('/etc')
PurePosixPath('passwd')
>>> p.relative_to('/usr')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "pathlib.py", line 940, in relative_to
raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' does not start with '/usr'
>>> p.relative_to('/usr', strict=False)
PurePosixPath('../etc/passwd')
```
https://bugs.python.org/issue40358
Automerge-Triggered-By: GH:brettcannon
2022-10-28 16:20:14 -07:00
72fa57a8fe
Fix typo in contextvars docs ( #98823 )
2022-10-28 22:13:48 +01:00
b27b57c6e4
`argparse` docs: normalize constant references ( #98765 )
2022-10-28 13:15:39 +01:00
c144e57b31
gh-98657: [docs] `array.typecodes` is a module-level attribute ( #98729 )
...
* gh-98657: [docs] `array.typecodes` is a module-level attribute
* Update array.rst
2022-10-28 12:26:01 +02:00
8cd21c2c5d
gh-65002: Make note that null bytes are used to pad bytes ( #98635 )
2022-10-28 12:21:28 +02:00
723ebe76e7
gh-96143: Improve perf profiler docs ( #96445 )
2022-10-27 14:06:48 +01:00
22863df7ca
GH-96793: Change `FOR_ITER` to not pop the iterator on exhaustion. (GH-96801)
...
Change FOR_ITER to have the same stack effect regardless of whether it branches or not.
Performance is unchanged as FOR_ITER (and specialized forms jump over the cleanup code).
2022-10-27 11:55:03 +01:00
365852a03a
gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs ( #98720 )
2022-10-26 16:53:46 +02:00
5e74bad93c
gh-98644: point people to tomllib from configparser’s docs ( #98645 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-26 07:06:20 -07:00
216f45e4fe
gh-98348: Mention ReferenceError in weakref.proxy documentation ( #98355 )
2022-10-25 20:48:24 -07:00
268129a74f
docs: Change links to label refs ( #98454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-25 20:26:28 -07:00
0ca6a4d640
gh-77753: Add example for values that compare equal in stdtypes ( #98497 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-25 19:54:27 -07:00
4196ee5c8b
gh-84747: Add `async for` comment for StreamReader ( #98633 )
2022-10-25 19:16:18 -07:00
5d8bf2b106
gh-97937: dis docs: add adaptive=False ( #97939 )
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
2022-10-25 15:58:04 -07:00
be0cf82ae4
gh-98602: [typing docs] Use quotes for forward reference in TypeVarTuple example ( #98605 )
2022-10-25 16:32:52 +01:00
5076108872
gh-98623: Fix base classes in `typing.rst` ( #98626 )
2022-10-25 07:06:13 -07:00
e3b9dd8e87
gh-98507: [typing docs] Rephrase "now supports `[]`" to "now supports subscripting" ( #98508 )
2022-10-24 19:10:25 +01:00
2fdcc6f2cb
GH-91635: clarify docs about closing of transport in asyncio ( #98563 )
2022-10-24 10:52:02 -07:00
1a217f9ffc
gh-98500: Fix typing docs for `*View` classes ( #98511 )
2022-10-24 10:47:32 -07:00
b6d5d5b60a
gh-98561: Fix a typo in typing (GH-98562)
2022-10-23 22:05:08 +08:00
8f30267ab4
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section ( #98304 )
2022-10-22 20:12:04 +01:00
327fc1c6fa
[Enum docs]: fix order of arguments to isinstance() ( #98542 )
2022-10-22 12:29:00 +01:00
d9407b174c
gh-51511: Note that codecs.open()'s encoding parameter affects automatic conversion to binary mode ( #94370 )
2022-10-21 16:01:05 -07:00
3e95ffc7ae
gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values (GH-98455)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-21 15:36:41 -07:00
a371a7e03e
gh-95023: Added os.setns and os.unshare functions ( #95046 )
...
Added os.setns and os.unshare to easily switch between namespaces
on Linux.
Co-authored-by: Christian Heimes <christian@python.org>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Victor Stinner <vstinner@python.org>
2022-10-20 11:08:54 +02:00
1a6bacb31f
[doc] Refresh the venv introduction documentation, and correct the statement about VIRTUAL_ENV (GH-98350)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-19 15:49:34 +01:00
a53f637368
Fix markup indentation (GH-98424)
...
Fix markup
2022-10-18 20:14:41 -05:00
f4ead4874b
General improvements to the itertools docs (GH-98408)
2022-10-18 14:09:34 -05:00
2eb503e4dd
Doc: Found some remaining default roles. (GH-98392)
2022-10-18 15:46:18 +02:00
0bbea545e3
Doc: missing underscore in hyperlink. (GH-98391)
2022-10-18 15:28:19 +02:00
de3ece769a
GH-98363: Add itertools.batched() (GH-98364)
2022-10-17 18:53:45 -05:00
70732d8a4c
Move random selection recipes from itertools.rst to random.rst (GH-98369)
2022-10-17 17:30:49 -05:00
1863302d61
gh-97669: Create Tools/build/ directory ( #97963 )
...
Create Tools/build/ directory. Move the following scripts from
Tools/scripts/ to Tools/build/:
* check_extension_modules.py
* deepfreeze.py
* freeze_modules.py
* generate_global_objects.py
* generate_levenshtein_examples.py
* generate_opcode_h.py
* generate_re_casefix.py
* generate_sre_constants.py
* generate_stdlib_module_names.py
* generate_token.py
* parse_html5_entities.py
* smelly.py
* stable_abi.py
* umarshal.py
* update_file.py
* verify_ensurepip_wheels.py
Update references to these scripts.
2022-10-17 12:01:00 +02:00
5c9302d03a
gh-85525: Remove extra row in doc ( #98337 )
...
* remove extra row
* 📜 🤖 Added by blurb_it.
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2022-10-16 13:43:31 -04:00
79fd6ccdbe
gh-85299: Add note warning about entry point guard for asyncio example ( #93457 )
2022-10-16 10:04:43 -07:00
f6b1e4048d
gh-98307: Add docstring and documentation for SysLogHandler.createSocket (GH-98319)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-16 09:15:46 +01:00
660f10248b
GH-94597: Deprecate child watcher getters and setters ( #98215 )
...
This is the next step for deprecating child watchers.
Until we've removed the API completely we have to use it, so this PR is mostly suppressing a lot of warnings when using the API internally.
Once the child watcher API is totally removed, the two child watcher implementations we actually use and need (Pidfd and Thread) will be turned into internal helpers.
2022-10-15 16:09:30 -07:00
3a639bbeac
Improve speed. Reduce auxiliary memory to 16.6% of the main array. (GH-98294)
2022-10-15 16:05:28 -05:00
02389658a4
docs(typing): harmonize "See PEP x for more details" ( #97927 )
2022-10-15 12:17:51 -07:00
f4370318d6
Faster sieve() recipe ( #98287 )
2022-10-15 12:43:58 -05:00
bf786e6901
gh-85455: Add missing doc strings and improve docs ( #21573 )
...
* Add missing doc strings and improve docs
* Use imperative form
* Modify docstring wording
2022-10-15 09:31:06 -04:00
05c042e707
gh-85525: Indicate supported sound header formats ( #21575 )
...
* Indicate supported sound header formats
* modify file names
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-15 09:30:05 -04:00
3c4cbd177f
gh-91485: Doc: Using Python syntax to document builtin Python functions. (GH-96579)
2022-10-15 12:19:35 +02:00
c39a0c3354
gh-65046: Link to logging cookbook from asyncio docs ( #98207 )
2022-10-11 21:42:57 -07:00
3b33c2010a
Formatting fixes in contextlib docs ( #98111 )
2022-10-11 20:56:32 -07:00
ed6344eed0
gh-96130: Rephrase use of "typecheck" verb for clarity ( #98144 )
...
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
2022-10-11 19:37:58 -07:00
f0a680007f
gh-71616: Add note to warn against general translation of saxutils.escape() ( #93450 )
...
* Add note to warn against general translation of saxutils.escape()
* Use more direct wording
2022-10-11 05:27:49 -04:00
6a757da080
gh-88452: Add a warning about non-portability of environments. (GH-98155)
2022-10-10 19:27:52 +01:00
187e853690
gh-83940: os docs: Improve wording for getenv/getenvb ( #98113 )
2022-10-10 06:43:01 -07:00
281a3f18cc
gh-56133: copyreg docs: Clarify function/constructor parameter ( #95497 )
2022-10-09 17:51:02 -07:00
6b485629d2
gh-97822: Fix http.server documentation reference to test() function ( #98027 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-10-07 21:46:23 -07:00
0f498f1a95
gh-57179: Add note on symlinks for os.walk ( #94799 )
2022-10-07 15:51:50 -07:00
5eaf4d6101
gh-61105: Add default param, note on using cookiejar subclass ( #95427 )
2022-10-07 15:21:13 -07:00
eed80458e8
gh-91708: Revert params note in urllib.parse.urlparse table ( #96699 )
...
Revert params note in urllib.parse.urlparse table
2022-10-07 12:19:36 -07:00
676d8ef380
gh-65496: Correct wording on csv's skipinitialspace argument ( #96170 )
2022-10-07 11:15:34 -07:00
4a74e6ab38
gh-64921: Clarify wording for open()'s newline arg ( #96171 )
2022-10-07 11:12:08 -07:00
002252c4ad
gh-97669: Move difflib examples to Doc/includes/ ( #97964 )
...
Remove diff.py and ndiff.py scripts of Tools/scripts/: move them to
Doc/includes/.
* diff.py and ndiff.py files are no longer executable. Remove also
their shebang ("#!/usr/bin/env python3").
* Remove the -profile command from ndiff.py to simply the code.
* Remove ndiff.py copyright and history command. The Python
documentation examples are distributed under the "Zero Clause BSD
License".
2022-10-07 10:57:48 -07:00
6592a62ec2
gh-71316: Update dis documentation to include changes to jump arguments (GH-95798)
2022-10-07 14:54:21 +01:00
e500cc0451
Misc updates to the itertools recipes and tests (GH-98018)
2022-10-07 03:37:21 -05:00
66cc46b2e4
Doc: sphinx-lint finds two other default roles. (GH-98019)
2022-10-07 09:10:51 +02:00
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
27025e158c
gh-97850: Remove deprecated functions from `importlib.utils` ( #97898 )
...
* gh-97850: Remove deprecated functions from `importlib.utils`
* Rebase and remove `set_package` from diff
2022-10-06 17:57:10 -07:00
09de8d7aaf
GH-90985: Revert "Deprecate passing a message into cancel()" ( #97999 )
...
Reason: we were too hasty in deprecating this.
We shouldn't deprecate it before we have a replacement.
2022-10-06 17:30:27 -07:00
e1c4d56fdd
gh-65961: Do not rely solely on `__cached__` (GH-97990)
...
Make sure `__spec__.cached` (at minimum) can be used.
2022-10-06 15:40:22 -07:00
8af04cdef2
gh-97781: Apply changes from importlib_metadata 5. (GH-97785)
...
* gh-97781: Apply changes from importlib_metadata 5.
* Apply changes from upstream
* Apply changes from upstream.
2022-10-06 15:25:24 -04:00
0d68879104
gh-95691: Doc BufferedWriter and BufferedReader ( #95703 )
2022-10-05 16:57:42 -07:00
74ea204634
GH-88968: Add notes about socket ownership transfers ( #97936 )
2022-10-05 16:42:01 -07:00
c206e53bb7
gh-65961: Raise `DeprecationWarning` when `__package__` differs from `__spec__.parent` ( #97879 )
...
Also remove `importlib.util.set_package()` which was already slated for removal.
Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
2022-10-05 15:00:45 -07:00
2016bc54a2
docs(typing): add "see PEP 675" to LiteralString ( #97926 )
2022-10-05 13:08:07 -07:00
0031e62973
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) ( #97768 )
...
:c:type:`<C type>` -> :c:expr:`<C type>`
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-10-05 11:01:14 -07:00
d6062d1170
GH-95172 Make the same version `versionadded` oneline ( #95172 )
...
* Make the same version versionadded oneline
* Format versionadded for enum.rst
* Format versionadded
A single line versionadded was reading better.
Co-authored-by: Senthil Kumaran <senthil@python.org>
2022-10-05 10:52:59 -07:00
e3ef400be7
gh-74696: Pass root_dir to custom archivers which support it (GH-94251)
...
Co-authored-by: Éric <merwok@netwok.org>
2022-10-05 12:48:59 +03:00
4b83cd0b22
gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs ( #97662 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-05 10:47:54 +02:00
8079bef56f
GH-96704: Add {Task,Handle}.get_context(), use it in call_exception_handler() ( #96756 )
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-10-04 23:49:10 -07:00
0ceafa7fa4
Add re.VERBOSE flag documentation example ( #97678 )
...
The current re.VERBOSE documentation example leaves space for ambiguous
interpretation. One may read that spaces within the `(?:` token are
spaces inside the non-capturing group (such as `(?: )`). This patch
removes the ambiguity by including examples after the statement.
2022-10-04 17:39:42 -07:00
a0f5599aac
gh-93738: Documentation C syntax (Use `c:struct`) ( #97772 )
...
Use `c:struct`
2022-10-04 16:26:14 -07:00
0bf6a617ed
gh-93738: Documentation C syntax (:c:type:`PyObject` -> :c:expr:`PyObject`) ( #97776 )
...
:c:type:`PyObject` -> :c:expr:`PyObject`
2022-10-04 16:13:03 -07:00
ff28d8926d
gh-88355: Fix backslashes in AF_PIPE ( #96543 )
...
Fix backslashes in AF_PIPE (#88355 )
The correct syntax for AF_PIPE addresses is `\\.\pipe\blahblah`, not `\.\pipe{blahblah}`, but the syntax markup messed up the backslashes.
2022-10-04 15:54:03 -07:00
743453a554
gh-58451: Add optional delete_on_close parameter to NamedTemporaryFile (GH-97015)
2022-10-04 23:37:33 +01:00
7acb93f0d4
gh-96448: fix documentation for _thread.lock.acquire ( #96449 )
...
* fix documentation for _thread.lock.acquire
* update formatting of _thread.lock.acquire() doc
2022-10-04 15:18:04 -07:00
87679a6e60
gh-90301: Doc: Add references to PEP 686 ( #96816 )
...
Doc: Add references to PEP 686.
2022-10-04 15:04:44 -07:00
53503ff60e
GH-82604: fix docs about configuring selector ( #97755 )
2022-10-04 09:45:37 -07:00
d053c47bfd
Minor grammar changes to http.client docs ( #96221 )
...
Minor grammar changes
2022-10-03 16:19:39 -07:00
0c91a12511
Update http.client.rst ( #24803 )
...
* Update http.client.rst
* Apply suggestions from code review
Co-authored-by: Éric <merwok@netwok.org>
* Update http.client.rst
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Senthil Kumaran <senthil@python.org>
2022-10-03 16:18:36 -07:00
d78aa4e11a
multiprocessing docs: Remove extra option ELLIPSIS from section with code ( #96625 )
2022-10-03 15:41:08 -07:00
0ea8b925d0
Document that MozillaCookieJar works for curl's cookie files ( #91852 )
...
MozillaCookieJar works for curl's cookies
2022-10-03 15:07:54 -07:00
64fe343717
gh-97681: Remove Tools/demo/ directory ( #97682 )
...
Remove the Tools/demo/ directory which contained old demo scripts. A
copy can be found in the old-demos project:
https://github.com/gvanrossum/old-demos
Remove the following old demo scripts:
* beer.py
* eiffel.py
* hanoi.py
* life.py
* markov.py
* mcast.py
* queens.py
* redemo.py
* rpython.py
* rpythond.py
* sortvisu.py
* spreadsheet.py
* vector.py
Changes:
* Remove a reference to the redemo.py script in the regex howto
documentation.
* Remove a reference to the removed Tools/demo/ directory in the
curses documentation.
* Update PC/layout/ to remove the reference to Tools/demo/ directory.
2022-10-03 17:09:02 +02:00
e6f9ec5c03
Fix typo in unittest docs ( #97742 )
2022-10-03 06:35:40 -07:00
9151bbefea
GH-85447: Clarify docs about awaiting future multiple times ( #97738 )
2022-10-02 15:16:51 -07:00
8baef8ae36
gh-95588: Drop the safety claim from `ast.literal_eval` docs. ( #95919 )
...
It was never really safe and this claim conflicts directly with the big warning in the docs about it being able to crash the interpreter.
2022-10-01 17:55:40 -07:00
bd7d0e875e
Fix capitalization of Unix in documentation ( #96913 )
2022-10-01 16:41:06 -07:00
f00645d5db
gh-90908: Document asyncio.Task.cancelling() and asyncio.Task.uncancel() ( #95253 )
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-10-01 10:42:36 -07:00
b05dd79649
gh-87597: Document TimeoutExpired.stdout & .stderr types ( #97685 )
...
This documents the behavior that has always been the case since timeout
support was introduced in Python 3.3.
2022-09-30 10:45:47 -07:00
9a11ed8e50
gh-96397: Document that attributes need not be identifiers ( #96454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-09-29 16:02:27 -07:00
c759944f16
gh-52597: Add position-only markers for os functions ( #94735 )
2022-09-28 18:06:50 -07:00
575a253b5c
GH-82448: Add thread timeout for loop.shutdown_default_executor ( #97561 )
...
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2022-09-28 10:39:42 -07:00
9a404b173e
fixup policy docs ( #97618 )
2022-09-28 10:34:49 -07:00
cc0f3a10f0
gh-96377: Update asyncio policy doc intro paras to be clear and accurate ( #97603 )
...
Also fix up some cross-references in the asyncio docs.
2022-09-27 16:47:14 -07:00
dd53b79de0
gh-96959: Update more HTTP links (GH-97536)
...
Use HTTPS for documents which are available by both HTTP and HTTPS
links, but there is no redirection from HTTP to HTTPS or vice versa.
2022-09-27 14:08:11 +03:00
d68c37c0d0
GH-65046: Fix docs about logging in `asyncio` ( #97559 )
...
Explain that logging should not use network I/O.
2022-09-26 15:27:15 -07:00
db39050396
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
2022-09-24 14:38:53 +03:00
a4ac14faa5
gh-77171: Fixes SubFormat check to compare the entire value. Add docs (GH-97509)
2022-09-23 16:08:21 +01:00
ec403536f1
include OrderedDict import in TimeBoundedLRU example (GH-96962)
2022-09-22 10:58:19 -05:00
b4f5f07d07
Doc: fix link redirect (GH-96606)
...
"Hyperbolic_function" -> "Hyperbolic_functions"
2022-09-21 21:47:46 +02:00
6ad47b41a6
gh-96727: Document restrictions on Handler.emit() with respect to locking. (GH-96948)
2022-09-20 09:40:06 +01:00
34de67c094
gh-96512: Update int_max_str docs to say 3.11 ( #96942 )
...
It was unknown if it'd be before 3.11.0 when creating the original
changes. It's in 3.11rc2, so 3.11 it is.
2022-09-19 16:43:11 -07:00
5b3a2569f4
gh-96917: link to typing.readthedocs.io from typing.rst ( #96921 )
...
See the discussion at https://github.com/python/cpython/issues/91533
2022-09-19 12:09:41 -07:00
bbc24b2bd5
GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
2022-09-18 16:36:20 -05:00
2d1a2d902a
fix various typos in random module's documentation (GH-96912)
2022-09-18 14:35:22 -07:00
810ae51787
gh-94787: [doc] Add to argparse doc an example of a mutually-exclusive group nested in an argument group (GH-94807)
2022-09-18 09:05:43 +01:00
670007abb4
Clarify that the expression is regular math notation, not Python. ( #96903 )
2022-09-17 21:09:39 -05:00
78359b1d45
Simplify sieve() recipe. Add edge case tests. (GH-96892)
2022-09-17 11:31:04 -05:00
e841ffc915
gh-95778: Mention sys.set_int_max_str_digits() in error message ( #96874 )
...
When ValueError is raised if an integer is larger than the limit,
mention sys.set_int_max_str_digits() in the error message.
2022-09-16 20:04:37 +02:00
16c33a9676
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions ( #96832 )
2022-09-15 23:11:52 +02:00
8dc9b3fbc1
Itertools sieve() recipe ( #96813 )
2022-09-13 21:10:47 -05:00
fd1e477f53
closes gh-96734: Update to Unicode 15.0.0. (GH-96809)
2022-09-13 15:45:12 -07:00
bf5fd49252
gh-95778: Fix `sys.set_int_max_str_digits()` parameter name ( #96798 )
...
Discovered in https://github.com/python/typeshed/pull/8733
2022-09-13 08:22:50 -07:00
49cceeb5c9
gh-96702: Order methods before attrs in sqlite3.Connection docs ( #96703 )
2022-09-13 10:28:57 +02:00
53a54b781d
gh-96706: [doc] Don't recomment deprecated use of get_event_loop() in examples ( #96707 )
2022-09-11 12:56:30 -07:00
6281affee6
gh-94972: document that shield users need to keep a reference to their task ( #96724 )
...
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
2022-09-10 07:34:14 -07:00
c06c001b30
gh-92734: Add indentation feature to reprlib.Repr (GH-92735)
2022-09-08 13:51:44 -05:00
d5e07862ec
gh-88287: Add BufferingFormatter documentation. (GH-96608)
2022-09-08 08:22:33 +01:00
c4999f261f
[doc] Update example in traceback doc (GH-96600)
...
This Monty Python reference is of-its-time. It could seem inappropriate in the context of today's sensibilities around mental health.
Automerge-Triggered-By: GH:iritkatriel
2022-09-05 14:30:51 -07:00
a9d58feccf
gh-84095: Fill documentation gap regarding user-defined objects. (GH-96574)
2022-09-05 07:47:47 +01:00
a0ad63e70e
gh-93973: Add all_errors to asyncio.create_connection ( #93974 )
...
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
2022-09-04 18:33:50 -07:00
9e55685782
Docs: alphabetically order sqlite3.Cursor attrs ( #96565 )
2022-09-04 23:34:45 +02:00
8464b754c4
gh-68163: Correct conversion of Rational instances to float (GH-25619)
...
* gh-68163: Correct conversion of Rational instances to float
Also document that numerator/denominator properties are instances of Integral.
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2022-09-04 13:15:59 +01:00
69bb83c2bf
gh-95778: remove unneeded doc note on float.as_integer_ratio ( #96553 )
...
Per mdickinson@'s comment on the main branch PR.
2022-09-04 00:04:36 -07:00
af6359dd5c
doc typo: spell limitation ( #96542 )
2022-09-03 23:23:32 -07:00
e5823bf9b5
gh-89087: Update logging.QueueHandler documentation to clarify record… (GH-96527)
2022-09-03 13:02:19 +01:00
57b6110361
[Enum] bump version tag on HTTP status category indicators (GH-96508)
2022-09-02 13:11:18 -07:00
ccce9b77e1
bpo-30419: DOC: Update missing information in bdb docs ( #1687 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Martin Panter <vadmium@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-09-02 13:22:42 -04:00
2a9e4e4d73
gh-95180: Add `TaskGroup` and `Runner` to AsyncIO API Index ( #95189 )
...
Also rearrange some items in the list.
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2022-09-02 09:36:45 -07:00
511ca94520
gh-95778: CVE-2020-10735: Prevent DoS by very large int() ( #96499 )
...
Integer to and from text conversions via CPython's bignum `int` type is not safe against denial of service attacks due to malicious input. Very large input strings with hundred thousands of digits can consume several CPU seconds.
This PR comes fresh from a pile of work done in our private PSRT security response team repo.
Signed-off-by: Christian Heimes [Red Hat] <christian@python.org>
Tons-of-polishing-up-by: Gregory P. Smith [Google] <greg@krypto.org>
Reviews via the private PSRT repo via many others (see the NEWS entry in the PR).
<!-- gh-issue-number: gh-95778 -->
* Issue: gh-95778
<!-- /gh-issue-number -->
I wrote up [a one pager for the release managers](https://docs.google.com/document/d/1KjuF_aXlzPUxTK4BMgezGJ2Pn7uevfX7g0_mvgHlL7Y/edit# ). Much of that text wound up in the Issue. Backports PRs already exist. See the issue for links.
2022-09-02 09:35:08 -07:00
656167db81
Allow whitespace around a slash in fraction string inputs (GH-96496)
2022-09-02 11:10:58 -05:00
91f40f3f78
gh-96168: Improve sqlite3 dict_factory example ( #96457 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-09-01 23:47:59 +02:00
4c72517cad
gh-93554: Conditional jump opcodes only jump forward (GH-96318)
2022-09-01 21:36:47 +01:00
615537e62f
gh-96408: Document difference between set-like view and sets. (GH-96439)
2022-08-31 16:23:52 -05:00
29f1b0bb1f
gh-89258: Add a getChildren() method to logging.Logger. (GH-96444)
...
Co-authored-by: Éric <merwok@netwok.org>
2022-08-31 10:50:29 +01:00
f7e7bf161a
gh-96414: Inline code examples in sqlite3 docs ( #96442 )
2022-08-31 07:54:54 +02:00
7b01ce7953
Docs: normalise sqlite3 placeholder how-to heading ( #96413 )
2022-08-30 22:44:14 +02:00
0ed778835d
gh-95149: Enhance `http.HTTPStatus` with properties that indicate the HTTP status category (GH-95453)
2022-08-30 11:11:44 -07:00
07f12b5c15
gh-95337: update TypeVarTuple example ( #95338 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-08-30 07:57:03 -07:00
860fa35145
Docs: Improve clarity for bytes.hex() ( #95257 )
2022-08-30 13:09:56 +02:00
6d403e264a
Docs: normalize SQL style in sqlite3 docs ( #96403 )
2022-08-30 00:50:42 +02:00
6324b135ac
gh-91305: Add a note about DatagramHandler and DNS latency. (GH-96380)
2022-08-29 22:29:22 +01:00
bf9259776d
gh-95432: Add doctests for the sqlite3 docs ( #96225 )
...
As a consequence of the added test, this commit also includes
fixes for broken examples.
- Add separate namespace for trace tests bco. module level callback
- Move more backup and cursor examples under separate namespaces
2022-08-29 10:52:39 +02:00
023c51d9d8
gh-69142: add %:z strftime format code (gh-95983)
...
datetime.isoformat generates the tzoffset with colons, but there
was no format code to make strftime output the same format.
for simplicity and consistency the %:z formatting behaves mostly
as %z, with the exception of adding colons. this includes the
dynamic behaviour of adding seconds and microseconds only when
needed (when not 0).
this fixes the still open "generate" part of this issue:
https://github.com/python/cpython/issues/69142
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-08-28 14:27:42 -07:00
35e4da25d4
Docs: Fix count of bullets in asyncio-task.rst ( #96307 )
2022-08-26 20:50:48 -07:00
b462f143ff
Fix documentation typo for pathlib.Path.walk (GH-96301)
2022-08-26 14:21:40 -07:00
0319cd6825
gh-96197: Define the behavior of repr if sys.displayhook is lost (gh-96242)
2022-08-26 11:02:57 +09:00
47d406ffc4
gh-96197: Fix expression when :func:`sys.breakpointhook is missing (gh-96293)
2022-08-26 10:43:02 +09:00
cd492d43a2
gh-76728: Coerce DictReader and DictWriter fieldnames argument to a list (GH-32225)
2022-08-25 05:13:24 -05:00
8db7693bbf
gh-91070: Add note about SysLogHandler on macOS 12.x (Monterey). (GH-94803)
2022-08-25 08:27:30 +01:00
e34c82abeb
GH-93503: Add thread-specific APIs to set profiling and tracing functions in the C-API ( #93504 )
...
* gh-93503: Add APIs to set profiling and tracing functions in all threads in the C-API
* Use a separate API
* Fix NEWS entry
* Add locks around the loop
* Document ignoring exceptions
* Use the new APIs in the sys module
* Update docs
2022-08-24 23:21:39 +01:00
4317b25a23
GH-96179: Fix misleading example on the bisect documentation (GH-96228)
...
The `movies[bisect(movies, 1960, key=by_year)]` will actually return only movies **after** 1960.
2022-08-24 17:47:13 +02:00
ram vikram singh
Skip Montanaro
Charles Machalow
Ronald Oussoren
GabrielAnguita
Julien Palard
Stanley
Alexander Ryabov
Irit Katriel
Adorilson Bezerra
Steve Dower
Kumar Aditya
Matt Harasymczuk
Erlend E. Aasland
naglis
Ethan Furman
Raymond Hettinger
jmcb
Gregory P. Smith
Mikael Koli
Nikita Sobolev
Kamil Turek
Noam Cohen
Nouran Ali
Nick Pope
Victor Stinner
Mark Shannon
Serhiy Storchaka
Oleg Iarygin
Sebastian Rittau
Shantanu
Jason R. Coombs
Yuvi Panda
FC Stegerman
Mateusz
domragusa
cburroughs
Philipp A
fancidev
Jelle Zijlstra
Eclips4
Omkaar
C.A.M. Gerlach
Clément Robert
Phil Elson
Joannah Nanjekye
Vinay Sajip
Simon Legner
JasonYZ
Christopher Chianelli
Hugo van Kemenade
Guido van Rossum
Brett Cannon
180909
Adam Turner
Jia Junjie
Athos Ribeiro
cousteau
Ev2geny
Daniel Giger
Inada Naoki
Rohan Shah
Géry Ogam
Ivan Kapeykin
Boris Verkhovskiy
annonm
Will Hawkins
Łukasz Langa
Jeff Allen
Harry
partev
Scott Main
Benjamin Peterson
Alex Waygood
zhanpon
Hendrik Makait
finefoot
Pamela Fox
Sergey B Kirpichev
Mehrdad Moradizadeh
Alexandru Mărășteanu
Cheryl Sabella
siph
Gregory P. Smith
Erlend E. Aasland
Piotr Kaznowski
Adrian Garcia Badaracco
Tim Burke
TW
Ansab Gillani
Dong-hee Na
Sam Ezeh
Pablo Galindo Salgado
prego
