Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
Original patch by Niklas Koep.
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index a9981fe..83dd0a3 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -122,7 +122,8 @@
If no dot is present, the entire :c:member:`~PyTypeObject.tp_name` field is made accessible as the
:attr:`~definition.__name__` attribute, and the :attr:`__module__` attribute is undefined
(unless explicitly set in the dictionary, as explained above). This means your
- type will be impossible to pickle.
+ type will be impossible to pickle. Additionally, it will not be listed in
+ module documentations created with pydoc.
This field is not inherited by subtypes.
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index a642912..ee173b7 100644
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -140,7 +140,9 @@
Note that the name is a dotted name that includes both the module name and the
name of the type within the module. The module in this case is :mod:`noddy` and
-the type is :class:`Noddy`, so we set the type name to :class:`noddy.Noddy`. ::
+the type is :class:`Noddy`, so we set the type name to :class:`noddy.Noddy`.
+One side effect of using an undotted name is that the pydoc documentation tool
+will not list the new type in the module documentation. ::
sizeof(noddy_NoddyObject), /* tp_basicsize */
diff --git a/Misc/ACKS b/Misc/ACKS
index 2f56888..9c805b0 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -733,6 +733,7 @@
Kubilay Kocak
Greg Kochanski
Manvisha Kodali
+Niklas Koep
Damon Kohler
Marko Kohtala
Vajrasky Kok
diff --git a/Misc/NEWS b/Misc/NEWS
index 1a737b8..ff55afe 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -10,6 +10,9 @@
Core and Builtins
-----------------
+- Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
+ Original patch by Niklas Koep.
+
- Issue #24098: Fixed possible crash when AST is changed in process of
compiling it.
diff --git a/Objects/typeobject.c b/Objects/typeobject.c
index 950835c..f6d4663 100644
--- a/Objects/typeobject.c
+++ b/Objects/typeobject.c
@@ -4066,6 +4066,12 @@
_Py_AddToAllObjects((PyObject *)type, 0);
#endif
+ if (type->tp_name == NULL) {
+ PyErr_Format(PyExc_SystemError,
+ "Type does not define the tp_name field.");
+ goto error;
+ }
+
/* Initialize tp_base (defaults to BaseObject unless that's us) */
base = type->tp_base;
if (base == NULL && type != &PyBaseObject_Type) {