bpo-41287: Handle `doc` argument of `property.__init__` in subclasses by sizmailov · Pull Request #23205 · python/cpython

sizmailov · 2020-11-09T10:20:56Z

Process explicit doc argument of property(...) in the same manner as docstring of getter function in property subclasses.

This eliminates behavior differences between dummy class Property(property): pass and property (see test case for example)

https://bugs.python.org/issue41287

the-knights-who-say-ni · 2020-11-09T10:20:59Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@sizmailov

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

github-actions · 2020-12-16T00:27:17Z

This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

sizmailov · 2020-12-16T06:08:14Z

unstale

github-actions · 2021-01-16T01:01:34Z

This PR is stale because it has been open for 30 days with no activity.

MaxwellDupre

Works for me.
./python -m test -v test_pydoc
Ran 74 tests in 32.947s
OK (skipped=3)
test_pydoc passed in 33.1 sec
== Tests result: SUCCESS ==
1 test OK.
Total duration: 33.1 sec
Tests result: SUCCESS
cpython on  fix-issue41287 [$?] via 🐍 v3.11.0a5+ took 33s

JelleZijlstra

Thanks, and sorry this took so long! Unfortunately this needs a merge conflict fixed now. It also needs a NEWS entry.

sizmailov · 2022-04-03T08:35:10Z

Rebased branch on current main, added NEWS entry, addressed review comments.
Hopefully CI would show no errors 🤞

bedevere-bot · 2022-04-05T01:41:54Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

sizmailov · 2022-05-22T14:50:47Z

I think I found the leak. Can we run CI one more time, please?

bedevere-bot · 2022-05-22T14:59:08Z

🤖 New build scheduled with the buildbot fleet by @JelleZijlstra for commit fb8c2d4 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

sizmailov

Here are the last two things I want to add to this PR:

add a comment about prop_doc and
shortened version for the property branch.

I don't want to disrupt the current CI, so I'll push changes once it finishes.

EDIT: I pushed two more commits when CI reached 81 successful, 1 failure (same as in current main), and 1 stuck jobs.

sizmailov · 2022-05-27T18:00:02Z

@JelleZijlstra Could you please take another look at the PR :) This time everything should be in place.
Many thanks for the prompt CI trigger, it really helped to quickly check for errors, and saved my day!

bedevere-bot · 2022-05-27T18:35:39Z

🤖 New build scheduled with the buildbot fleet by @JelleZijlstra for commit 36fc1b0 🤖

If you want to schedule another build, you need to add the ":hammer: test-with-buildbots" label again.

JelleZijlstra · 2022-05-27T18:36:02Z

I triggered the buildbots to make sure, I'll review the PR again tonight. Thanks for your work!

JelleZijlstra

Looks good, just a few typos in the comments

Fix typos in comments Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

JelleZijlstra · 2022-05-29T04:14:39Z

Congratulations on your first contribution to Python!

encukou · 2022-11-03T13:51:09Z

This breaks subclasses that don't have a writable __doc__, see #98963

gpshead · 2023-06-03T00:52:22Z

Please see #105262 which restores the behavior this broke.

This PR extracts docstrings from static fields defined via `def_property_readonly_static` and `def_property_static`. This is based on the observation that the docstring for these fields is reachable from Python: ``` py >>> demo._bindings.properties.WithPropDoc.def_property_readonly_static 0 >>> demo._bindings.properties.WithPropDoc.__dict__['def_property_readonly_static'] <pybind11_builtins.pybind11_static_property object at 0x7bd623d73a70> >>> demo._bindings.properties.WithPropDoc.__dict__['def_property_readonly_static'].__doc__ 'prop doc token' ``` For each `Field` detected by pybind11-stubgen, `FixMissingFieldDocString` checks whether `__dict__[...]` is different from `obj`, which should only be the case for static properties. It then tries to use the dcostring in `__doc__`. ### Version compatibility This approach requires cpython 3.12+ as it relies on python/cpython#23205 and pybind11 2.10.1+ due to pybind/pybind11#4168

the-knights-who-say-ni added the CLA not signed label Nov 9, 2020

bedevere-bot added the awaiting review label Nov 9, 2020

sizmailov force-pushed the fix-issue41287 branch 2 times, most recently from c33eb5a to 73e81e4Compare November 9, 2020 13:14

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Nov 9, 2020

github-actionsBot added the stale Stale PR or inactive for long period of time. label Dec 16, 2020

github-actionsBot removed the stale Stale PR or inactive for long period of time. label Dec 17, 2020

github-actionsBot added the stale Stale PR or inactive for long period of time. label Jan 16, 2021

MaxwellDupre approved these changes Feb 8, 2022
View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Feb 8, 2022

JelleZijlstra reviewed Mar 24, 2022
View reviewed changes

Comment threadLib/test/test_pydoc.py Outdated
Comment threadObjects/descrobject.c Outdated

JelleZijlstra self-assigned this Mar 24, 2022

sizmailov added 2 commits April 3, 2022 11:04

Handle doc argument of property.__init__ in subclasses
b19523a

Add NEWS entry
0745f70

sizmailov force-pushed the fix-issue41287 branch from 73e81e4 to 0745f70Compare April 3, 2022 08:26

JelleZijlstra self-requested a review April 3, 2022 14:29

JelleZijlstra requested changes Apr 5, 2022
View reviewed changes

Comment threadLib/test/test_pydoc.py Outdated
Comment threadMisc/NEWS.d/next/Library/2022-04-03-11-25-02.bpo-41287.8CTdwf.rst Outdated
Comment threadObjects/descrobject.c Outdated
Comment threadObjects/descrobject.c Outdated
Comment threadLib/test/test_pydoc.py Outdated

bedevere-bot added awaiting changes and removed awaiting core review labels Apr 5, 2022

sizmailovand others added 3 commits April 5, 2022 13:02

Update Misc/NEWS.d/next/Library/2022-04-03-11-25-02.bpo-41287.8CTdwf.rst
ebec602
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

Move test to test_property.py
f09e6ac

Rename local get_doc -> prop_doc
dcab455

JelleZijlstra added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 22, 2022

bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 22, 2022

Add a comment
f8fb254

sizmailov commented May 22, 2022
View reviewed changes

Comment threadObjects/descrobject.c
Comment threadObjects/descrobject.c Outdated

sizmailov added 3 commits May 22, 2022 21:36

Remove unnecessary check
fc16ab9

Add test for property copy doc
4943868

Assign getter_doc only for non-null prop_doc
36fc1b0

JelleZijlstra self-requested a review May 27, 2022 18:35

JelleZijlstra added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 27, 2022

bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 27, 2022

JelleZijlstra reviewed May 28, 2022
View reviewed changes

Comment threadLib/test/test_property.py Outdated
Comment threadLib/test/test_property.py Outdated
Comment threadLib/test/test_property.py Outdated
Comment threadLib/test/test_property.py Outdated
Comment threadLib/test/test_property.py Outdated
Comment threadLib/test/test_property.py Outdated

Apply suggestions from code review
14bdd86
Fix typos in comments Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

JelleZijlstra approved these changes May 28, 2022
View reviewed changes

JelleZijlstra merged commit 66f5add into python:mainMay 29, 2022

bedevere-bot removed the awaiting merge label May 29, 2022

sizmailovmannequin mentioned this pull request Apr 10, 2022
__doc__ attribute is not set in property-derived classes #85459
Closed

henryiii mentioned this pull request Aug 3, 2022
[BUG]: Python 3.12 support pybind/pybind11#4115
Closed
3 tasks

Skylion007 mentioned this pull request Sep 16, 2022
fix: Python-3.12 compatibility pybind/pybind11#4168
Merged

encukou mentioned this pull request Nov 3, 2022
property assumes that its subclasses have __dict__ #98963
Closed

markuspi mentioned this pull request Apr 21, 2026
Add docstrings for static fields and properties pybind/pybind11-stubgen#308
Merged

Uh oh!

Uh oh!

Conversation

sizmailov commented Nov 9, 2020• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Nov 9, 2020

CLA Missing

Uh oh!

github-actionsBot commented Dec 16, 2020

Uh oh!

sizmailov commented Dec 16, 2020

Uh oh!

github-actionsBot commented Jan 16, 2021

Uh oh!

MaxwellDupre left a comment

Choose a reason for hiding this comment

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sizmailov commented Apr 3, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Apr 5, 2022

Uh oh!

sizmailov commented May 22, 2022

Uh oh!

bedevere-bot commented May 22, 2022

Uh oh!

sizmailov left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sizmailov commented May 27, 2022

Uh oh!

bedevere-bot commented May 27, 2022

Uh oh!

JelleZijlstra commented May 27, 2022

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JelleZijlstra commented May 29, 2022

Uh oh!

encukou commented Nov 3, 2022

Uh oh!

gpshead commented Jun 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

sizmailov commented Nov 9, 2020•
edited by bedevere-bot
Loading

sizmailov left a comment •
edited
Loading