cpython: 5d51ac0be72a (original) (raw)

Mercurial > cpython

changeset 105569:5d51ac0be72a 3.5

Issue #28771: Update tp_get/setattr signature documentation [#28771]

Martin Panter vadmium+py@gmail.com
date	Sat, 10 Dec 2016 05:56:13 +0000
parents	8e36c04d0e3e
children	ee8c8b79d1d5 1a955981b263
files	Doc/c-api/typeobj.rst
diffstat	1 files changed, 7 insertions(+), 5 deletions(-)[+] [-] Doc/c-api/typeobj.rst 12

line wrap: on

line diff

--- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -199,8 +199,9 @@ type objects) must have the :attr:ob_[](#l1.3) [](#l1.4) This field is deprecated. When it is defined, it should point to a function[](#l1.5) that acts the same as the :c:member:~PyTypeObject.tp_getattro` function, but taking a C string

instead of a Python string object to give the attribute name. The signature is
the same as for :c:func:PyObject_GetAttrString.

instead of a Python string object to give the attribute name. The signature is :: +

 PyObject * tp_getattr(PyObject *o, char *attr_name);[](#l1.11)

This field is inherited by subtypes together with :c:member:~PyTypeObject.tp_getattro: a subtype inherits both :c:member:~PyTypeObject.tp_getattr and :c:member:~PyTypeObject.tp_getattro from its base type when @@ -213,10 +214,11 @@ type objects) must have the :attr:ob_[](#l1.15) [](#l1.16) This field is deprecated. When it is defined, it should point to a function[](#l1.17) that acts the same as the :c:member:~PyTypeObject.tp_setattro` function, but taking a C string

instead of a Python string object to give the attribute name. The signature is
the same as for :c:func:PyObject_SetAttrString, but setting
v to NULL to delete an attribute must be supported.

instead of a Python string object to give the attribute name. The signature is ::

 PyObject * tp_setattr(PyObject *o, char *attr_name, PyObject *v);[](#l1.24)

The v argument is set to NULL to delete the attribute. This field is inherited by subtypes together with :c:member:~PyTypeObject.tp_setattro: a subtype inherits both :c:member:~PyTypeObject.tp_setattr and :c:member:~PyTypeObject.tp_setattro from its base type when the subtype's :c:member:~PyTypeObject.tp_setattr and :c:member:~PyTypeObject.tp_setattro are both NULL.