6d30cbee01
Docs: Fix typo in code snippet (GH-114421)
2024-01-22 17:56:30 +02:00
650f9e4c94
gh-114115: Update documentation of array.array (GH-114117)
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 08:42:50 +00:00
fd49e22670
gh-114328: tty cbreak mode should not alter ICRNL ( #114335 )
...
The terminal CR -> NL mapping setting should be inherited in cbreak mode as OSes do not specify altering it as part of their stty cbreak mode definition.
2024-01-21 15:25:52 -08:00
336030161a
Docs: align sqlite3 docs with versionadded/versionchanged recommendations ( #114400 )
...
When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
2024-01-21 19:54:19 +00:00
de17cf444a
Docs: link to sys.stdout in ftplib docs ( #114396 )
2024-01-21 17:41:21 +00:00
38768e4cdd
gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect implementation ( #114385 )
2024-01-21 13:49:49 +01:00
96c15b1c8d
Docs: mark up FTP() constructor with param list ( #114359 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 12:27:33 +01:00
47133d8d86
gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` ( #114373 )
2024-01-21 11:34:43 +02:00
fbc28748ea
Docs: mark up the FTP debug levels as a list ( #114360 )
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-21 09:19:31 +00:00
b04c5005cc
Fix the confusing "User-defined methods" reference in the datamodel ( #114276 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-21 03:45:38 +00:00
8f4f773647
Docs: Add missing line continuation to FTP_TLS class docs ( #114352 )
...
Regression introduced by b1ad5a5d4
2024-01-20 19:39:44 +00:00
b1ad5a5d44
Docs: structure the ftplib reference ( #114317 )
...
Introduce the following headings and subheadings:
- Reference
* FTP objects
* FTP_TLS objects
* Module variables
2024-01-20 16:06:52 +01:00
e6495159f6
GH-99380: Update to Sphinx 7 ( #99381 )
2024-01-20 11:20:51 +00:00
567a85e9c1
gh-114332: Fix the flags reference for ``re.compile()`` ( #114334 )
...
The GH-93000 change set inadvertently caused a sentence in re.compile()
documentation to refer to details that no longer followed. Correct this
with a link to the Flags sub-subsection.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-20 11:17:41 +00:00
6313cdde58
GH-79634: Accept path-like objects as pathlib glob patterns. ( #114017 )
...
Allow `os.PathLike` objects to be passed as patterns to `pathlib.Path.glob()` and `rglob()`. (It's already possible to use them in `PurePath.match()`)
While we're in the area:
- Allow empty glob patterns in `PathBase` (but not `Path`)
- Speed up globbing in `PathBase` by generating paths with trailing slashes only as a final step, rather than for every intermediate directory.
- Simplify and speed up handling of rare patterns involving both `**` and `..` segments.
2024-01-20 02:10:25 +00:00
229ee5bea1
Retain shorter tables of contents for Sphinx 5.2.3+ ( #114318 )
...
Disable toc_object_entries, new in Sphinx 5.2.3
2024-01-19 18:52:42 +00:00
68a7b78cd5
gh-112092: clarify unstable ABI recompilation requirements ( #112093 )
...
Use different versions in the examples for when extensions do and do not need to be recompiled to make the examples easier to understand.
2024-01-18 21:04:40 +01:00
9c93350f58
gh-108303: Move all doctest related files and tests to `Lib/test/test_doctest/` ( #112109 )
...
Co-authored-by: Brett Cannon <brett@python.org>
2024-01-18 16:58:11 +01:00
ba683c22ec
gh-114231: Fix indentation in enum.rst ( #114232 )
2024-01-18 09:23:15 +00:00
8cda72037b
gh-114211: Update EmailMessage doc about ordered keys ( #114224 )
...
Ordered keys are no longer unlike 'real dict's.
2024-01-18 02:25:22 +00:00
f56d132deb
gh-112984 Update Windows build and installer for free-threaded builds (GH-113129)
2024-01-17 21:52:23 +00:00
7573c44c32
Fix typo in tkinter.ttk.rst (GH-106157)
2024-01-17 18:23:25 +00:00
029ecee10d
gh-114070: fix token reference warnings in expressions.rst ( #114169 )
2024-01-17 18:39:50 +02:00
f49752552e
gh-111301: Advertise importlib methods removal in What's new in Python 3.12 (GH-111630)
2024-01-17 15:25:42 +01:00
4a32275389
gh-72284: Revise lists in IDLE doc ( #114174 )
...
Tkinter is a fact, not necessarily a feature.
Reorganize editor key bindings in a logical order
and remove those that do not work, at least on Windows.
Improve shell bindings list.
2024-01-17 07:52:32 +00:00
8d26db45df
gh-112043: Align concurrent.futures.Executor.map docs with implementation ( #114153 )
...
The first parameter is named 'fn', not 'func'.
2024-01-17 01:31:16 +00:00
05008c27b7
gh-88531 Fix dataclass __post_init__/__init__ interplay documentation (gh-107404)
...
* Simplify __post_init__ example usage. It applies to all base classes, not just dataclasses.
2024-01-16 20:17:34 -05:00
45e527dfb5
GH-110109: pathlib docs: bring `from_uri()` and `as_uri()` together. ( #110312 )
...
This is a very soft deprecation of `PurePath.as_uri()`. We instead document
it as a `Path` method, and add a couple of sentences mentioning that it's
also available in `PurePath`.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-16 22:51:57 +00:00
1d6989f9b0
Fix typo in c_annotations.py comment ( #108773 )
...
"compatability" => "compatibility"
2024-01-16 23:36:01 +01:00
6e84f3b56f
gh-94220: Align fnmatch docs with the implementation and amend markup ( #114152 )
...
- Align the argument spec for fnmatch functions with the actual
implementation.
- Update Sphinx markup to recent recommandations.
- Add link to 'iterable' glossary entry.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-16 22:35:09 +00:00
7092b3f131
GH-78988: Document `pathlib.Path.glob()` exception propagation. ( #114036 )
...
We propagate the `OSError` from the `is_dir()` call on the top-level
directory, and suppress all others.
2024-01-16 22:28:54 +00:00
c86571e4c9
Update copyright years to 2024. (GH-113608)
...
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-16 21:54:05 +01:00
b1db6278cf
Docs: Improve multiprocessing.SharedMemory reference ( #114093 )
...
Align the multiprocessing shared memory docs with Diatáxis's
recommendations for references.
- use a parameter list for the SharedMemory.__init__() argument spec
- use the imperative mode
- use versionadded, not versionchanged, for added parameters
- reflow touched lines according to SemBr
2024-01-16 16:43:13 +00:00
31a2543c80
gh-114069: Revise Tutorial Methods paragraph ( #114127 )
...
Remove excess words in the first and third sentences.
2024-01-16 11:33:05 -05:00
d2d8332f71
gh-113626: Add allow_code parameter in marshal functions (GH-113648)
...
Passing allow_code=False prevents serialization and de-serialization of
code objects which is incompatible between Python versions.
2024-01-16 18:05:15 +02:00
a482bc67ee
gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557)
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-01-16 16:17:03 +01:00
af85274086
Docs: Align multiprocessing.shared_memory docs with Sphinx recommendations ( #114103 )
...
- add :class: and :mod: markups where needed
- fix incorrect escaping of a star in ShareableList arg spec
- mark up parameters with stars: *val*
- mark up list of built-in types using list markup
- remove unneeded parentheses from :meth: markups
2024-01-16 12:35:35 +00:00
8fd287b18f
gh-78502: Add a trackfd parameter to mmap.mmap() (GH-25425)
...
If *trackfd* is False, the file descriptor specified by *fileno*
will not be duplicated.
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-16 08:51:46 +01:00
4f24b92aa0
gh-114070: correct the specification of ``digit`` in the float() docs ( #114080 )
2024-01-15 14:19:59 -08:00
0f2fa6150b
gh-109598: make PyComplex_RealAsDouble/ImagAsDouble use __complex__ (GH-109647)
...
`PyComplex_RealAsDouble()`/`PyComplex_ImagAsDouble` now try to convert
an object to a `complex` instance using its `__complex__()` method
before falling back to the ``__float__()`` method.
PyComplex_ImagAsDouble() also will not silently return 0.0 for
non-complex types anymore. Instead we try to call PyFloat_AsDouble()
and return 0.0 only if this call is successful.
2024-01-15 16:04:17 +01:00
2010d45327
gh-113666: Adding missing UF_ and SF_ flags to module 'stat' ( #113667 )
...
Add some constants to module 'stat' that are used on macOS.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-15 12:22:43 +01:00
c2808431b3
gh-101100: Fix Sphinx warnings in `howto/urllib2.rst` and `library/http.client.rst` ( #114060 )
2024-01-14 20:38:53 +00:00
e4ff131e01
GH-44626, GH-105476: Fix `ntpath.isabs()` handling of part-absolute paths ( #113829 )
...
On Windows, `os.path.isabs()` now returns `False` when given a path that
starts with exactly one (back)slash. This is more compatible with other
functions in `os.path`, and with Microsoft's own documentation.
Also adjust `pathlib.PureWindowsPath.is_absolute()` to call
`ntpath.isabs()`, which corrects its handling of partial UNC/device paths
like `//foo`.
Co-authored-by: Jon Foster <jon@jon-foster.co.uk>
2024-01-13 07:36:05 +00:00
3aa4b839e4
gh-89159: Document missing TarInfo members ( #91564 )
2024-01-12 23:19:57 +00:00
a47353d587
datamodel: Fix a typo in ``object.__init_subclass__`` ( #111599 )
2024-01-12 22:59:24 +00:00
e97da8677f
Link to the glossary for "magic methods" in ``MagicMock`` ( #111292 )
...
The MagicMock documentation mentions magic methods several times without
actually pointing to the term in the glossary. This can be helpful for
people to fully understand what those magic methods are.
2024-01-12 22:54:36 +00:00
32f3684b8f
Tutorial: Clarify 'nonzero exit status' in the appendix ( #112039 )
2024-01-12 22:42:51 +00:00
dce30c9cbc
gh-95649: Document that asyncio contains uvloop code ( #107536 )
...
Some of the asyncio SSL changes in GH-31275 [1] were taken from
v0.16.0 of the uvloop project [2]. In order to comply with the MIT
license, we need to just need to document the copyright information.
[1]: https://github.com/python/cpython/pull/31275
[2]: https://github.com/MagicStack/uvloop/tree/v0.16.0
2024-01-12 22:21:13 +00:00
b44b9d9900
gh-113971: Make `zipfile.ZipInfo._compresslevel` public as `.compress_level` ( #113969 )
...
Make zipfile.ZipInfo.compress_level public.
A property is used to retain the behavior of the ._compresslevel.
People constructing zipfile.ZipInfo instances to pass into existing APIs to control per-file compression levels already treat this as public, there was never a reason for it not to be.
I used the more modern name compress_level instead of compresslevel as the keyword argument on other ZipFile APIs is called to be consistent with compress_type and a general long term preference of not runningwordstogether without a separator in names.
2024-01-12 20:15:05 +00:00
79970792fd
gh-113868: Add a number of MAP_* flags from macOS to module mmap ( #113869 )
...
The new flags were extracted from the macOS 14.2 SDK.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-12 16:56:18 +01:00
e68806c712
Docs: Amend codeobject.co_lines docs; end number is exclusive ( #113970 )
...
The end number should be exclusive, not inclusive.
2024-01-12 16:04:14 +01:00
53d2e1f26c
Improve kde graph with better caption and number formatting (gh-113967)
2024-01-11 18:25:18 -06:00
c9b8a22f34
GH-107678: Improve Unicode handling clarity in ``library/re.rst`` ( #107679 )
2024-01-11 23:56:10 +00:00
b4d4aa9e8d
gh-81489: Use Unicode APIs for mmap tagname on Windows (GH-14133)
...
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-11 22:39:47 +00:00
2f126a70f3
Update KDE recipe to match the standard use of the h parameter (gh-#113958)
2024-01-11 16:21:21 -06:00
ec23e90082
gh-112419: Document removal of sys.meta_path's 'find_module' fallback ( #112421 )
...
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-11 09:43:35 +00:00
1d75fa43a2
gh-77046: os.pipe() sets _O_NOINHERIT flag on fds ( #113817 )
...
On Windows, set _O_NOINHERIT flag on file descriptors
created by os.pipe() and io.WindowsConsoleIO.
Add test_pipe_spawnl() to test_os.
Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2024-01-10 23:02:17 +01:00
901a971e16
gh-113625: Align object addresses in the Descriptor HowTo Guide ( #113894 )
2024-01-10 17:23:40 +01:00
89cee94b31
gh-89850: Add default C implementations of persistent_id() and persistent_load() (GH-113579)
...
Previously the C implementation of pickle.Pickler and pickle.Unpickler
classes did not have such methods and they could only be used if
they were overloaded in subclasses or set as instance attributes.
Fixed calling super().persistent_id() and super().persistent_load() in
subclasses of the C implementation of pickle.Pickler and pickle.Unpickler
classes. It no longer causes an infinite recursion.
2024-01-10 15:30:37 +02:00
a8629816c6
gh-113664: Improve style of Big O notation (GH-113695)
...
Use cursive to make it looking like mathematic formulas.
2024-01-10 15:01:18 +02:00
3a9096c337
GH-113661: unittest runner: Don't exit 5 if tests were skipped ( #113856 )
...
The intention of exiting 5 was to detect issues where the test suite
wasn't discovered at all. If we skipped tests, it was correctly
discovered.
2024-01-09 19:50:01 +00:00
2fd2e74793
Simplify binomial approximation example with random.binomialvariate() (gh-113871)
2024-01-09 13:02:07 -06:00
2e17cad2b8
gh-101100: Fix Sphinx warnings for 2.6 port-specific deprecations ( #113752 )
2024-01-09 10:18:15 +02:00
f3d5d4aa8f
Docs: Link tokens in the format string grammars ( #108184 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-09 02:47:59 +00:00
c6ca562138
gh-113791: Expose CLOCK_MONOTONIC_RAW_APPROX and CLOCK_UPTIME_RAW_APROX on macOS in the time module ( #113792 )
2024-01-08 20:44:00 +01:00
aef375f56e
Minor algebraic simplification for the totient() recipe (gh-113822)
2024-01-08 13:16:22 -06:00
35fa13d48b
gh-113755: Fully adapt gcmodule.c to Argument Clinic ( #113756 )
...
Adapt the following functions to Argument Clinic:
- gc.set_threshold
- gc.get_referrers
- gc.get_referents
2024-01-08 18:32:34 +01:00
61dd77b04e
gh-113391: fix outdated PyObject_HasAttr docs ( #113420 )
...
After #53875 : PyObject_HasAttr is not an equivalent of hasattr.
PyObject_HasAttrWithError is; it already has the note.
2024-01-08 16:23:43 +01:00
f19b93fce0
gh-73965: New environment variable PYTHON_HISTORY ( #13208 )
...
It can be used to set the location of a .python_history file
---------
Co-authored-by: Levi Sabah <0xl3vi@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-06 22:30:12 -08:00
bbf214df23
gh-113537: support loads str in plistlib.loads ( #113582 )
...
Add support for loading XML plists from a string value instead of a only bytes value.
2024-01-06 10:26:59 +01:00
d99d871225
gh-113360: Fix the documentation of module's attribute __test__ (GH-113393)
...
It can only be a dict since Python 2.4.
2024-01-06 00:23:16 +02:00
eb53750757
gh-101100: Fix Sphinx warnings in `library/pyclbr.rst` ( #113739 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-05 19:15:07 +00:00
e56c53334f
gh-101100: Fix Sphinx warnings for 2.6 deprecations and removals ( #113725 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-05 13:31:28 +00:00
1ae7ceba29
gh-113696: Docs: Annotate PyObject_CallOneArg and PyObject_CallNoArgs as returning a strong reference ( #113697 )
2024-01-04 15:05:31 +01:00
f1f8392432
Document the `co_lines` method on code objects ( #113682 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-03 19:29:24 +00:00
fab7ad62ce
gh-101100: Fix Sphinx warnings for removed dead batteries ( #113669 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-03 13:04:26 +00:00
4de468cce1
`functools.partial` docs: Use the more common spelling for "referenceable" ( #113675 )
2024-01-03 12:50:44 +00:00
ea978c645e
gh-113637: Let c_annotations.py to handle the spacing of Limited/Unstable API & Stable ABI translation strings ( #113638 )
2024-01-03 13:22:38 +02:00
8ff44f8554
gh-81094: Refer to PEP 318 in compound_statements.rst ( #113588 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-02 10:40:14 +02:00
7595380347
gh-101100: Fix Sphinx warnings from removed `~!` references ( #113629 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-01-02 00:37:37 -07:00
b4b2cc1012
gh-53502: add a new option aware_datetime in plistlib to loads or dumps aware datetime. ( #113363 )
...
* add options to loads and dumps aware datetime in plistlib
2024-01-01 19:51:24 +01:00
d0b0e3d2ef
gh-113536: Expose `os.waitid` on macOS ( #113542 )
...
* gh-113536: Expose `os.waitid` on macOS
This API has been available on macOS for a long time, but was
explicitly excluded due to unspecified problems with the API
in ancient versions of macOS.
* Document that the API is available on macOS starting in Python 3.13
2024-01-01 19:38:29 +01:00
9ce6c01e38
# gh-111700: Fix syntax highlighting for C code in the "What's New In Python 3.12" documentation ( #113609 )
...
Fix PEP 684 syntax highlighting in what's new Python 3.12
2024-01-01 10:08:05 +02:00
2849cbb53a
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set ( #113369 )
2023-12-31 23:16:33 +00:00
30a6d79fb8
gh-101100: Fix Sphinx warnings in `library/configparser.rst` ( #113598 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-31 10:57:33 -07:00
471aa75241
Update ConfigParser docs defining valid section name ( #110506 )
2023-12-30 16:18:06 -07:00
f48a1bcb29
gh-89414: Document that SIGCLD is not available on macOS ( #113580 )
...
Document that SIGCLD is not available on macOS
2023-12-30 16:19:47 +01:00
88cb972000
gh-112536: Add support for thread sanitizer (TSAN) (gh-112648)
2023-12-30 17:17:02 +09:00
db1c882239
Doc/library/os.rst: `os.waitid` absent on MacOS ( #104558 )
...
* Doc/library/os.rst: `os.waitid` absent on MacOS
Co-authored-by: AN Long <aisk@users.noreply.github.com>
2023-12-28 20:36:20 +01:00
8e5d70f4b6
gh-101100: Fix Sphinx warnings in library/random.rst ( #112981 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-28 12:29:12 -07:00
bfee2f77e1
gh-73427: deprecate `_enablelegacywindowsfsencoding` ( #107729 )
2023-12-28 17:31:19 +09:00
0651936ae2
gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610)
2023-12-27 17:16:36 +00:00
1ddd773293
gh-64020: Deprecate pydoc.ispackage() (GH-20908)
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-12-27 14:04:31 +00:00
4acf825058
gh-101100: Fix Sphinx warnings in `library/cmd.rst` ( #113502 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-27 12:17:30 +02:00
fb02b66960
gh-101100: Fix Sphinx warnings in `library/calendar.rst` ( #113500 )
2023-12-27 09:36:17 +00:00
00cdd416fc
gh-113350: Improve the wording of python logging docs to remove an ambiguity around use of the word "higher". (GH-113491)
...
Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
2023-12-27 07:51:45 +00:00
2b53c767de
gh-101100: Fix Sphinx warnings in `library/bisect.rst` ( #113496 )
2023-12-26 14:12:15 -07:00
4e67644d36
gh-101100: Fix Sphinx warnings in `howto/isolating-extensions.rst` ( #113493 )
2023-12-26 12:40:48 -07:00
36adc79041
Docs: make htmllive: open browser when ready ( #113288 )
2023-12-26 05:02:13 -07:00
e87cadc1ce
gh-66515: mailbox.MH now supports folders withou the ".mh_sequences" file (GH-804)
...
(for example Claws Mail IMAP-cache folders).
2023-12-26 11:15:14 +02:00
Kirill Podoprigora
Serhiy Storchaka
Gregory P. Smith
Erlend E. Aasland
Nikita Sobolev
cdzhan
Adam Turner
David H. Gutteridge
Barney Gale
Hugo van Kemenade
DerSchinken
Miyashita Yosuke
Terry Jan Reedy
Steve Dower
Christophe Nanteuil
Sergey B Kirpichev
Karolina Surma
Steffen Zeile
Kuan-Wei Chiu
solya0x
AN Long
Zackery Spytz
Ronald Oussoren
Stanley
InSync
Pierre Equoy
Andrew Zipperer
Alois Klink
Ned Batchelder
Raymond Hettinger
Victor Stinner
Stefano Rivera
William Andrea
Jamie Phan
Alex Waygood
Hugo van Kemenade
Rodrigo Girão Serrão
Ege Akman
John D. McDonald
Parth Doshi
Irit Katriel
Delgan
Samet YASLAN
John Hawkinson
Inada Naoki
Vaishnavi Maheshwari