Stan Ulbrych
196f1519cd
gh-141004: Document PyErr_RangedSyntaxLocationObject ( #141521 )
...
PyErr_RangedSyntaxLocationObject
2025-11-13 17:58:47 +00:00
Victor Stinner
b99db92dde
gh-139653: Add PyUnstable_ThreadState_SetStackProtection() ( #139668 )
...
Add PyUnstable_ThreadState_SetStackProtection() and
PyUnstable_ThreadState_ResetStackProtection() functions
to set the stack base address and stack size of a Python
thread state.
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-13 17:30:50 +01:00
Peter Bierma
b5a0c72492
gh-141004: Document PyExceptionInstance* APIs (GH-141301)
...
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-09 17:09:09 +00:00
Peter Bierma
be1c72a45d
gh-141004: Document PyErr_ProgramTextObject and PyErr_ProgramText (GH-141250)
...
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-08 10:47:09 -05:00
Peter Bierma
d13ee0ae18
gh-141004: Document PyTraceBack* APIs (GH-141192)
...
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-07 13:46:47 -05:00
Peter Bierma
9420795b47
gh-141004: Document PyErr_WarnExplicitFormat (GH-141187)
2025-11-07 11:19:14 -05:00
Peter Bierma
0b260305d3
gh-141004: Document Py_GetRecursionLimit and Py_SetRecursionLimit (GH-141151)
...
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
2025-11-06 16:37:52 +00:00
Petr Viktorin
85bc89f35f
gh-136209: Add .. c:var:: declarations for C exception types (GH-136210)
...
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-07-10 13:07:55 +02: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
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
Peter Bierma
86d5fa95cf
gh-127989: C API: Refer to "attached thread states" instead of the GIL (GH-127990)
...
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-03-20 13:06:59 +01:00
Mark Shannon
014223649c
GH-130396: Use computed stack limits on linux (GH-130398)
...
* Implement C recursion protection with limit pointers for Linux, MacOS and Windows
* Remove calls to PyOS_CheckStack
* Add stack protection to parser
* Make tests more robust to low stacks
* Improve error messages for stack overflow
2025-02-25 09:24:48 +00:00
Petr Viktorin
ef29104f7d
GH-91079: Revert "GH-91079: Implement C stack limits using addresses, not counters. (GH-130007)" for now (GH130413)
...
Revert "GH-91079: Implement C stack limits using addresses, not counters. (GH-130007)" for now
Unfortunatlely, the change broke some buildbots.
This reverts commit 2498c22fa0
2025-02-24 11:16:08 +01:00
Mark Shannon
2498c22fa0
GH-91079: Implement C stack limits using addresses, not counters. (GH-130007)
...
* Implement C recursion protection with limit pointers
* Remove calls to PyOS_CheckStack
* Add stack protection to parser
* Make tests more robust to low stacks
* Improve error messages for stack overflow
2025-02-19 11:44:57 +00:00
Bénédikt Tran
bc0f2e9459
gh-123378: Ensure results of PyUnicode*Error_Get{Start,End} are clamped (GH-123380)
...
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-12-04 14:13:52 +01:00
Alex Waygood
0d9d56c4e4
gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs ( #124480 )
2024-09-25 19:29:58 +00:00
Petr Viktorin
32119fc377
gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)
2024-09-18 14:15:43 +02:00
Wei-Hsiang (Matt) Wang
103a0470e3
gh-123492: Remove unnecessary :func: parentheses ( #123493 )
2024-08-30 14:34:09 +03:00
Xie Yanbo
98739c9078
Fix typo in Doc/c-api/exceptions.rst (GH-118371)
2024-04-29 14:02:54 +03:00
Serhiy Storchaka
438b7c3071
gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226)
2024-04-17 13:03:26 +03:00
bssyousefi
6a3236fe2e
gh-115799: Add missing double-quote in docs ( #115884 )
2024-02-25 14:07:08 -08:00
Skip Montanaro
e1552fd19d
gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst (GH-114825)
2024-02-11 18:51:07 +00:00
Serhiy Storchaka
573acb30f2
gh-115172: Fix explicit index extries for the C API (GH-115173)
2024-02-11 12:23:30 +02:00
Irit Katriel
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
Alex Waygood
d05a180350
gh-101100: Improve docs on exception attributes (GH-113057)
...
* Improve docs on exception attributes
* thanks sphinx-lint
* fix doctests
* argh, okay, give up on doctests
* Various improvements
2023-12-13 10:59:36 -08:00
Serhiy Storchaka
f6a02327b5
gh-108082: Add PyErr_FormatUnraisable() function (GH-111086)
2023-10-31 23:42:44 +02:00
Serhiy Storchaka
bca3305429
gh-108082: C API: Add tests for PyErr_WriteUnraisable() (GH-111455)
...
Also document the behavior when called with NULL.
2023-10-30 19:01:03 +02:00
Heinz-Alexander Fuetterer
ef6d475db3
Fix typos in docs and comments ( #109619 )
2023-09-20 16:58:23 +00:00
Serhiy Storchaka
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
Eric Snow
5dc825d504
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)
...
PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts. In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.
This change updates the documentation to reflect that perspective. It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
Victor Stinner
8d61a71f9c
gh-107298: Fix more Sphinx warnings in the C API doc ( #107329 )
...
Declare the following functions as macros, since they are actually
macros. It avoids a warning on "TYPE" or "macro" argument.
* PyMem_New()
* PyMem_Resize()
* PyModule_AddIntMacro()
* PyModule_AddStringMacro()
* PyObject_GC_New()
* PyObject_GC_NewVar()
* PyObject_New()
* PyObject_NewVar()
Add C standard C types to nitpick_ignore in Doc/conf.py:
* int64_t
* uint64_t
* uintptr_t
No longer ignore non existing "__int" type in nitpick_ignore.
Update Doc/tools/.nitignore
2023-07-27 00:52:40 +00:00
Erlend E. Aasland
b447e19e72
gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls ( #107062 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 22:56:56 +02:00
Serhiy Storchaka
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
Serhiy Storchaka
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
Victor Stinner
bae415ad02
gh-102304: doc: Add links to Stable ABI and Limited C API ( #105345 )
...
* Add "limited-c-api" and "stable-api" references.
* Rename "stable-abi-list" reference to "limited-api-list".
* Makefile: Document files regenerated by "make regen-limited-abi"
* Remove first empty line in generated files:
- Lib/test/test_stable_abi_ctypes.py
- PC/python3dll.c
2023-06-06 08:40:32 +00:00
Irit Katriel
0dafc785ee
gh-102778: update documentation of PyErr_PrintEx and traceback.print_last() regarding sys.last_exc ( #105190 )
2023-06-02 17:01:46 +01:00
Irit Katriel
4571eedca2
gh-105071: add missing versionadded directive ( #105097 )
2023-05-30 18:03:20 +01:00
Irit Katriel
b7aadb4583
gh-105071: add PyUnstable_Exc_PrepReraiseStar to expose except* implementation in the unstable API ( #105072 )
2023-05-30 15:03:36 +01:00
Adam Turner
d0122372f2
GH-97950: Use new-style index directive ('module') ( #103996 )
...
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
* Use new-style index directive ('module') - Tutorial
* Uncomment module removal in pairindextypes
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
2023-05-04 10:17:12 +02: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
Irit Katriel
3f9285a8c5
gh-102755: Add PyErr_DisplayException(exc) ( #102756 )
2023-03-16 22:18:04 +00:00
Erlend E. Aasland
02d9f1504b
gh-101578: Amend exception docs ( #102057 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-21 09:15:49 +01:00
Erlend E. Aasland
60bbed7f17
gh-101578: Amend PyErr_{Set,Get}RaisedException docs ( #101962 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-19 21:22:29 +01:00
Mark Shannon
feec49c407
GH-101578: Normalize the current exception (GH-101607)
...
* Make sure that the current exception is always normalized.
* Remove redundant type and traceback fields for the current exception.
* Add new API functions: PyErr_GetRaisedException, PyErr_SetRaisedException
* Add new API functions: PyException_GetArgs, PyException_SetArgs
2023-02-08 09:31:12 +00:00
Adam Turner
0e72606dd4
gh-93738: Documentation C syntax (Function glob patterns -> literal markup) ( #97774 )
2022-10-05 08:22:28 -07:00
Adam Turner
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
Adam Turner
5e997cff3e
gh-93738: Documentation C syntax (:c:data:0 -> `0`) ( #97771 )
...
:c:data:`0` -> ``0``
2022-10-04 03:46:30 +02:00
Hugo van Kemenade
788ef54bc9
GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432)
...
* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
2022-05-08 16:19:16 +03:00
Irit Katriel
5d421d7342
gh-90501: Add PyErr_GetHandledException and PyErr_SetHandledException (GH-30531)
2022-04-15 19:57:47 +01:00
Jelle Zijlstra
677a879466
More minor fixes to C API docs (GH-31714)
...
* init_config: wording fixes
* bytearray: remove XXX, there is a good link to the buffer docs
* bytes, call, exceptions: minor wording fixes
2022-04-02 12:32:59 -07:00
