Skip to content

bpo-41287: Handle doc argument of property.__init__ in subclasses #23205

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

Merged
JelleZijlstra merged 19 commits into from
May 29, 2022
Merged

bpo-41287: Handle doc argument of property.__init__ in subclasses #23205

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b19523a
Handle `doc` argument of `property.__init__` in subclasses
sizmailov Nov 9, 2020
0745f70
Add NEWS entry
sizmailov Apr 3, 2022
ebec602
Update Misc/NEWS.d/next/Library/2022-04-03-11-25-02.bpo-41287.8CTdwf.rst
sizmailov Apr 5, 2022
f09e6ac
Move test to test_property.py
sizmailov Apr 5, 2022
dcab455
Rename local get_doc -> prop_doc
sizmailov Apr 5, 2022
de2c3c0
Add prop_doc != NULL check
sizmailov Apr 5, 2022
bd4cdca
Add more tests
sizmailov Apr 5, 2022
1a1247e
Fix test
sizmailov Apr 5, 2022
009a9f3
Fix introduced refleak
sizmailov Apr 7, 2022
d2aa925
Merge branch 'main' into fix-issue41287
JelleZijlstra May 2, 2022
8730abc
Test vanila property too
sizmailov May 22, 2022
0302ffb
Fix __doc__ assignment in property subclass
sizmailov May 22, 2022
e1ec1dc
Merge remote-tracking branch 'upstream/main' into fix-issue41287
sizmailov May 22, 2022
fb8c2d4
Fix Py_None ref leak
sizmailov May 22, 2022
f8fb254
Add a comment
sizmailov May 22, 2022
fc16ab9
Remove unnecessary check
sizmailov May 22, 2022
4943868
Add test for property copy doc
sizmailov May 26, 2022
36fc1b0
Assign getter_doc only for non-null prop_doc
sizmailov May 26, 2022
14bdd86
Apply suggestions from code review
sizmailov May 28, 2022
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
Prev Previous commit
Next Next commit
Fix introduced refleak
  • Loading branch information
@sizmailov
sizmailov committed Apr 7, 2022
commit 009a9f3ef8799a53fda9b2bda235099f7cbbf32f
38 changes: 19 additions & 19 deletions Objects/descrobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1791,33 +1791,33 @@ property_init_impl(propertyobject *self, PyObject *fget, PyObject *fset,
self->getter_doc = 0;
PyObject *prop_doc = NULL;

if (doc != NULL && doc != Py_None) {
prop_doc = doc;
Py_XINCREF(prop_doc);
}
/* if no docstring given and the getter has one, use that one */
if ((doc == NULL || doc == Py_None) && fget != NULL) {
else if (fget != NULL) {
int rc = _PyObject_LookupAttr(fget, &_Py_ID(__doc__), &prop_doc);
if (rc <= 0) {
return rc;
}
self->getter_doc = 1;
Comment thread
sizmailov marked this conversation as resolved.
Outdated
}
else {
prop_doc = doc;
Py_XINCREF(prop_doc);
}


Comment thread
sizmailov marked this conversation as resolved.
if (Py_IS_TYPE(self, &PyProperty_Type)) {
Py_XSETREF(self->prop_doc, prop_doc);
}
else if (prop_doc != NULL) {
/* If this is a property subclass, put __doc__
in dict of the subclass instance instead,
otherwise it gets shadowed by __doc__ in the
class's dict. */
int err = PyObject_SetAttr(
(PyObject *)self, &_Py_ID(__doc__), prop_doc);
Py_XDECREF(prop_doc);
if (err < 0)
return -1;
if (prop_doc != NULL && prop_doc != Py_None) {
Comment thread
JelleZijlstra marked this conversation as resolved.
Outdated
if (Py_IS_TYPE(self, &PyProperty_Type)) {
Py_XSETREF(self->prop_doc, prop_doc);
} else {
/* If this is a property subclass, put __doc__
in dict of the subclass instance instead,
otherwise it gets shadowed by __doc__ in the
class's dict. */
int err = PyObject_SetAttr(
(PyObject *)self, &_Py_ID(__doc__), prop_doc);
Py_XDECREF(prop_doc);
if (err < 0)
return -1;
}
}

return 0;
Expand Down