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
Apply suggestions from code review 
Fix typos in comments

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
  • Loading branch information
@sizmailov @JelleZijlstra
sizmailov and JelleZijlstra authored May 28, 2022
commit 14bdd862dae123e5291ab3682831d0c765ef91f0
18 changes: 9 additions & 9 deletions Lib/test/test_property.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,10 +288,10 @@ def spam(self):
"Docstrings are omitted with -O2 and above")
def test_docstring_copy2(self):
"""
Property tries to provide the best docstring it finds for it's copies.
If a user-provieded docstring is avaialble it's preserved in the copies.
If no docsting is available during property creation, the property
would utilze docstring from getter if available.
Property tries to provide the best docstring it finds for its instances.
If a user-provided docstring is available, it is preserved on copies.
If no docstring is available during property creation, the property
will utilize the docstring from the getter if available.
"""
def getter1(self):
return 1
Expand All @@ -302,31 +302,31 @@ def getter3(self):
"""doc 3"""
return 3

# Case-1: user-provied doc is preserved in copies
# Case-1: user-provided doc is preserved in copies
# of property with undocumented getter
p = property(getter1, None, None, "doc-A")

p2 = p.getter(getter2)
self.assertEqual(p.__doc__, "doc-A")
self.assertEqual(p2.__doc__, "doc-A")

# Case-2: user-provied doc is preserved in copies
# Case-2: user-provided doc is preserved in copies
# of property with documented getter
p = property(getter2, None, None, "doc-A")

p2 = p.getter(getter3)
self.assertEqual(p.__doc__, "doc-A")
self.assertEqual(p2.__doc__, "doc-A")

# Case-3: with no user-provied doc new getter doc
# Case-3: with no user-provided doc new getter doc
# takes precendence
p = property(getter2, None, None, None)

p2 = p.getter(getter3)
self.assertEqual(p.__doc__, "doc 2")
self.assertEqual(p2.__doc__, "doc 3")

# Case-4: A user-provied doc is assigned after property construction
# Case-4: A user-provided doc is assigned after property construction
# with documented getter. The doc IS NOT preserved.
# It's an odd behaviour, but it's a strange enough
# use case with no easy solution.
Expand All @@ -336,7 +336,7 @@ def getter3(self):
self.assertEqual(p.__doc__, "user")
self.assertEqual(p2.__doc__, "doc 3")

# Case-5: A user-provied doc is assigned after property construction
# Case-5: A user-provided doc is assigned after property construction
# with UNdocumented getter. The doc IS preserved.
p = property(getter1, None, None, None)
p.__doc__ = "user"
Expand Down