summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] gh-119467: Fix Py_buffer.format type and correct documentation typo ↵Miss Islington (bot)2024-05-271-2/+2
| | | | | | | | (GH-119475) (#119603) gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) (cherry picked from commit 3b26cd8ca0e6c65e4b61effea9aa44d06e926797) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
* [3.12] docs: fix a few typos identified by codespell (GH-119516) (#119571)Hugo van Kemenade2024-05-261-2/+2
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] Format None, True, False and NotImplemented as literals (GH-118758) ↵Serhiy Storchaka2024-05-081-1/+1
| | | | | (GH-118794) (cherry picked from commit 05c2fe1acda9ea5a57061642c36e8b73bb4fbba4)
* [3.12] gh-116935: Document that heap types need to support garbage ↵Miss Islington (bot)2024-04-191-1/+2
| | | | | | | | collection (GH-118021) (GH-118092) gh-116935: Document that heap types need to support garbage collection (GH-118021) (cherry picked from commit 5d544365742a117027747306e2d4473f3b73d921) Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
* [3.12] gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc ↵Miss Islington (bot)2024-04-191-0/+6
| | | | | | | | (GH-117920) (#118087) gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920) (cherry picked from commit 4605a197bd84da1a232bd835d8e8e654f2fef220) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] gh-73231: Update documentation for PyErr_SetFromWindowsErr() ↵Miss Islington (bot)2024-04-171-4/+5
| | | | | | | (GH-117226) (GH-117973) (cherry picked from commit 438b7c3071eebaccd1ba215f15a239345b22f813) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Docs: add link roles with Sphinx extlinks (GH-117850) (#117910)Hugo van Kemenade2024-04-151-1/+1
| | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-115664: Fix ordering of more versionadded and versionchanged ↵Serhiy Storchaka2024-03-074-8/+8
| | | | | directives (GH-116298) (GH-116450) (cherry picked from commit 808a77612fb89b125d25efac2788522a100e8a6d)
* [3.12] Fix the PyGetSetDef documentation (GH-116056) (GH-116363)Miss Islington (bot)2024-03-051-3/+3
| | | | | | closure is not a function pointer, it is a user data pointer. (cherry picked from commit df594011089a83d151ac7000954665536f3461b5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] gh-115653: Document PyCode_GetFirstFree() (GH-115654) (#115752)Miss Islington (bot)2024-02-211-2/+6
| | | | | | | | gh-115653: Document PyCode_GetFirstFree() (GH-115654) Correct the return type of the PyCode_GetNumFree() documentation. (cherry picked from commit 10fc4675fdb14e19f2fdd15102c6533b9f71e992) Co-authored-by: Bogdan Romanyuk <65823030+wrongnull@users.noreply.github.com>
* [3.12] gh-101100: Fix Sphinx warnings in `whatsnew/3.2.rst` (GH-115580) ↵Miss Islington (bot)2024-02-172-0/+52
| | | | | | | (#115589) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-113437: Update documentation about PyUnicode_AsWideChar() function ↵Miss Islington (bot)2024-02-141-1/+6
| | | | | | | (GH-113455) (GH-115407) (cherry picked from commit 5719aa23ab7f1c7a5f03309ca4044078a98e7b59) Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
* [3.12] gh-101100: Fix sphinx warnings in `c-api/gcsupport.rst` (GH-114786) ↵Miss Islington (bot)2024-02-131-3/+8
| | | | | | (#115263) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst ↵Miss Islington (bot)2024-02-112-18/+28
| | | | | | | | (GH-114825) (GH-115308) (cherry picked from commit e1552fd19de17e7a6daa3c2a6d1ca207bb8eaf8e) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.12] gh-115172: Fix explicit index extries for the C API (GH-115173) ↵Serhiy Storchaka2024-02-1111-150/+147
| | | | | (GH-115292) (cherry picked from commit 573acb30f22a84c0f2c951efa002c9946e29b6a3)
* [3.12] Docs: correctly link to code objects (GH-115214) (#115216)Miss Islington (bot)2024-02-091-2/+3
| | | | | (cherry picked from commit 769d4448260aaec687d9306950225316f9faefce) Co-authored-by: Erlend E. Aasland <erlend@python.org>
* [3.12] gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003) (#115135)Miss Islington (bot)2024-02-071-5/+6
| | | | | | gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003) (cherry picked from commit d0322fdf2c1a7292a43959fe5a572d783b88a1c4) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.12] GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) ↵Miss Islington (bot)2024-02-051-14/+2
| | | | | | | | | | | GH-114925) GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) (cherry picked from commit 9872855a31720f514b84373848b49fca09d66ecd) Co-authored-by: patenaud <33957588+patenaud@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.12] gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546) (#114584)Miss Islington (bot)2024-02-042-2/+15
| | | | | | | * gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546) (cherry picked from commit 01d970c1b8acf3ccf199d5de151a635ffd9d8c61) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-101100: Fix sphinx warnings in `Doc/c-api/memoryview.rst` ↵Miss Islington (bot)2024-01-291-0/+13
| | | | | | | (GH-114669) (GH-114704) (cherry picked from commit 97fb2480e4807a34b8197243ad57566ed7769e24) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891) (GH-114638)Miss Islington (bot)2024-01-271-6/+2
| | | | | (cherry picked from commit 926881dc10ebf77069e02e66eea3e0d3ba500fe5) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.12] Document PyOS_strtoul and PyOS_strtol (GH-114048) (GH-114618)Miss Islington (bot)2024-01-261-0/+36
| | | | | (cherry picked from commit 3f62bf32caf04cedb2c59579a0ce835d1e793d4d) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.12] gh-101100: Fix Sphinx warnings in `c-api/structures.rst` (GH-113564) ↵Miss Islington (bot)2024-01-241-9/+10
| | | | | | | | (#114527) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373) ↵Miss Islington (bot)2024-01-211-2/+2
| | | | | | | | (#114377) gh-101100: Fix sphinx warnings in `Doc/c-api/memory.rst` (GH-114373) (cherry picked from commit 47133d8d869c94c4d1f340b5481cc3f2cdc7d68b) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-112092: clarify unstable ABI recompilation requirements ↵Miss Islington (bot)2024-01-181-1/+1
| | | | | | | | | | (GH-112093) (#114260) gh-112092: clarify unstable ABI recompilation requirements (GH-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. (cherry picked from commit 68a7b78cd5185cbd9456f42c15ecf872a7c16f44) Co-authored-by: DerSchinken <53398996+DerSchinken@users.noreply.github.com>
* [3.12] gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` ↵Miss Islington (bot)2024-01-171-0/+34
| | | | | | | | | (GH-112557) (GH-114119) gh-102468: Document `PyCFunction_New*` and `PyCMethod_New` (GH-112557) (cherry picked from commit a482bc67ee786e60937a547776fcf9528810e1ce) Co-authored-by: AN Long <aisk@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.12] gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL ↵Miss Islington (bot)2023-12-311-1/+1
| | | | | | | | when the error indicator is not set (GH-113369) (#113606) gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369) (cherry picked from commit 2849cbb53afc8c6a4465f1b3490c67c2455caf6f) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.12] docs: specify that PyBytes_AsStringAndSize returns 0 on success ↵Miss Islington (bot)2023-12-251-0/+1
| | | | | | | (GH-110888) (GH-111690) (cherry picked from commit 9f33ede12710c454643c394421f52d209247272c) Co-authored-by: lefp <70862148+lefp@users.noreply.github.com>
* [3.12] gh-101100: Improve docs on exception attributes (GH-113057) (#113061)Miss Islington (bot)2023-12-131-6/+10
| | | | | | | gh-101100: Improve docs on exception attributes (GH-113057) (cherry picked from commit d05a180350fe20d5fde56c7e525e394a0b282703) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Further improve docs on function attributes (GH-113001) ↵Miss Islington (bot)2023-12-121-1/+1
| | | | | | | | (#113030) gh-101100: Further improve docs on function attributes (GH-113001) (cherry picked from commit 81a15ea74e2607728fceb822dfcc1aabff00478a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-101100: Improve documentation on function attributes (GH-112933) ↵Hugo van Kemenade2023-12-121-10/+13
| | | | | | | (#112974) (cherry picked from commit 4c5b9c107a1d158b245f21a1839a2bec97d05383) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Doc: c-api: fix order of PyMemberDef fields (GH-112879)Miss Islington (bot)2023-12-101-4/+4
| | | | Doc: c-api: fix order of PyMemberDef fields (GH-112879) (cherry picked from commit 42a86df3a376a77a94ffe6b4011a82cf51dc336a)
* [3.12] gh-101100: Improve documentation of code object attributes (#112781) ↵Alex Waygood2023-12-062-3/+3
| | | | | (#112816) (cherry-picked from commit e9707d3c3d)
* [3.12] gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` ↵Miss Islington (bot)2023-12-061-3/+3
| | | | | | | | | | | | | parameters in slot typedefs table (GH-112742) (GH-112792) gh-111178: Docs: fix `traverseproc`, `inquiry`, and `destructor` parameters in slot typedefs table (GH-112742) In the slot typedefs table, the parameter of `destructor` and the first parameter of `traverseproc` should both be `PyObject *` rather than `void *`. Same for `inquiry`. (cherry picked from commit 00cce0fe495ee820cd3ca5878bdbe3dd65b1be7b) Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
* [3.12] gh-101100: Properly document frame object attributes (GH-112735) ↵Miss Islington (bot)2023-12-052-6/+7
| | | | | | | | (#112772) gh-101100: Properly document frame object attributes (GH-112735) (cherry picked from commit d109f637c048c2b5fc95dc7fdfd50f8ac41a7747) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-62897: Update PyUnicode C API parameter names (GH-12680) (GH-112744)Serhiy Storchaka2023-12-051-91/+91
| | | | | | | Standardize PyUnicode C API parameter names across the documentation. (cherry picked from commit b31232ddf7f219ca8ff9e8d0401c02eb0b6ffec3) Co-authored-by: Rune Tynan <runetynan@gmail.com>
* [3.12] gh-112671: Fixing typo in the Macro Docs (GH-112715) (GH-112726)Miss Islington (bot)2023-12-041-1/+1
| | | | | | Replace Py_T_STRING_INLINE with Py_T_STRING_INPLACE (cherry picked from commit a8ce149628c9eaafb8c38fbf25fbd1ed483d2902) Co-authored-by: Amioplk <amir.worms@dauphine.eu>
* [3.12] gh-101100: Fix Sphinx reference warnings (GH-112416) (#112420)Hugo van Kemenade2023-11-261-1/+1
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.12] gh-108082: C API: Add tests for PyErr_WriteUnraisable() (GH-111455) ↵Miss Islington (bot)2023-10-301-0/+8
| | | | | | | | (GH-111507) Also document the behavior when called with NULL. (cherry picked from commit bca330542912532baa33af20a107fcf956cf007a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.12] Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET ↵Miss Islington (bot)2023-10-231-0/+2
| | | | | | (GH-110963) (#111219) Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
* [3.12] C-API docs: Clarify the size of arenas (GH-110895) (#110946)Miss Islington (bot)2023-10-161-1/+2
| | | | | | | | | | | C-API docs: Clarify the size of arenas (GH-110895) Clarify the size of arenas From 3.10.0 alpha 7, the pymalloc allocator uses arenas with a fixed size of 1 MiB on 64-bit platforms instead of 256 KiB on 32-bit platforms. (cherry picked from commit f07ca27709855d4637b43bba23384cc795143ee3) Co-authored-by: Mienxiu <82512658+mienxiu@users.noreply.github.com>
* [3.12] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110928)Miss Islington (bot)2023-10-161-1/+3
| | | | | | gh-110527: Improve `PySet_Clear` docs (GH-110528) (cherry picked from commit bfc1cd8145db00df23fbbd2ed95324bb96c0b25b) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] gh-110803: Reorganize docs for what PyType_Slot doesn't cover ↵Miss Islington (bot)2023-10-132-15/+32
| | | | | | | | | | | | | | | | | | (GH-110813) (#110823) gh-110803: Reorganize docs for what PyType_Slot doesn't cover (GH-110813) * gh-110803: Reorganize docs for what PyType_Slot doesn't cover - Cover the offset fields first - Mention the old alternative for MANAGED flags, which is needed to support older Pythons - De-emphasize the internal flags: use an inline list. - Add a note to PyMemberDef saying what to do with it * Remove an older draft... (cherry picked from commit 2ab34f0e425d90d0a153104ef2f4343dce2a414d) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] gh-110631: Fix reST indentation (GH-110724) (#110738)Ezio Melotti2023-10-111-12/+12
| | | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f475f2550d99dd794069ca76312f7f6aa6)
* [3.12] Fix typos in docs and comments (#109619) (#109621)Alex Waygood2023-10-021-1/+1
| | | | | | Fix typos in docs and comments (#109619) Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
* [3.12] gh-107298: Document PyMODINIT_FUNC macro (GH-109236) (#109947)Miss Islington (bot)2023-09-271-0/+24
| | | | | | | | | | | | gh-107298: Document PyMODINIT_FUNC macro (GH-109236) Document PyMODINIT_FUNC macro. Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are not documented. These macros should only be used to define the Python C API. They should not be used outside Python code base. (cherry picked from commit d7a27e527d7e669d2e45cff80ad725978226477c) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.12] Improve some C API documentation (GH-108768) (#108785)Serhiy Storchaka2023-09-023-44/+43
| | | | | | | * Express functions which take argument as a C string in terms of functions which take Python object. * Use "note" directive for PyMapping_HasKey() and PyMapping_HasKeyString() notes.. (cherry picked from commit 6f97eeec222f81bd7ae836c149872a40b079e2a6)
* [3.12] Fix misc doc typos (GH-108592) (#108594)Miss Islington (bot)2023-08-292-2/+2
| | | | | | Fix misc doc typos (GH-108592) (cherry picked from commit 88f1c5b454c34efc167a94b5e2d67ec042834e5b) Co-authored-by: xzmeng <aumo@foxmail.com>
* [3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (#108448)Victor Stinner2023-08-251-3/+5
| | | | | | gh-108314: PyDict_GetItemString() mentions UTF-8 PyDict_GetItemString(), PyDict_SetItemString() and PyDict_DelItemString() expects a UTF-8 encoding string for the key.
* [3.12] gh-107298: Fix numerous ref errors and typos in the C API docs ↵Miss Islington (bot)2023-08-224-6/+18
| | | | | | | | (GH-108258) (#108284) gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (cherry picked from commit d7202e4879bf4e7e00a69500ddcb3143864139b4) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
generated by cgit v0.12 at 2025-04-20 21:21:59 (GMT)