be436e08b8
gh-108444: Add PyLong_AsInt() public function ( #108445 )
...
* Rename _PyLong_AsInt() to PyLong_AsInt().
* Add documentation.
* Add test.
* For now, keep _PyLong_AsInt() as an alias to PyLong_AsInt().
2023-08-24 23:55:30 +02:00
6726626646
gh-108314: Add PyDict_ContainsString() function ( #108323 )
2023-08-24 15:59:12 +02:00
422f81b5d2
gh-107298: Fix a few more refs in the C API docs (GH-108361)
...
gh-107298: Fix few more refs in the C API docs
2023-08-23 20:12:42 +03:00
d7202e4879
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
2023-08-22 15:50:30 +03:00
d63972e289
gh-107298: Fix C API datetime documentation (GH-108034)
2023-08-21 21:15:46 +03:00
3ff5ef2ad3
gh-108014: Add Py_IsFinalizing() function ( #108032 )
...
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-18 12:34:41 +02:00
f51f0466c0
gh-107298: Fix some references in the C API documentation (GH-108072)
2023-08-17 11:16:00 +03:00
c2941cba7a
gh-107298: Fix C API Buffer documentation ( #108011 )
2023-08-16 18:24:46 +02:00
66e4edd734
gh-91051: fix segfault when using all 8 type watchers ( #107853 )
2023-08-11 12:42:26 -06:00
637f7ff2c6
Docs: Document PyBUF_MAX_NDIM ( #107865 )
2023-08-11 18:03:53 +02:00
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
db361a340a
gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519)
2023-07-31 23:11:15 +00:00
fb344e99aa
gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters ( #107403 )
...
It was added in 3.12 for PEP 684 (per-interpreter GIL).
2023-07-31 17:03:01 -06:00
f2abeb590d
Fix the documentation for PyCode_New add `qualname` parameter ( #107186 )
2023-07-29 23:11:40 +05:30
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
c0b81c4b54
gh-107305: Update the C-API Docs for PEP 684 (gh-107324)
2023-07-28 13:46:55 -06:00
983305268e
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)
2023-07-27 18:44:32 +03:00
abec9a1b20
gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316)
...
Add targets for PyStructSequence_Desc and PyStructSequence_Field members
and macros like Py_EQ.
Fix target for Py_RETURN_RICHCOMPARE.
2023-07-27 09:04:02 +03:00
d363eb5b02
gh-107091: Fix some uses of :attr: role (GH-107318)
...
Fix also formatting of PyMethodDef members.
2023-07-27 08:52:54 +03:00
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
391e03fa05
gh-107298: Fix Sphinx warnings in the C API doc ( #107302 )
...
* Update Doc/tools/.nitignore
* Fix BufferedIOBase.write() link in buffer.rst
2023-07-27 01:41:15 +02:00
6d5b6e71c8
gh-107091: Fix some uses of :c:type: role (GH-107138)
2023-07-26 22:29:23 +03:00
af61cb9c78
gh-107091: Fix some uses of :c:member: role (GH-107129)
2023-07-26 22:16:06 +03:00
87b39028e5
gh-107298: Fix doc references to undocumented modules ( #107300 )
...
Update also Doc/tools/.nitignore.
2023-07-26 18:59:06 +02:00
0a9b339363
Fix PyVectorcall_Function doc versionadded ( #107140 )
...
The documentation implies that PyVectorcall_Function() was available in Python 3.8.
This is half-true - it was available under a different name. I think it's clearer to set
the "version added" to 3.9.
2023-07-24 14:54:38 +02:00
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
08a228da05
gh-107091: Fix the use of some C domain roles ( #107092 )
2023-07-23 12:27:05 +02:00
f5147c0cfb
gh-101100: Fix some broken sphinx references ( #107095 )
2023-07-23 03:23:44 -06:00
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949)
...
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
2023-07-22 21:35:22 +03:00
41ca164551
gh-106004: Add PyDict_GetItemRef() function ( #106005 )
...
* Add PyDict_GetItemRef() and PyDict_GetItemStringRef() functions.
Add these functions to the stable ABI version 3.13.
* Add unit tests on the PyDict C API in test_capi.
2023-07-21 23:10:51 +02:00
4b9948617f
gh-106909: Use role :const: for referencing module constants (GH-106910)
2023-07-21 12:40:37 +03:00
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
83ac128490
bpo-42327: C API: Add PyModule_Add() function (GH-23443)
...
It is a fixed implementation of PyModule_AddObject() which consistently
steals reference both on success and on failure.
2023-07-18 09:42:05 +03:00
4bf43710d1
gh-106307: C API: Add PyMapping_GetOptionalItem() function (GH-106308)
...
Also add PyMapping_GetOptionalItemString() function.
2023-07-11 23:04:12 +03:00
579aa89e68
gh-106521: Add PyObject_GetOptionalAttr() function (GH-106522)
...
It is a new name of former _PyObject_LookupAttr().
Add also PyObject_GetOptionalAttrString().
2023-07-11 22:13:27 +03:00
a840806d33
gh-105227: Add PyType_GetDict() (GH-105747)
...
This compensates for static builtin types having `tp_dict` set to `NULL`.
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-07-10 18:41:02 +02:00
ee46cb6aa9
gh-105927: PyWeakref_GetRef() returns 1 on success ( #106561 )
...
PyWeakref_GetRef() now returns 1 on success, and return 0 if the
reference is dead.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-09 15:50:26 +00:00
ffe70c4d1c
gh-105373: Remove C API global config vars in Python 3.14 ( #106538 )
...
Schedule the removal of C API global configuration variables in
Python 3.14. Announce the removal to help C extension maintainers to
upgrade their code.
2023-07-08 01:49:20 +02:00
ad075682ba
tp_flags docs: fix indentation ( #106420 )
2023-07-05 05:08:25 +00:00
a8ae73965b
gh-101100: Docs: Fix references to several numeric dunders ( #106278 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-30 15:27:09 +01:00
80b3d8f337
gh-106023: Remove _PyObject_FastCallTstate() function ( #106273 )
2023-06-30 12:28:59 +02:00
3f8483cad2
gh-106168: PyTuple_SET_ITEM() now checks the index ( #106164 )
...
PyTuple_SET_ITEM() and PyList_SET_ITEM() now check the index argument
with an assertion if Python is built in debug mode or is built with
assertions.
* list_extend() and _PyList_AppendTakeRef() now set the list size
before calling PyList_SET_ITEM().
* PyStructSequence_GetItem() and PyStructSequence_SetItem() now check
the index argument: must be lesser than REAL_SIZE(op).
* PyStructSequence_GET_ITEM() and PyStructSequence_SET_ITEM() are now
aliases to PyStructSequence_GetItem() and
PyStructSequence_SetItem().
2023-06-28 03:45:57 +02:00
c075a1974b
gh-105927: Deprecate PyWeakref_GetObject() function ( #106006 )
...
Deprecate PyWeakref_GetObject() and PyWeakref_GET_OBJECT() functions.
2023-06-26 12:10:53 +02:00
19d6511b0b
gh-106033: [docs] Improve C API GetItem & HasAttr notes. ( #106047 )
...
Use a note:: tag so that these dict and object API deficiencies show up clearly.
A caution:: tag was considered, but our current python docs rendering doesn't do much with that (no box or color change). warning:: seemed too extreme. note looks good.
2023-06-24 16:29:26 -07:00
a2392720d6
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal ( #105195 )
2023-06-21 21:13:25 +01:00
9c44656feb
gh-105927: Add PyWeakref_GetRef() function ( #105932 )
...
Add tests on PyWeakref_NewRef(), PyWeakref_GetObject(),
PyWeakref_GET_OBJECT() and PyWeakref_GetRef().
2023-06-21 11:40:09 +02:00
03f1a132ee
gh-105922: Add PyImport_AddModuleRef() function ( #105923 )
...
* Add tests on PyImport_AddModuleRef(), PyImport_AddModule() and
PyImport_AddModuleObject().
* pythonrun.c: Replace Py_XNewRef(PyImport_AddModule(name)) with
PyImport_AddModuleRef(name).
2023-06-20 08:48:14 +02:00
d32e8d6070
gh-105196: Fix indentations of section headings in C API docs ( #105672 )
2023-06-14 15:21:30 +01:00
d0f1afd942
gh-105373: Remove PyArg_Parse() deprecation ( #105394 )
...
There is no plan to deprecate PyArg_Parse().
The deprecation was added as a comment in the C API documentation in
2007 by commit 85eb8c103c
2023-06-13 13:49:36 +02:00
Victor Stinner