1821 commits

Author	SHA1	Message	Date
Petr Viktorin	73e1207a4e	gh-135913: Document ob_refcnt, ob_type, ob_size (GH-135914) ... * gh-135913: Document ob_refcnt, ob_type, ob_size In `typeobj.rst`, instead of `:c:member:` it would be better to use `.. c:member::` with a `:no-index:` option, see: See ref. https://www.sphinx-doc.org/en/master/usage/domains/index.html#basic-markup However, `c:member` currently does not support `:no-index:`.	2025-07-07 14:05:17 +02:00
Petr Viktorin	2468aafe98	gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) ... * Turn the __future__ table to list-table. This'll make it easier to add entries that need longer markup * Semantic markup for __future__ feature descriptions. * Document CO_* C macros.	2025-07-07 12:31:13 +02:00
Victor Stinner	da79ac9d26	gh-135075: Make PyObject_SetAttr() fail with NULL value and exception (#136180) ... Make PyObject_SetAttr() and PyObject_SetAttrString() fail if called with NULL value and an exception set.	2025-07-03 14:51:44 +02:00
Sam Gross	f41e9c750e	gh-134009: Expose PyMutex_IsLocked in the public C API (gh-134365) ... The `PyMutex_IsLocked()` function is useful in assertions for verifying that code maintains certain locking invariants.	2025-07-01 13:26:13 -04:00
Nicolas Trangez	579acf4562	gh-76595: Add note on PyCapsule_Import behavior (GH-134022)	2025-06-28 09:01:41 -04:00
Brian Schubert	34ce1920ca	Docs: Fix duplicate word typos (GH-135958)	2025-06-26 20:00:19 -04:00
Peter Bierma	ca87a47b3d	gh-135755: Docs: C API: Document missing PyFunction_GET* macros (GH-135762) ... Co-authored-by: Brian Schubert <brianm.schubert@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>	2025-06-25 08:44:55 +00:00
Petr Viktorin	6aa0826ed7	gh-89488: Add warning about Py_BuildValue("p") needing exact int (GH-135610)	2025-06-23 12:35:59 +02:00
Rafael Fontenelle	6a16b3c440	Docs: Remove unnecessary trailing backslashes (GH-135781) ... This fixes Sphinx's gettext extraction for translations.	2025-06-21 09:01:14 -04:00
Yuki Kobayashi	59963e866a	Docs: Document PyExceptionClass functions in the C API (GH-135697) ... * Docs: Document `PyExceptionClass_Name` `PyExceptionClass_Name` is an undocumented function in the limited API. * Document `PyExceptionClass_Check`	2025-06-20 09:57:04 -04:00
Petr Viktorin	140731ff67	Document that PyType_GetModuleByDef returns a borrowed reference (GH-135666)	2025-06-19 09:00:41 +02:00
Yuki Kobayashi	46c60e0d0b	Docs: Fix markups for emphasis (GH-135598) ... The word emphasis character `_` is not supported as sphinx markup, so changed to `*`.	2025-06-18 13:32:43 -04:00
Petr Viktorin	f4bc3a9320	gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) ... Document behaviour of single-phase init. Call it "legacy". Reorganize PyModule docs. Move PyInit_modulename docs from the tutorial to reference documentation. Move PyMODINIT_FUNC docs from generic macros to the new page. Add doc stubs for `PYTHON_API_VERSION` & `PYTHON_ABI_VERSION` Remove incorrect refcounts.dat entry for `PyModuleDef_Init`. This removes the "Return value: Borrowed reference." note. Instead, note that the function sometimes returns a borrowed reference, sometimes as strong one. (IMO, it's best to not think of `PyModuleDef` as a `PyObject` at all, and act like it can't be reference-counted.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>	2025-06-13 16:39:35 +02:00
Malcolm Smith	b706ff003c	gh-133264: Correct documentation of how Py_Main and Py_RunMain handle SystemExit (#135337)	2025-06-11 17:23:47 +02:00
Victor Stinner	aaad2e81ce	gh-133968: Update PyUnicodeWriter_WriteASCII() documentation (#135297) ... The function was added to Python 3.14.	2025-06-09 14:47:02 +02:00
Edward Z. Yang	8441b263af	bpo-45210: Document that error indicator may be set in tp_dealloc (#28358) ... Signed-off-by: Edward Z. Yang <ezyang@fb.com> Signed-off-by: Edward Z. Yang <ezyang@meta.com> Co-authored-by: Victor Stinner <vstinner@python.org>	2025-06-09 08:56:32 +00:00
Yuki Kobayashi	f00512db20	Docs: Update PyExc_* tables in the c-api documentation (GH-131640) ... Add `PyExc_BaseExceptionGroup` and `PyExc_EncodingWarning`	2025-06-06 17:51:47 +02:00
Petr Viktorin	e413e26719	gh-134891: Add PyUnstable_Unicode_GET_CACHED_HASH (GH-134892)	2025-06-06 15:51:00 +02:00
Rafael Fontenelle	39859fcac5	Fix versionadded directive rendering in c-api/arg.rst (#135199)	2025-06-06 14:23:07 +02:00
Stan Ulbrych	0ac9e17fb4	gh-134830: Fix reference in Doc/extending/windows.rst (GH-134831) ... Co-authored-by: Miro Hrončok <miro@hroncok.cz>	2025-06-03 00:08:20 +02:00
Rafael Fontenelle	c7051a3669	Remove newline in Doc/c-api/lifecycle.rst for gettext builder (GH-135013)	2025-06-02 21:13:08 +03:00
Petr Viktorin	eb145fabbd	gh-134160: Improve multi-phase init note on isolation & subinterpreters (GH-134775) ... Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2025-05-30 16:27:54 +02:00
Inada Naoki	b367e27af9	Doc: remove unnecessary section header (GH-134917)	2025-05-30 17:59:23 +09:00
Victor Stinner	f49a07b531	gh-133968: Add PyUnicodeWriter_WriteASCII() function (#133973) ... Replace most PyUnicodeWriter_WriteUTF8() calls with PyUnicodeWriter_WriteASCII(). Unrelated change to please the linter: remove an unused import in test_ctypes. Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>	2025-05-29 14:54:30 +00:00
Petr Viktorin	4109a9c6b3	gh-133260: Remove claim that PyUnicode_InternFromString immortalizes (GH-134213)	2025-05-29 15:36:59 +02:00
Serhiy Storchaka	bac3fcba5b	gh-108512: Add and use new replacements for PySys_GetObject() (GH-111035) ... Add functions PySys_GetAttr(), PySys_GetAttrString(), PySys_GetOptionalAttr() and PySys_GetOptionalAttrString().	2025-05-28 20:11:09 +03:00
Victor Stinner	c3c88064f5	gh-133678: Document C API third party tools (#134526) ... Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Steve Dower <steve.dower@python.org>	2025-05-27 17:38:30 +02:00
neonene	96905bdd27	gh-134160: Use multi-phase init in documentation examples (#134296) ... Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2025-05-26 21:43:35 +00:00
Julien Palard	24a47155d2	Fix sphinx-lint warnings (default-role used). (GH-134647)	2025-05-25 21:22:52 +02:00
Cody Maloney	b529b60fc2	gh-132246: Add special buffer methods to C API Type Object docs (gh-132247) ... Two special methods, __buffer__ and __release_buffer__ were added to Python 3.12 by PEP 688. The C API Type Object documentation for slots includes `tp_as_buffer`, and sub-slots `bf_getbuffer`, `bf_releasebuffer` but does not refer to the Python Data Model version of those. Add the missing references.	2025-05-21 16:21:57 +02:00
Richard Hansen	3246ea514d	gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) ... * Add "cyclic isolate" to the glossary. * Add a new "Object Life Cycle" page. * Improve docs for related API, with special focus on cross-references and warnings Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Peter Bierma <zintensitydev@gmail.com>	2025-05-20 14:25:50 +02:00
da-woods	bb32f3c698	document Py_VISIT as a macro in the docs (#133688)	2025-05-18 21:58:43 +05:30
Peter Bierma	af6b3b825f	Docs: C API: Improve documentation around non-Python threads with subinterpreters (GH-131087) ... Co-authored-by: Victor Stinner <vstinner@python.org>	2025-05-17 10:58:41 +02:00
Stan Ulbrych	f34ec09ba5	gh-46236: Document PyUnicode_BuildEncodingMap (#133270)	2025-05-09 17:19:07 +02:00
Bénédikt Tran	3ed8d6fdd1	gh-133644: update Py_InteractiveFlag deprecation notice (#133749)	2025-05-09 15:42:42 +02:00
Bénédikt Tran	5044e85265	gh-133644: Remove deprecated Python initialization getter functions (#133661) ... Remove functions: * Py_GetExecPrefix() * Py_GetPath() * Py_GetPrefix() * Py_GetProgramFullPath() * Py_GetProgramName() * Py_GetPythonHome()	2025-05-09 11:39:23 +00:00
Xuehai Pan	f0f93ba5fa	gh-131942: Use the Python-specific Py_DEBUG macro rather than _DEBUG in Windows-related C code (GH-131944)	2025-05-08 15:01:25 +00:00
Bénédikt Tran	a2c4467d06	gh-133644: remove deprecated PyImport_ImportModuleNoBlock (#133655)	2025-05-08 13:08:43 +00:00
Hugo van Kemenade	b092705907	Python 3.14.0b1	2025-05-06 18:33:52 +03:00
Noah Kim	c4bcc6a778	gh-102567: Add -X importtime=2 for logging an importtime message for already-loaded modules (#118655) ... Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-05-06 01:03:55 +01:00
Peter Bierma	b275b8f342	gh-133140: Add PyUnstable_Object_IsUniquelyReferenced for free-threading (#133144)	2025-05-05 21:01:20 +02:00
Sam Gross	f2379535fe	gh-133164: Add PyUnstable_Object_IsUniqueReferencedTemporary C API (gh-133170) ... After gh-130704, the interpreter replaces some uses of `LOAD_FAST` with `LOAD_FAST_BORROW` which avoid incref/decrefs by "borrowing" references on the interpreter stack when the bytecode compiler can determine that it's safe. This change broke some checks in C API extensions that relied on `Py_REFCNT()` of `1` to determine if it's safe to modify an object in-place. Objects may have a reference count of one, but still be referenced further up the interpreter stack due to borrowing of references. This provides a replacement function for those checks. `PyUnstable_Object_IsUniqueReferencedTemporary` is more conservative: it checks that the object has a reference count of one and that it exists as a unique strong reference in the interpreter's stack of temporary variables in the top most frame. See also: * https://github.com/numpy/numpy/issues/28681 Co-authored-by: Pieter Eendebak <pieter.eendebak@gmail.com> Co-authored-by: T. Wouters <thomas@python.org> Co-authored-by: mpage <mpage@cs.stanford.edu> Co-authored-by: Mark Shannon <mark@hotpy.org> Co-authored-by: Victor Stinner <vstinner@python.org>	2025-05-02 13:24:57 +00:00
Sergey B Kirpichev	ad2f0884b1	gh-130317: Fix test_pack_unpack_roundtrip() and add docs (#133204) ... * Skip sNaN's testing in 32-bit mode. * Drop float_set_snan() helper. * Use memcpy() workaround for sNaN's in PyFloat_Unpack4(). * Document, that sNaN's may not be preserved by PyFloat_Pack/Unpack API.	2025-05-01 16:20:36 +02:00
Stan Ulbrych	bba14c3e01	gh-46236: Document PyUnicodeIter_Type (GH-132925)	2025-04-29 14:23:06 +02:00
Eric Snow	fe462f5a91	gh-132775: Drop PyUnstable_InterpreterState_GetMainModule() (gh-132978) ... We replace it with _Py_GetMainModule(), and add _Py_CheckMainModule(), but both in the internal-only C-API. We also add _PyImport_GetModulesRef(), which is the equivalent of _PyImport_GetModules(), but which increfs before the lock is released. This is used by a later change related to pickle and handling __main__.	2025-04-28 12:46:22 -06:00
Petr Viktorin	4ebbfcf30e	gh-87135: Raise PythonFinalizationError when joining a blocked daemon thread (gh-130402) ... If `Py_IsFinalizing()` is true, non-daemon threads (other than the current one) are done, and daemon threads are prevented from running, so they cannot finalize themselves and become done. Joining them (without timeout) would block forever. Raise PythonFinalizationError instead of hanging. Raise even when a timeout is given, for consistency with trying to join your own thread. See gh-123940 for a use case: calling `join()` from `__del__`. This is ill-advised, but an exception should at least make it easier to diagnose.	2025-04-28 15:48:48 +02:00
Serhiy Storchaka	632524a5cb	gh-132987: Support __index__() for "k" and "K" formats in PyArg_Parse (GH-132988)	2025-04-26 17:14:18 +03:00
Victor Stinner	ac5424d6a9	gh-107954: Add audit event to PyConfig_Set() (#132958)	2025-04-25 18:30:39 +02:00
Victor Stinner	070d866567	gh-107954: Allow setting cpu_count in PyConfig_Set() (#132954) ... * gh-107954: Allow setting cpu_count in PyConfig_Set() * Update the doc	2025-04-25 18:29:55 +02:00
Bénédikt Tran	3fa024dec3	gh-132909: handle overflow for 'K' format in do_mkvalue (#132911)	2025-04-25 11:02:57 +00:00