Skip to content

gh-107689: add docstrings to abstract classes #108882

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-107689: add docstrings to abstract classes #108882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2244664
add docstrings to abstract classes
kiblik1 Sep 4, 2023
6c29e2a
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 4, 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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2023-09-04-16-01-20.gh-issue-107689.LFLFtG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added docstrings to abstract ctypes.
33 changes: 30 additions & 3 deletions Modules/_ctypes/_ctypes.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2899,6 +2899,13 @@ static PyMethodDef PyCData_methods[] = {
{ NULL, NULL },
};

PyDoc_STRVAR(cdata_doc,
"This non-public class is the common base class of all ctypes data types. Among other things, all ctypes type\n"
"instances contain a memory block that hold C compatible data; the address of the memory block is returned\n"
"by the addressof() helper function. Another instance variable is exposed as _objects; this contains\n"
"other Python objects that need to be kept alive in case the memory block contains pointers."
);

PyTypeObject PyCData_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"_ctypes._CData",
Expand All @@ -2920,7 +2927,7 @@ PyTypeObject PyCData_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 */
cdata_doc, /* tp_doc */
(traverseproc)PyCData_traverse, /* tp_traverse */
(inquiry)PyCData_clear, /* tp_clear */
0, /* tp_richcompare */
Expand Down Expand Up @@ -5020,6 +5027,13 @@ Simple_repr(CDataObject *self)
return result;
}


PyDoc_STRVAR(simple_cdata_doc,
"This non-public class is the base class of all fundamental ctypes data types.\n"
"It contains the common attributes of the fundamentalctypes data types.\n"
"_SimpleCData is a subclass of _CData, so it inherits their methods and attributes."
);

static PyTypeObject Simple_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"_ctypes._SimpleCData",
Expand All @@ -5041,7 +5055,7 @@ static PyTypeObject Simple_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 */
simple_cdata_doc, /* tp_doc */
(traverseproc)PyCData_traverse, /* tp_traverse */
(inquiry)PyCData_clear, /* tp_clear */
0, /* tp_richcompare */
Expand Down Expand Up @@ -5402,6 +5416,19 @@ static PyNumberMethods Pointer_as_number = {
(inquiry)Pointer_bool, /* nb_bool */
};


PyDoc_STRVAR(cpointer_doc,
"Private, abstract base class for pointers.\n"
"\n"
"Concrete pointer types are created by calling POINTER() with the type that will be pointed to; this is done\n"
"automatically by pointer().\n"
"\n"
"If a pointer points to an array, its elements can be read and written using standard subscript and slice ac-\n"
"cesses. Pointer objects have no size, so len() will raise TypeError. Negative subscripts will read from the\n"
"memory before the pointer (as in C), and out-of-range subscripts will probably crash with an access violation\n"
"(if you’re lucky)."
);

PyTypeObject PyCPointer_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"_ctypes._Pointer",
Expand All @@ -5423,7 +5450,7 @@ PyTypeObject PyCPointer_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 */
cpointer_doc, /* tp_doc */
(traverseproc)PyCData_traverse, /* tp_traverse */
(inquiry)PyCData_clear, /* tp_clear */
0, /* tp_richcompare */
Expand Down