summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
Commit message (Collapse)AuthorAgeFilesLines
* Document Py_ssize_t. (GH-92512)Miss Islington (bot)2022-05-138-22/+29
| | | | | | | | | It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But there's 8182 errors left. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit 664aa94b570a4a8f3535efb2e3d638a4ab655943) Co-authored-by: Julien Palard <julien@palard.fr>
* [3.9] GH-92431: Fix footnotes in Doc/c-api/exceptions.rst (GH-92432) (GH-92471)Miss Islington (bot)2022-05-081-11/+11
| | | | | | | | | | | * Remove redundant footnote ref: the footnote has been removed * Fix footnote ref to match footnote * Convert footnotes into reST footnotes: will error if missing (cherry picked from commit 788ef54bc94b0a7aa2a93f626e4067ab8561424c) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Automerge-Triggered-By: GH:serhiy-storchaka
* gh-92047: Py_GetVersion multi-digit minor version (GH-92047) (GH-92048) (#92329)Miss Islington (bot)2022-05-061-1/+1
| | | | | | | (cherry picked from commit 43b135f94ebf3e6e84ddb0f75ed8510b96a610e4) Co-authored-by: Robert Howlett <robert@howletts.org.uk> Co-authored-by: Robert Howlett <robert@howletts.org.uk>
* Document the lifetime of `PyUnicode_AsUTF8String` (GH-92325)Miss Islington (bot)2022-05-061-1/+2
| | | | | | The current wording implied this, but didn't state it explicitly. (cherry picked from commit 740da8d37a84638f4a8893bee3648f36fc6beb0f) Co-authored-by: Matt Wozniski <godlygeek@gmail.com>
* [3.9] gh-91118: Fix docstrings that do not honor --without-doc-strings ↵Oleg Iarygin2022-04-191-4/+4
| | | | | | | | (GH-31769) (#91664) Co-authored-by: Éric <merwok@netwok.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit a573cb2fec664c645ab744658d7e941d72e1a398)
* c-api docs: There are five fields, not four (GH-32379)Miss Islington (bot)2022-04-071-1/+1
| | | | | (cherry picked from commit 4c92427fb85e420404a9bd26347e32acc1bbd3b7) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.9] More minor fixes to C API docs (GH-31525) (GH-32259)Jelle Zijlstra2022-04-0211-25/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * wording fixes in type.rst * grammar and punctuation in sys.rst * set: grammar fixes * structures: capitalization fix * grammar fixes for sequence * objects: point to Py_TYPE instead of direct object access * numbers: add more explicit Python equivalences * method: add missing period * memory: grammar fix * mapping: grammar fixes * long: grammar fix * iter: fix grammar for PyAIter_Check * init: grammar fix. (cherry picked from commit 897bc6f9282238d5fb32d232ab62d30675244736) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.9] More minor fixes to C API docs (GH-31714) (GH-32260)Jelle Zijlstra2022-04-025-9/+7
| | | | | | | | | | * init_config: wording fixes * bytearray: remove XXX, there is a good link to the buffer docs * bytes, call, exceptions: minor wording fixes. (cherry picked from commit 677a87946630c5fbd9998969669b4dd4f4b32545) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.9] Minor fixes to C API docs (GH-31501) (GH-31526)Jelle Zijlstra2022-03-024-24/+28
| | | | | | | | | | | | | | | | | * C API docs: move PyErr_SetImportErrorSubclass docs It was in the section about warnings, but it makes more sense to put it with PyErr_SetImportError. * C API docs: document closeit argument to PyRun_AnyFileExFlags It was already documented for PyRun_SimpleFileExFlags. * textual fixes to unicode docs * Move paragraph about tp_dealloc into tp_dealloc section * __aiter__ returns an async iterator, not an awaitable. (cherry picked from commit 43cf44ddcce6b225f959ea2a53e4817244ca6054)
* bpo-40421: Fix PyFrame_GetCode() documentation (GH-31535)Miss Islington (bot)2022-02-231-2/+2
| | | | | | | Fix PyFrame_GetBack() and PyFrame_GetCode() return type in the documentation. (cherry picked from commit 78859e58e4e016286e648d1dc155e0f6cebfa6ff) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.9] bpo-22039: [doc] clarify that there are no plans to disable deleting ↵Miss Islington (bot)2022-01-191-2/+3
| | | | | | | | | | an attribute via PyObject_SetAttr (GH-30639) (GH-30685) (cherry picked from commit 3bf6315c4cabf72d64e65e6f85bf72c65137255a) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com> Automerge-Triggered-By: GH:iritkatriel
* closes bpo-46253: Change Py_UNICODE to Py_UCS4 in the C API docs to match ↵Miss Islington (bot)2022-01-111-17/+17
| | | | | | | the current source code (GH-30387) (cherry picked from commit 43c5c1369cb21f08a1dc1d63923c3586b883e3e8) Co-authored-by: Julian Gilbey <julian-git@d-and-j.net>
* bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() ↵Miss Islington (bot)2021-10-282-8/+20
| | | | | | | | | | (GH-29246) (GH-29248) Objects that support garbage collection ("container" objects) should call PyObject_GC_UnTrack() from their destructors before clearing any fields which may point to other "container" objects. (cherry picked from commit 35e1ff38ee67ee543d9fcb268c3552c5397f9b3f) Co-authored-by: Sam Gross <colesbury@gmail.com>
* [3.9] [doc] Fix typos found using codespell (GH-28744) (GH-28759)Christian Clauss2021-10-061-1/+1
|
* bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28524)Miss Islington (bot)2021-09-231-3/+3
| | | | | | | | | | Replace old names when they refer to actual versions of macOS. Keep historical names in references to older versions. Co-authored-by: Patrick Reader <_@pxeger.com> (cherry picked from commit 36122e18148c5b6c78ebce1d36d514fd7cf250f5) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.9] Fix minor typo in Doc/c-api/type.rst (GH-28432) (GH-28441)Miss Islington (bot)2021-09-181-1/+1
| | | | | | | | | retreived-> retrieved (cherry picked from commit af08f1ba40505bf1380c08b57ba4e0b8969a8358) Co-authored-by: Konstantin Popov <konst.hardy@gmail.com> Automerge-Triggered-By: GH:Fidget-Spinner
* [3.9] docs: correct references to __isub__ etc (GH-28297). (GH-28415)Serhiy Storchaka2021-09-171-130/+130
| | | | | | (cherry picked from commit 800bd01b6d365156403c3dde61765dc5fdbf64be) Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
* [doc] Fix typo c-api/exceptions.rst (GH-27847) (GH-27919)Miss Islington (bot)2021-08-231-1/+1
| | | | | | Co-authored-by: Tianqing Peng <pengtianqing@yimian.com.cn> (cherry picked from commit dcbf7ff6a700b63e637a0445d68866670a398024) Co-authored-by: Sunny Bean <ptq008@gmail.com>
* Note that tp_clear and m_clear are not always called (GH-27581) (GH-27597)Miss Islington (bot)2021-08-042-0/+12
| | | | | (cherry picked from commit 10faada709561663d6b1f623d308ff45e3808cca) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* bpo-41886: Fix documented type of PyType_Type (GH-22454)Miss Islington (bot)2021-08-031-1/+1
| | | | | (cherry picked from commit ac811f9b5a68ce8756911ef2c8be83b46696018f) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
* Document PyMember_GetOne and PyMember_SetOne (GH-27555) (GH-27561)Miss Islington (bot)2021-08-021-0/+15
| | | | | (cherry picked from commit d382bde220b4c07cce2b924ffeb7525ea1a969f4) Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
* bpo-43565: Document PyUnicode_KIND's return type as an unsigned int ↵Miss Islington (bot)2021-07-291-1/+1
| | | | | | | (GH-25724) (GH-27440) (cherry picked from commit 47fd4726a2ce8599cc397ddeae40f70eb471e868) Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
* bpo-44441: _PyImport_Fini2() resets PyImport_Inittab (GH-26874) (GH-26878)Victor Stinner2021-06-232-4/+11
| | | | | | | Py_RunMain() now resets PyImport_Inittab to its initial value at exit. It must be possible to call PyImport_AppendInittab() or PyImport_ExtendInittab() at each Python initialization. (cherry picked from commit 489699ca05bed5cfd10e847d8580840812b476cd)
* bpo-44426: Fix use of the C keyword 'default' as a variable name (GH-26798) ↵Miss Islington (bot)2021-06-191-2/+2
| | | | | | (GH-26805) (cherry picked from commit 291848195f85e23c01adb76d5a0ff9c6eb7f2614)
* bpo-44426: Use of 'complex' as a C variable name confuses Sphinx; change it ↵Miss Islington (bot)2021-06-161-2/+2
| | | | | | to 'num'. (GH-26744) (GH-26761) (cherry picked from commit 7247f6f433846c6e37308a550e8e5eb6be379856)
* [3.9] bpo-44392: Add Py_GenericAlias to C API docs (GH-26724) (GH-26757)Ken Jin2021-06-162-0/+47
| | | (cherry picked from commit 6773c3eaa735b5061b4a97f2c730703a32d8c9ff)
* bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445)Miss Islington (bot)2021-05-292-9/+12
| | | | | (cherry picked from commit 43cf7c864a2941b3f8f823e5928721dd286b7778) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases ↵Miss Islington (bot)2021-05-292-0/+18
| | | | | | | (GH-26442) (cherry picked from commit 8b55bc3f93a655bc803bff79725d5fe3f124e2f0) Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
* bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) ↵Miss Islington (bot)2021-04-281-7/+6
| | | | | (GH-25689) (cherry picked from commit 4c49be766897968e509c41397e0e624c25b1675d)
* bpo-43506: Doc: Update removal schedule for Py_UNICODE encoder APIs (GH-24885)Miss Islington (bot)2021-03-161-11/+15
| | | | | | See PEP 624. (cherry picked from commit 1330338583d183250186a8123b99d2283e945b4f) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-3329: Fix typo in PyObjectArenaAllocator doc (GH-24795)Miss Islington (bot)2021-03-091-1/+1
| | | | | (cherry picked from commit 0d6bd1ca7c683137d52041194f3a2b02219f225a) Co-authored-by: Victor Stinner <vstinner@python.org>
* bpo-36346: Document removal schedule of deprecate APIs (GH-20879)Miss Islington (bot)2021-02-222-8/+7
| | | | | | We will remove wstr cache in Python 3.12. See PEP 623. (cherry picked from commit 2d6f2eed14ff5d89155b52771cc8ef957e8145b4) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* closes bpo-43266: Improve array formatting. (GH-24573)Miss Islington (bot)2021-02-191-4/+4
| | | | | (cherry picked from commit 2d3e463e4a5aa109d1c15c86f9631580f5ef7a7e) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* closes bpo-43254: Fix *snprintf() man page refs. (GH-24563)Miss Islington (bot)2021-02-191-2/+2
| | | | | (cherry picked from commit e92d67dfbb4790df37aa6a0961fb6dc7e8d2fbbf) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
* Docs: Remove stray semicolon in init.rst (GH-23974)Miss Islington (bot)2021-01-141-1/+1
| | | | | | Removed stray semicolon which was causing the docs to render weirdly (it's the function right under the one [here](https://docs.python.org/3/c-api/init.htmlGH-c._PyInterpreterState_GetEvalFrameFunc)). (cherry picked from commit 971235827754eee6c0d9f7d39b52fecdfd4cb7b4) Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
* bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) ↵Miss Islington (bot)2021-01-0626-52/+74
| | | | | | | | | | | | (GH-24139) I think that none of these API calls can fail, but only few of them are documented as such. Add the sentence "This function always succeeds" (which is the same already used e.g. by PyNumber_Check) to all of them. (cherry picked from commit 315fc52db17b19fe30aa9193f26adf69e18d8844) Co-authored-by: Antonio Cuni <anto.cuni@gmail.com> Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>
* bpo-42412: Fix possible leaks and check arguments in ↵Miss Islington (bot)2020-11-211-2/+4
| | | | | | | | | | | PyType_FromModuleAndSpec() (GH-23410) * There were leaks if Py_tp_bases is used more than once or if some call is failed before setting tp_bases. * There was a crash if the bases argument or the Py_tp_bases slot is not a tuple. * The documentation was not accurate. (cherry picked from commit 1db76394ea79030aa4ed5349c950f6c6da51450f) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-41192: Add documentation of undocumented audit events (GH-22831)Miss Skeleton (bot)2020-10-201-0/+2
| | | | (cherry picked from commit 3f7e990fd49dbabc1dde41ce58c1bdda9f56ead7)
* bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)Miss Islington (bot)2020-10-021-4/+6
| | | | | (cherry picked from commit 20ce62f00957d11f24f6449cd5c0ef5dd67174d4) Co-authored-by: Campbell Barton <ideasman42@gmail.com>
* [3.9] bpo-38787: Clarify docs for PyType_GetModule and warn against common ↵Miss Islington (bot)2020-09-041-1/+11
| | | | | | | | | | mistake (GH-20215) (GH-21984) (cherry picked from commit d9a966ae08258da2ce2a432c943d8194760f09c4) Co-authored-by: Petr Viktorin <encukou@gmail.com> Automerge-Triggered-By: @Mariatta
* Note the buffer slots can be set with PyType_Spec with the unlimited API. ↵Miss Islington (bot)2020-09-021-1/+10
| | | | | | | | (GH-22052) Follow up to f7c4e236429606e1c982cacf24e10fc86ef4462f. (cherry picked from commit 700fa1b836f315048e8b89ede5018a0c0a213946) Co-authored-by: Benjamin Peterson <benjamin@python.org>
* [3.9] bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901)Victor Stinner2020-08-1918-129/+116
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a)
* bpo-41098: Doc: Add missing deprecated directives (GH-21162)Miss Islington (bot)2020-08-071-0/+10
| | | | | | | PyUnicodeEncodeError_Create has been deprecated with `Py_DEPRECATED` macro. But it was not documented. (cherry picked from commit 46e19b61d31ba99f049258efa4ff1334856a3643) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-36346: Doc: Update removal schedule of legacy Unicode (GH-21479)Miss Islington (bot)2020-08-051-9/+30
| | | | | | See PEP 623 for detail. (cherry picked from commit 270b4ad4df795783d417ba15080da8f95e598689) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* bpo-41211: Doc: Fix PyLong_FromUnicode (GH-21331)Inada Naoki2020-07-051-3/+1
| | | PyUnicode_EncodeDecimal is not used actually.
* bpo-41211: Doc: Fix PyLong_FromUnicodeObject (GH-21325)Miss Islington (bot)2020-07-051-3/+1
| | | | | | It doesn't use PyUnicode_EncodeDecimal. It uses a private API instead. (cherry picked from commit 9c8441712230660fedac818ed50e7cdd89e4c51d) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
* Doc: Minor fix to init config C API documentation (GH-21198)Miss Islington (bot)2020-07-011-2/+2
| | | | | | Co-authored-by: Tomer Vromen <tomer.vromen@intel.com> (cherry picked from commit 741008a57bdc95090b8be6ded5a9fd3f17f7bf21) Co-authored-by: tomerv <tomerv@gmail.com>
* bpo-41123: Remove PyUnicode_AsUnicodeCopy in 3.10 (GH-21227)Inada Naoki2020-06-301-0/+2
|
* bpo-41123: Doc: PyLong_FromUnicode will be removed in 3.10 (GH-21205)Inada Naoki2020-06-291-1/+1
|
* [3.9] bpo-40939: Deprecate the PyParser_SimpleParse* functions (GH-21012)Lysandros Nikolaou2020-06-211-0/+10
|
generated by cgit v0.12 at 2026-01-04 06:50:44 (GMT)