mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 07:26:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

gh-97909: Mark up members of PyMemberDef (GH-98473)

Browse source 
Co-authored-by: T <tnie@tuta.io>
This commit is contained in:
Johnny11502 2022-10-24 10:13:38 -04:00 • committed by GitHub
parent e19c2b979f
commit c237076379
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -387,27 +387,27 @@ Accessing attributes of extension types
Structure which describes an attribute of a type which corresponds to a C Structure which describes an attribute of a type which corresponds to a C
struct member. Its fields are: struct member. Its fields are:
+------------------+---------------+-------------------------------+ .. c:member:: const char* PyMemberDef.name
| Field | C Type | Meaning |
+==================+===============+===============================+
| :attr:`name` | const char \* | name of the member |
+------------------+---------------+-------------------------------+
| :attr:`!type` | int | the type of the member in the |
| | | C struct |
+------------------+---------------+-------------------------------+
| :attr:`offset` | Py_ssize_t | the offset in bytes that the |
| | | member is located on the |
| | | type's object struct |
+------------------+---------------+-------------------------------+
| :attr:`flags` | int | flag bits indicating if the |
| | | field should be read-only or |
| | | writable |
+------------------+---------------+-------------------------------+
| :attr:`doc` | const char \* | points to the contents of the |
| | | docstring |
+------------------+---------------+-------------------------------+
:attr:`!type` can be one of many ``T_`` macros corresponding to various C Name of the member
.. c:member:: int PyMemberDef.type
The type of the member in the C struct.
.. c:member:: Py_ssize_t PyMemberDef.offset
The offset in bytes that the member is located on the type’s object struct.
.. c:member:: int PyMemberDef.flags
Flag bits indicating if the field should be read-only or writable.
.. c:member:: const char* PyMemberDef.doc
Points to the contents of the docstring.
:c:member:`PyMemberDef.type` can be one of many ``T_`` macros corresponding to various C
types. When the member is accessed in Python, it will be converted to the types. When the member is accessed in Python, it will be converted to the
equivalent Python type. equivalent Python type.
@ -441,7 +441,7 @@ Accessing attributes of extension types
handles use of the :keyword:`del` statement on that attribute more correctly handles use of the :keyword:`del` statement on that attribute more correctly
than :c:macro:`T_OBJECT`. than :c:macro:`T_OBJECT`.
:attr:`flags` can be ``0`` for write and read access or :c:macro:`READONLY` for :c:member:`PyMemberDef.flags` can be ``0`` for write and read access or :c:macro:`READONLY` for
read-only access. Using :c:macro:`T_STRING` for :attr:`type` implies read-only access. Using :c:macro:`T_STRING` for :attr:`type` implies
:c:macro:`READONLY`. :c:macro:`T_STRING` data is interpreted as UTF-8. :c:macro:`READONLY`. :c:macro:`T_STRING` data is interpreted as UTF-8.
Only :c:macro:`T_OBJECT` and :c:macro:`T_OBJECT_EX` Only :c:macro:`T_OBJECT` and :c:macro:`T_OBJECT_EX`