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: Subclassing property doesn't preserve the auto __doc__ behavior
Type: behavior Stage: resolved
Components: Interpreter Core Versions: Python 3.0, Python 3.1, Python 2.7, Python 2.6
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: r.david.murray Nosy List: gsakkis, moriyoshi, r.david.murray
Priority: normal Keywords: needs review, patch

Created on 2009-04-30 22:13 by gsakkis, last changed 2022-04-11 14:56 by admin. This issue is now closed.

File name Uploaded Description Edit
issue5890.patch r.david.murray, 2009-05-04 21:09
issue5890-refix-py2.6.patch moriyoshi, 2009-11-12 02:18 patch
issue5890-refix-trunk.patch moriyoshi, 2009-11-12 02:18 patch (against trunk)
Messages (13)
msg86859 - (view) Author: George Sakkis (gsakkis) Date: 2009-04-30 22:13
Is the following behavior expected ?

class MyProp(property):

class Foo(object):
    def bar(self):
        '''Get a bar.'''

    def baz(self):
        '''Get a baz.'''

>>> print 
Get a bar.
>>> print Foo.baz.__doc__
msg86918 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-01 21:53
What is happening here is that when __doc__ is looked up, it is found
first among the attributes of the class type.  __doc__ is special, and
types define it to be None if it not set to anything specific.  So the
docstring for an instance of a subclass of property is None, or the
docstring of the subclass if one is provided.  The other property
attributes aren't affected since they aren't "special" attributes on
types, and so get looked up on the base class as expected.

I believe the fix is to have property's __init__ check to see if it is
dealing with a subclass, and if so to insert the __doc__ string into the
instance's __dict__.

Patch attached.  Needs review, especially since I'm new to internals stuff.
msg86923 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-01 22:22
Fixes from review on #python-dev by Benjamin.

It looks like I also need to look at property_copy.
msg87174 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-04 20:54
Updated patch that updates property_copy so that the __doc__ string is
also copied appropriately when getter, setter, or deller are used.  A
bunch more tests, as well. I refactored property_copy to make it reuse
the logic in property_init directly.

Unfortunately I've got a refleak somewhere in there (regrtest -R :: says
[8, 8, 8, 8].  Hopefully fresh and more experienced eyes can help me out.
msg87176 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-04 21:09
Updated patch with refleak fixed.  Thanks Georg.
msg87199 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-05-05 01:03
Reviewed by Georg and approved on #python-dev.  Committed in r72299,
r72301, r72302, and r72304.
msg95142 - (view) Author: Moriyoshi Koizumi (moriyoshi) Date: 2009-11-11 17:09
A subclass of property doesn't always have writable __doc__, especially 
what is implemented in C.  This actually causes a problem with 
Boost.Python's StaticProperty.

msg95154 - (view) Author: Moriyoshi Koizumi (moriyoshi) Date: 2009-11-12 02:18
I created a patch against trunk and 2.6-maint that lets it simply ignore
the error that might happen during PyObject_SetAttrString();
msg95155 - (view) Author: Moriyoshi Koizumi (moriyoshi) Date: 2009-11-12 02:18
and the other one
msg95319 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-11-16 01:08
It seems to me that all that patch does is re-enable the bug (in the
extension class context) that the patch for this issue was a workaround
for.  I think perhaps the correct fix is to look at how the __doc__
attribute is found in the general case and see if it can be fixed there,
allowing the removal of the workaround in property.

See for example this sub-thread on python-dev:
msg95345 - (view) Author: Moriyoshi Koizumi (moriyoshi) Date: 2009-11-16 13:28
Sorry, I don't quite have an idea on the part "these patches reenable
the bug". The script of the first message yields exactly the same result
both with the original 2.6.4 and the patched.  Assuming the weirdness
you referred to is different from 5890, I'd say the workaround
introduced by the original patch to property class didn't correctly
avoid the issue in the first place. I mean the fix should be fixed anyhow.
msg95346 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-11-16 13:51
Well, I haven't worked with boost or any other extension class that
defines a subclass of property.  If MyProp is such a subclass, would
print Fro.baz.__doc__ print "Get a baz" in 2.6.2 but raise an error in
2.6.3/4, or would it print None?

Regardless of which one it does, I think there is a better fix than
patching the original patch in this issue, assuming I can code it and
get approval to apply it.

On the other hand, the suggested 'refix' may be appropriate for 2.6.5.
msg95464 - (view) Author: Moriyoshi Koizumi (moriyoshi) Date: 2009-11-19 05:28

> If MyProp is such a subclass, would
> print Fro.baz.__doc__ print "Get a baz" in 2.6.2 but raise an error in
> 2.6.3/4, or would it print None?

Just let it return None as they were for now.  I completely agree
there's a better fix like delegating the access to __doc__ to the base
class (property class in this specific case).
Date User Action Args
2022-04-11 14:56:48adminsetgithub: 50140
2009-11-19 05:28:30moriyoshisetmessages: + msg95464
2009-11-16 13:51:44r.david.murraysetmessages: + msg95346
2009-11-16 13:28:17moriyoshisetmessages: + msg95345
2009-11-16 01:08:51r.david.murraysetmessages: + msg95319
2009-11-12 02:18:41moriyoshisetfiles: + issue5890-refix-trunk.patch

messages: + msg95155
2009-11-12 02:18:05moriyoshisetfiles: + issue5890-refix-py2.6.patch

messages: + msg95154
2009-11-11 17:09:18moriyoshisetnosy: + moriyoshi
messages: + msg95142
2009-05-05 01:03:19r.david.murraysetstatus: open -> closed
resolution: fixed
messages: + msg87199

stage: patch review -> resolved
2009-05-04 21:09:31r.david.murraysetfiles: - issue5890.patch
2009-05-04 21:09:26r.david.murraysetfiles: - issue5890.patch
2009-05-04 21:09:18r.david.murraysetfiles: + issue5890.patch

messages: + msg87176
2009-05-04 20:54:48r.david.murraysetfiles: + issue5890.patch

messages: + msg87174
2009-05-01 22:22:25r.david.murraysetfiles: + issue5890.patch

messages: + msg86923
2009-05-01 22:20:35r.david.murraysetfiles: - issue5890.patch
2009-05-01 21:53:17r.david.murraysetfiles: + issue5890.patch

assignee: r.david.murray
keywords: + patch, needs review
stage: patch review
versions: + Python 2.6, Python 3.0, Python 3.1, Python 2.7
nosy: + r.david.murray
messages: + msg86918
priority: normal
components: + Interpreter Core
2009-04-30 22:13:11gsakkiscreate