NotificationsYou must be signed in to change notification settings
Fork33.3k
Star69.7k

gh-107995: Fix doctest collection of functools.cached_property objects#107996

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

AlexWaygood merged 3 commits intopython:mainfromtjsmart:fix-issue-107995

Aug 18, 2023

Merged

gh-107995: Fix doctest collection of functools.cached_property objects#107996

AlexWaygood merged 3 commits intopython:mainfromtjsmart:fix-issue-107995

Aug 18, 2023

Conversation

Copy link

Contributor

tjsmart commentedAug 16, 2023•
edited by bedevere-bot
Loading

DocTestFinder would skipfunctools.cached_property objects because they were not considered to be a part of the module that it is collecting doc tests from. To fix this issue I added a check forcached_property that grabs the underlying function, similar to what is done forstaticmethod andclassmethod.

Issue:@cached_property is not checked for doctests #107995

Copy link

ghost commentedAug 16, 2023•
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.

bedevere-bot mentioned this pull request

Aug 16, 2023

@cached_property is not checked for doctests#107995

Closed

2 tasks

bedevere-bot added the awaiting review label

Aug 16, 2023

Copy link

bedevere-bot commentedAug 16, 2023

Most changes to Pythonrequire a NEWS entry.

Please add it using theblurb_it web app or theblurb command-line tool.

tjsmart force-pushed thefix-issue-107995 branch from4e2f44b to3d02d97Compare

August 16, 2023 06:25

sobolevn approved these changes

Aug 16, 2023

View reviewed changes

Copy link

Member

sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM, thank you!

bedevere-bot added awaiting core review and removed awaiting review labels

Aug 16, 2023

AlexWaygood self-requested a review

August 16, 2023 07:31

AlexWaygood reviewed

Aug 16, 2023

View reviewed changes

Lib/doctest.py OutdatedShow resolvedHide resolved

tjsmart force-pushed thefix-issue-107995 branch from3d02d97 toda2616dCompare

August 18, 2023 04:18

tjsmart requested a review fromrhettinger as acode owner

August 18, 2023 04:18

AlexWaygood reviewed

Aug 18, 2023

View reviewed changes

Lib/functools.pyShow resolvedHide resolved

rhettinger removed their request for review

August 18, 2023 13:25

pythongh-107995: Fix doctest collection of functools.cached_property …

4591a60

…objects

tjsmart force-pushed thefix-issue-107995 branch fromda2616d to4591a60Compare

August 18, 2023 14:38

Improve docs

fed3ecc

AlexWaygood approved these changes

Aug 18, 2023

View reviewed changes

Copy link

Member

AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks! You can also add your name to this file here, if you like, but it isn't mandatory:https://github.com/python/cpython/blob/main/Misc/ACKS

bedevere-bot added awaiting merge and removed awaiting core review labels

Aug 18, 2023

AlexWaygood requested a review fromcarljm

August 18, 2023 14:48

Copy link

Member

AlexWaygood commentedAug 18, 2023

By the way, for future PRs to CPython, please avoid force-pushing where possible. It interacts badly with the GitHub UI, making it hard for reviewers to see what changed between commits. We merge everything using GitHub's "squash and merge" button in CPython, so we don't care about a messy commit history for a PR :-)

Copy link

ContributorAuthor

tjsmart commentedAug 18, 2023

By the way, for future PRs to CPython, please avoid force-pushing where possible. It interacts badly with the GitHub UI, making it hard for reviewers to see what changed between commits. We merge everything using GitHub's "squash and merge" button in CPython, so we don't care about a messy commit history for a PR :-)

Sounds good. Thanks for the heads up! 👍