[issue28771] Update documented signatures of tp_get/setattr
New submission from Martin Panter: https://docs.python.org/3.7/c-api/typeobj.html#c.PyTypeObject.tp_getattr tp_getattr and tp_setattr take a non-const char pointer in their signatures, but the documentation points to PyObject_GetAttrString() etc which were changed to take const char pointers a long time ago: revision 2f19b981ac24. This patch fixes the documentation of those two methods for Python 3. There could be more fixes needed for Python 2. ---------- assignee: docs@python components: Documentation files: typeobj-sigs.patch keywords: patch messages: 281468 nosy: docs@python, martin.panter priority: normal severity: normal stage: patch review status: open title: Update documented signatures of tp_get/setattr versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 Added file: http://bugs.python.org/file45600/typeobj-sigs.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Martin Panter added the comment: In Python 2, charbufferproc was changed to use non-const char ** in revision dba6494735d0 (perhaps by accident). Otherwise, this patch is the same as for Python 3. I have added a sentence about using NULL for deletion in the patch. ---------- Added file: http://bugs.python.org/file45616/typeobj-sigs.v2.py2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Martin Panter added the comment: Python 2 patch is on top of the patch for Issue 25701 ---------- dependencies: +Document that tp_setattro and tp_setattr are used for deleting attributes _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Roundup Robot added the comment: New changeset 2fd070fa6c15 by Martin Panter in branch '2.7': Issue #28771: Correct documentation of signatures using const https://hg.python.org/cpython/rev/2fd070fa6c15 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Roundup Robot added the comment: New changeset 5d51ac0be72a by Martin Panter in branch '3.5': Issue #28771: Update tp_get/setattr signature documentation https://hg.python.org/cpython/rev/5d51ac0be72a New changeset ee8c8b79d1d5 by Martin Panter in branch '3.6': Issue #28771: Merge C API doc fix from 3.5 https://hg.python.org/cpython/rev/ee8c8b79d1d5 New changeset c4865975b804 by Martin Panter in branch 'default': Issue #28771: Merge C API doc fix from 3.6 https://hg.python.org/cpython/rev/c4865975b804 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
Changes by Martin Panter <vadmium+py@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28771> _______________________________________
participants (3)
-
Martin Panter -
Roundup Robot
-
Serhiy Storchaka