This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: classes should have mutable docstrings
Type: behavior Stage: resolved
Components: Interpreter Core Versions: Python 3.3
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: eric.snow, michael.foord, ncoghlan, python-dev
Priority: normal Keywords: patch

Created on 2011-08-17 16:32 by eric.snow, last changed 2022-04-11 14:57 by admin. This issue is now closed.

File name Uploaded Description Edit
mutable_class_docstrings.diff eric.snow, 2011-08-17 16:32 review
Messages (2)
msg142287 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2011-08-17 16:32
Apparently docstrings for classes are immutable:

>>> class X:
...     "some doc"
>>> X.__doc__
'some doc'
>>> X.__doc__ = "another doc"
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
AttributeError: attribute '__doc__' of 'type' objects is not writable

That is on 3.3, but apparently it's the case all the way back to 2.2.
I mentioned this on python-list and several people indicated that it
should be an unnecessary restriction [1].  I also found that this only impacts classes that do not have a custom metaclass.

Regardless, it looks like this is something that no one has take the time to address but would be nice to have done [2][3].  I found that the type_getset for __doc__ does not have a getter:

I have attached a patch that adds one and fixes the problem.  "make test" passed after the fix.

msg142288 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-08-17 17:04
New changeset ed2511c23dae by Benjamin Peterson in branch 'default':
make __doc__ mutable on heaptypes (closes #12773)
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56982
2011-08-17 17:04:29python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg142288

resolution: fixed
stage: resolved
2011-08-17 16:32:38eric.snowcreate