8000 bpo-41287: Handle `doc` argument of `property.__init__` in subclasses by sizmailov · Pull Request #23205 · python/cpython · GitHub
[go: up one dir, main page]
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
merged 19 commits into from
May 29, 2022
Merged

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

Show file tree
Hide file tree
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
Move test to test_property.py
  • Loading branch information
@sizmailov
sizmailov committed Apr 5, 2022
commit f09e6acf396c4728cef810a1a675a9d60c0ad2fa
20 changes: 20 additions & 0 deletions Lib/test/test_property.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,26 @@ def spam(self):
else:
raise Exception("AttributeError not raised")

@unittest.skipIf(sys.flags.optimize >= 2,
"Docstrings are omitted with -O2 and above")
def test_issue41287(self):

self.assertEqual(PropertySub.__doc__, "This is a subclass of property",
"Docstring of `property` subclass is ignored")

doc = PropertySub(None, None, None, "issue 41287 is fixed").__doc__
self.assertEqual(doc, "issue 41287 is fixed",
"Subclasses of `property` ignores `doc` constructor argument")

def getter(x):
"""Getter docstring"""
doc = PropertySub(getter, None, None, "issue 41287 is fixed").__doc__
self.assertEqual(doc, "issue 41287 is fixed",
"Getter overrides explicit property docstring docstring")

doc = PropertySub(getter, None, None, None).__doc__
self.assertEqual(doc, "Getter docstring", "Getter docstring is not picked-up")

@unittest.skipIf(sys.flags.optimize >= 2,
"Docstrings are omitted with -O2 and above")
def test_docstring_copy(self):
Expand Down
19 changes: 0 additions & 19 deletions Lib/test/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,25 +449,6 @@ def test_issue8225(self):
result, doc_loc = get_pydoc_text(xml.etree)
self.assertEqual(doc_loc, "", "MODULE DOCS incorrectly includes a link")

def test_issue41287(self):
# Test issue41287 to ensure property subclass handles `doc` argument correctly

class Property(property):
"""A subclass of builtin property"""

self.assertEqual(Property.__doc__, "A subclass of builtin property", "Docstring of `property` subclass is ignored")

doc = Property(None, None, None, "issue 41287 is fixed").__doc__
self.assertEqual(doc, "issue 41287 is fixed", "Subclasses of `property` ignores `doc` constructor argument")

def getter(x):
"""Getter docstring"""
doc = Property(getter, None, None, "issue 41287 is fixed").__doc__
self.assertEqual(doc, "issue 41287 is fixed", "Getter overrides explicit property docstring docstring")

doc = Property(getter, None, None, None).__doc__
self.assertEqual(doc, "Getter docstring", "Getter docstring is not picked-up")

def test_getpager_with_stdin_none(self):
previous_stdin = sys.stdin
try:
Expand Down
0