mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 18:51:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

gh-97909: PyMemberDef & PyGetSetDef members are not marked up (GH-98810)

Browse source
This commit is contained in:
Johnny11502 2022-11-03 12:57:30 -04:00 • committed by GitHub
parent a60ddd31be
commit 00b6745f16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

36
Doc/c-api/structures.rst
View file

@ -485,23 +485,25 @@ Accessing attributes of extension types
Structure to define property-like access for a type. See also description of
the :c:member:`PyTypeObject.tp_getset` slot.
+-------------+------------------+-----------------------------------+
| Field | C Type | Meaning |
+=============+==================+===================================+
| name | const char \* | attribute name |
+-------------+------------------+-----------------------------------+
| get | getter | C function to get the attribute |
+-------------+------------------+-----------------------------------+
| set | setter | optional C function to set or |
| | | delete the attribute, if omitted |
| | | the attribute is readonly |
+-------------+------------------+-----------------------------------+
| doc | const char \* | optional docstring |
+-------------+------------------+-----------------------------------+
| closure | void \* | optional function pointer, |
| | | providing additional data for |
| | | getter and setter |
+-------------+------------------+-----------------------------------+
.. c:member:: const char* PyGetSetDef.name
attribute name
.. c:member:: getter PyGetSetDef.get
C funtion to get the attribute.
.. c:member:: setter PyGetSetDef.set
Optional C function to set or delete the attribute, if omitted the attribute is readonly.
.. c:member:: const char* PyGetSetDef.doc
optional docstring
.. c:member:: void* PyGetSetDef.closure
Optional function pointer, providing additional data for getter and setter.
The ``get`` function takes one :c:expr:`PyObject*` parameter (the
instance) and a function pointer (the associated ``closure``)::