summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
Commit message (Collapse)AuthorAgeFilesLines
* Document the surprising sideeffect PyErr_Print(). (GH-12081) (GH-12084)Miss Islington (bot)2019-02-271-2/+6
| | | | | (cherry picked from commit 4173772031747a9b249be4100b4aa9eda805ea23) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* Fix documented signatures for C API functions. (GH-11236) (GH-11240)Miss Islington (bot)2018-12-202-5/+5
| | | | | (cherry picked from commit 57dd79e6f7f33bb4e6817ac58c9cb91de99675e0) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-35461: Document C API functions which suppress exceptions. (GH-11119) ↵Miss Islington (bot)2018-12-207-4/+35
| | | | | | | (GH-11210) (cherry picked from commit 3fcc1e08db6fb7e17acc4a8f63be3e42f52f094b) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.6] Correct a couple of unbalanced parenthesis. (GH-10779). (GH-10945)Andre Delfino2018-12-051-1/+1
| | | | | (cherry picked from commit 55f41e45b4318cbe19209f5144641344d0049fb8) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* bpo-16086: Fix PyType_GetFlags() documentation (GH-10758) (GH-10790)Miss Islington (bot)2018-11-291-1/+4
| | | | | | PyType_GetFlags() return type is unsigned long, not long. (cherry picked from commit 9fbcfc08e5814d7aa9287740187e461425a99f67) Co-authored-by: Eddie Elizondo <eduardo.elizondorueda@gmail.com>
* [3.6] bpo-25438: document what codec PyMemberDef T_STRING decodes the char * ↵Miss Islington (bot)2018-11-171-1/+2
| | | | | | | | | | | | | | | | | | as (GH-10580) (GH-10587) Source of T_STRING: https://github.com/python/cpython/blob/e42b705188271da108de42b55d9344642170aa2b/Python/structmember.cGH-L51 Source of PyUnicode_FromString https://github.com/python/cpython/blob/master/Include/unicodeobject.hGH-L702 https://bugs.python.org/issue25438 (cherry picked from commit 689d555ec135d4115574addd063c358ac4897cc4) Co-authored-by: Windson yang <wiwindson@outlook.com> https://bugs.python.org/issue25438
* bpo-35229: Deprecate _PyObject_GC_TRACK() (GH-10511)Miss Islington (bot)2018-11-131-0/+6
| | | | | | | | Deprecate _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() in the documentation. These macros are removed from Python 3.8 by the commit 1a6be91e6fd65ce9cb88cbbbb193db7e92ec6076. (cherry picked from commit 55b4771d5d18d5ff7c095aa1ab750fe0c8bb5e67) Co-authored-by: Victor Stinner <vstinner@redhat.com>
* [3.6] bpo-35110: Fix unintentional spaces around hyphens and dashes. ↵Serhiy Storchaka2018-10-311-1/+1
| | | | | | (GH-10231). (GH-10254) (cherry picked from commit 3f819ca138db6945ee4271bf13e42db9f9b3b1e4)
* bpo-12743: Delete comment from marshal.rst (GH-8457)Miss Islington (bot)2018-07-271-14/+10
| | | | | | | | | Also, update the list of exceptions that may raised by PyMarshal_* functions. We usually don't document exceptions raised by a function, but in this case most of them were already documented in C API and standard library documentation. (cherry picked from commit defcffdf86780e3a184ebb25dc9a7b807753d57a) Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
* bpo-33892: Doc: Use gender neutral words (GH-7770)Miss Islington (bot)2018-06-181-1/+1
| | | | | (cherry picked from commit 5092439c2cb32112a5869b138011d38491db90a9) Co-authored-by: Andrés Delfino <adelfino@gmail.com>
* [3.6] bpo-5945: Improve mappings and sequences C API docs. (GH-7029). (GH-7049)Serhiy Storchaka2018-05-224-68/+93
| | | | (cherry picked from commit f5b1183610d5888db3bbd639b1a0c945dbd8f8dd)
* bpo-33583: Add note in PyObject_GC_Resize() doc (GH-7021)Miss Islington (bot)2018-05-221-1/+1
| | | | | (cherry picked from commit 1179f4b40f375af5c59cd4b6be9cc313fa0e1a37) Co-authored-by: INADA Naoki <methane@users.noreply.github.com>
* Fix C API docs: PyCapsule_Import always set an exception on failure. (GH-6967)Miss Islington (bot)2018-05-181-2/+9
| | | | | (cherry picked from commit bde3e0bf096219234321ca9898fc3d3aed598453) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* bpo-33195: Doc: Deprecate Py_UNICODE in c-api/arg (GH-6329)INADA Naoki2018-04-051-5/+22
| | | | | Py_UNICODE is deprecated since Python 3.3. But the deprecation is missed in the c-api/arg document. (cherry picked from commit 42ec190)
* bpo-33126: Document PyBuffer_ToContiguous() (GH-6292) (GH-6293)Miss Islington (bot)2018-03-281-3/+9
| | | | | (cherry picked from commit aa50bf08e64f49d57917ab0b1aadf4308a3168a6) Co-authored-by: Antoine Pitrou <pitrou@free.fr>
* bpo-32374: m_traverse may be called with m_state=NULL (GH-5140)Miss Islington (bot)2018-03-171-3/+9
| | | | | | | | Multi-phase initialized modules allow m_traverse to be called while the module is still being initialized, so module authors may need to account for that. (cherry picked from commit c2b0b12d1a137ada1023ab7c10b8d9a0249d95f9) Co-authored-by: Marcel Plch <gmarcel.plch@gmail.com>
* bpo-32500: Correct the documentation for PySequence_Size() and ↵Miss Islington (bot)2018-02-201-3/+2
| | | | | | | | PySequence_Length() (GH-5767) Dropped the part that says: "For objects that do not provide sequence protocol". (cherry picked from commit 7a1e1786f98ad49caa157dcdf14ada9d0b07d0fd) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* [3.6] Make formatting of some return codes conforming to the general style. ↵Serhiy Storchaka2018-02-092-11/+11
| | | | | | | (GH-5587). (GH-5598) (cherry picked from commit 5bb0005f9ff768ac443924b4bb26c3818ce8dc5a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Document the error return of PyLong_As* APIs. (GH-5396) (#5404)Miss Islington (bot)2018-01-291-0/+34
| | | | | | | Document the error return of PyLong_As* APIs. A frequent Python C API usage error is neglecting to check the return value and/or PyErr_Occurred(). (cherry picked from commit f5b04a360e44aa9733f7a92dd66d2292d6c52955)
* Fix PyTrace_RETURN documentation (GH-5384) (GH-5386)Miss Islington (bot)2018-01-281-1/+1
| | | | It will be triggered when propagating an exception. (cherry picked from commit 79db11ce99332d62917be9d03b31494b1ff2f96a)
* bpo-32687: Fix wrong meaning of args for PyTrace_LINE/CALL in documentation ↵Miss Islington (bot)2018-01-281-2/+2
| | | | | (GH-5361) (GH-5377) (cherry picked from commit 9ed0aee27c249dada410a22fff4325a4a61df36d)
* bpo-17799: Explain real behaviour of sys.settrace and sys.setprofile ↵Xiang Zhang2018-01-241-3/+7
| | | | | (GH-4056) (#5298) (cherry picked from commit 131fd7f96c619bc7eaea956e45c6337175f4b27f)
* [3.6] bpo-32555: Fix locale encodings (#5193)Victor Stinner2018-01-152-1/+31
| | | | | | | | | | | | | | | | | On FreeBSD and Solaris, os.strerror() now always decode the byte string from the current locale encoding, rather than using ASCII/surrogateescape in some cases. Changes: * Add _Py_DecodeLocaleEx() and _Py_EncodeLocaleEx() which has an additional current_locale parameter. * PyUnicode_DecodeLocale(), PyUnicode_DecodeLocaleAndSize() and * PyUnicode_EncodeLocale() now always use the current locale * encoding, instead of using Py_DecodeLocale()/Py_EncodeLocale(). * Document encoding in Py_DecodeLocale() and Py_EncodeLocale() documentations. * Add USE_FORCE_ASCII define to not define decode_ascii_surrogateescape() on Android.
* [3.6] bpo-30696: Fix the REPL looping endlessly when no memory (GH-4160). ↵xdegaye2017-11-121-1/+2
| | | | | (#4379) (cherry picked from commit e0582a37c8d1776a2fd4968e9216f3a05f780276)
* bpo-31678: Fix typo in PyDateTime_DELTA_GET_MICROSECONDS (GH-3869)Miss Islington (bot)2017-11-041-1/+1
| | | (cherry picked from commit 82cd3cede804ca694fb0657fd985d5eff84a414f)
* bpo-20064: Document PyObject_Malloc() (GH-4199) (#4203)Miss Islington (bot)2017-10-311-1/+64
| | | | | | | | | | | Document the following functions: * PyObject_Malloc() * PyObject_Calloc() * PyObject_Realloc() * PyObject_Free() Fix also PyMem_RawFree() documentation. (cherry picked from commit ec2cbdd1dff2c51788136480b2085e77506ebf34)
* [3.6] bpo-31754: Fix type of 'itemsize' in PyBuffer_FillContiguousStrides ↵Miss Islington (bot)2017-10-151-1/+1
| | | | | (GH-3993) (cherry picked from commit 1b9e76ed3a055a53ca67397e928e1b408461900b)
* bpo-29916: Include PyGetSetDef in C API extension documentation. (#831) (#3607)Michael Seifert2017-09-162-15/+40
| | | (cherry picked from commit da67e0d644bd3185efdaa4d15cc2ac0828ca83f9)
* bpo-30656: Fix Python C API Module Objects documentation (GH-2170) (GH-2230)Mariatta2017-06-161-1/+1
| | | | `PyModule_New()` now refers to `PyModule_NewObject()` (cherry picked from commit 2d0afef82a07afdb666f2ca0c533aac5d39155cd)
* [3.6] Fix typos in multiple `.rst` files (GH-1668) (#1702)delirious-lettuce2017-05-211-4/+4
| | | (cherry picked from commit 3378b2062c7fbb77a9b5e6d315d6b94160fac69a)
* [3.6] bpo-29751: Improve PyLong_FromString documentation (GH-915) (#1266)Mariatta2017-04-241-7/+6
| | | (cherry picked from commit 26896f2832324dde85cdd63d525571ca669f6f0b)
* bpo-19225: Remove duplicated description for standard warning categories ↵cocoatomo2017-04-201-12/+9
| | | | (GH-1068)
* [3.6] bpo-30059: Include Py_Ellipsis in C API documentation (GH-1018) (GH-1149)Michael Seifert2017-04-151-0/+11
|
* Keep the c-api exception doc up-to-date (#966)cocoatomo2017-04-031-56/+149
| | | cherry-pick'ed from ec1f5df..e3d6db3
* bpo-29917: DOC: Remove link from PyMethodDef (#890) (#894)Senthil Kumaran2017-03-301-2/+2
| | | (cherry picked from commit c3c7ef088583cc12bd218138036d1edb6de9c63f)
* bpo-28749: Fixed the documentation of the mapping codec APIs. (#487) (#714)Serhiy Storchaka2017-03-191-47/+48
| | | | Added the documentation for PyUnicode_Translate(). (cherry picked from commit c85a26628ceb9624c96c3064e8b99033c026d8a3)
* bpo-29746: Update marshal docs to Python 3. (#547) (#631)Serhiy Storchaka2017-03-121-4/+4
| | | (cherry picked from commit c611a5b1d4fab0123bf622f06c3bfa510221dc32)
* fix minor bug in pymalloc. (GH-335) (GH-476)Mariatta2017-03-061-1/+1
| | | (cherry picked from commit f669ffff6010a94f2d441200e0fd73e9dea2883e)
* Issue #29292: Merge 3.5.Xiang Zhang2017-01-201-2/+3
|\
| * Issue #29292: Update outdated doc of PyEval_EvalCodeEx.Xiang Zhang2017-01-201-2/+3
| | | | | | | | Patch by Ammar Askar.
* | Issue #15657: Merge other doc fix from 3.5Martin Panter2017-01-111-1/+1
|\ \ | |/
| * Issue #15657: METH_KEYWORDS cannot be used alone in Python 3Martin Panter2017-01-111-1/+1
| |
* | Issue #15657: Delete incorrect statement from PyMethodDef documentationMartin Panter2017-01-111-3/+2
| | | | | | | | Patch by Berker Peksag.
* | Issue #29087: Removed the documentation of non-existing UCS4 support functions.Serhiy Storchaka2016-12-281-20/+0
|\ \ | |/
| * Issue #29087: Removed the documentation of non-existing UCS4 support functions.Serhiy Storchaka2016-12-281-20/+0
| |
* | Merge from 3.5.Serhiy Storchaka2016-12-251-1/+1
|\ \ | |/
| * Issue #29068: Fixed a typo in PyErr_Fetch example.Serhiy Storchaka2016-12-251-1/+1
| | | | | | | | Patch by Chi Hsuan Yen.
* | Issue #29009: Merge 3.5.Xiang Zhang2016-12-191-4/+0
|\ \ | |/
| * Issue #29009: Remove outdated doc of PyUnicode_RichCompare.Xiang Zhang2016-12-191-4/+0
| |
* | Issue #28771: Merge C API doc fix from 3.5Martin Panter2016-12-101-5/+7
|\ \ | |/