(original) (raw)

changeset: 71895:ed2511c23dae user: Benjamin Peterson benjamin@python.org date: Wed Aug 17 12:03:47 2011 -0500 files: Lib/test/test_descr.py Misc/NEWS Objects/typeobject.c description: make __doc__ mutable on heaptypes (closes #12773) diff -r 7fee7f9d2c03 -r ed2511c23dae Lib/test/test_descr.py --- a/Lib/test/test_descr.py Wed Aug 17 11:54:03 2011 -0500 +++ b/Lib/test/test_descr.py Wed Aug 17 12:03:47 2011 -0500 @@ -4261,6 +4261,19 @@ m = str(cm.exception) self.assertEqual("'foo' in __slots__ conflicts with class variable", m) + def test_set_doc(self): + class X: + "elephant" + X.__doc__ = "banana" + self.assertEqual(X.__doc__, "banana") + with self.assertRaises(TypeError) as cm: + type(list).__dict__["__doc__"].__set__(list, "blah") + self.assertIn("can't set list.__doc__", str(cm.exception)) + with self.assertRaises(TypeError) as cm: + type(X).__dict__["__doc__"].__delete__(X) + self.assertIn("can't delete X.__doc__", str(cm.exception)) + self.assertEqual(X.__doc__, "banana") + class DictProxyTests(unittest.TestCase): def setUp(self): class C(object): diff -r 7fee7f9d2c03 -r ed2511c23dae Misc/NEWS --- a/Misc/NEWS Wed Aug 17 11:54:03 2011 -0500 +++ b/Misc/NEWS Wed Aug 17 12:03:47 2011 -0500 @@ -10,6 +10,8 @@ Core and Builtins ----------------- +- Issue #12773: Make __doc__ mutable on user-defined classes. + - Issue #12766: Raise an ValueError when creating a class with a class variable that conflicts with a name in __slots__. diff -r 7fee7f9d2c03 -r ed2511c23dae Objects/typeobject.c --- a/Objects/typeobject.c Wed Aug 17 11:54:03 2011 -0500 +++ b/Objects/typeobject.c Wed Aug 17 12:03:47 2011 -0500 @@ -588,6 +588,15 @@ return result; } +static int +type_set_doc(PyTypeObject *type, PyObject *value, void *context) +{ + if (!check_set_special_type_attr(type, value, "__doc__")) + return -1; + PyType_Modified(type); + return PyDict_SetItemString(type->tp_dict, "__doc__", value); +} + static PyObject * type___instancecheck__(PyObject *type, PyObject *inst) { @@ -623,7 +632,7 @@ {"__abstractmethods__", (getter)type_abstractmethods, (setter)type_set_abstractmethods, NULL}, {"__dict__", (getter)type_dict, NULL, NULL}, - {"__doc__", (getter)type_get_doc, NULL, NULL}, + {"__doc__", (getter)type_get_doc, (setter)type_set_doc, NULL}, {0} }; /benjamin@python.org