Skip to content

gh-107659: Add docstring for ctypes.POINTER & ctypes.ARRAY #107739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Geekverma wants to merge 6 commits into from
Closed

gh-107659: Add docstring for ctypes.POINTER & ctypes.ARRAY #107739

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10910fc
Add docstring for ctypes.POINTER & ctypes.ARRAY
Geekverma Aug 7, 2023
088f541
Merge branch 'main' into ctype-pointer
Geekverma Aug 7, 2023
0b9a7d1
Update Modules/_ctypes/_ctypes.c
Geekverma Aug 7, 2023
1d7708c
one more
AlexWaygood Aug 7, 2023
8953783
Added docstring using array_doc variable form PyDoc_STRVAR()
Geekverma Aug 8, 2023
9c9be23
Merge branch 'main' into ctype-pointer
Geekverma Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion Modules/_ctypes/_ctypes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ addressof(cdata)
pointer(cdata)

POINTER(ctype)
- This factory function creates and returns a new ctypes pointer type.


bytes(cdata)
- return the buffer contents as a sequence of bytes (which is currently a string)
Expand Down Expand Up @@ -4814,7 +4816,13 @@ PyTypeObject PyCArray_Type = {
0, /* tp_setattro */
&PyCData_as_buffer, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
PyDoc_STR("XXX to be provided"), /* tp_doc */
PyDoc_STRVAR(array_doc,
Copy link
Contributor

@CharlieZhao95 CharlieZhao95 Aug 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error is here. Please take a look at the usage of PyDoc_STRVAR, you can search this in the source code of cpython :)

BTW. There is already a similar PR here.

"Abstract base class for arrays.\n"
"\n"
"The recommended way to create \n"
"concrete array types is by multiplying \n"
"any ctypes data type with a non-negative \n"
"integer.\n"), /* tp_doc */
(traverseproc)PyCData_traverse, /* tp_traverse */
(inquiry)PyCData_clear, /* tp_clear */
0, /* tp_richcompare */
Expand Down