Skip to content
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

Jump to bottom

gh-128816: fix an import warning in test_doctest.py when importing re… #128817

Merged
merged 11 commits into from
Jan 15, 2025
Merged

gh-128816: fix an import warning in test_doctest.py when importing re… #128817

merged 11 commits into from
Jan 15, 2025

Conversation

graingert
Copy link
Contributor

@graingert graingert commented Jan 14, 2025 •
edited by bedevere-app bot
Loading

@bedevere-app bedevere-app bot added the tests Tests in the Lib/test dir label Jan 14, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jan 14, 2025
Closed
@graingert graingert marked this pull request as ready for review January 14, 2025 09:05
serhiy-storchaka
serhiy-storchaka approved these changes Jan 14, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM.

But it seems that these methods are never called (only checked for existence). I would raise an AssertionError to ensure that they are not called.

@graingert
Copy link
Contributor Author

graingert commented Jan 14, 2025 •
edited
Loading

I believe they are called, eg when attempting to import readline and it is missing. I will check

@graingert
Copy link
Contributor Author

LGTM.

But it seems that these methods are never called (only checked for existence). I would raise an AssertionError to ensure that they are not called.

@serhiy-storchaka I checked and both functions are called, not just checked for existence

@graingert graingert added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Jan 14, 2025
serhiy-storchaka
serhiy-storchaka approved these changes Jan 15, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Oh, I missed that it is only reproducible if readline is not available. That is why I was not able to reproduce this issue.

LGTM.

@graingert
Copy link
Contributor Author

thanks for the review, but I can't merge it

serhiy-storchaka
serhiy-storchaka requested changes Jan 15, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

On other hand, the test now emit a different warning (even if readline is available):

test_lineendings (test.test_doctest.test_doctest)
Doctest: test.test_doctest.test_doctest.test_lineendings ... .../Lib/test/test_doctest/test_doctest.py:2887: DeprecationWarning: importlib.abc.ResourceLoader is deprecated in favour of supporting resource loading through importlib.resources.abc.ResourceReader.
  self.importer = TestImporter()
ok

And it fails with -Werror.

So this is not a complete fix.

@graingert
Copy link
Contributor Author

@serhiy-storchaka @brettcannon see #128862

@graingert
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Jan 15, 2025

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

serhiy-storchaka
serhiy-storchaka approved these changes Jan 15, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@serhiy-storchaka serhiy-storchaka merged commit 599be68 into python:main Jan 15, 2025
41 of 44 checks passed
@miss-islington-app
Copy link

Thanks @graingert for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@graingert graingert deleted the fix-test-doctest-warning branch January 15, 2025 13:18
@ambv ambv added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes and removed needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Jan 15, 2025
@miss-islington-app
Copy link

Thanks @graingert for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @graingert for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 15, 2025
@graingert @miss-islington
pythongh-128816: Fix warnings in test_doctest (pythonGH-128817)
c57b161 
* Fix a deprecation warning for using importlib.resources.abc.ResourceReader.
* Fix an import warning when importing readline (if it has not yet been imported).
(cherry picked from commit 599be68)

Co-authored-by: Thomas Grainger <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 15, 2025
@graingert @miss-islington
pythongh-128816: Fix warnings in test_doctest (pythonGH-128817)
5b76a10 
* Fix a deprecation warning for using importlib.resources.abc.ResourceReader.
* Fix an import warning when importing readline (if it has not yet been imported).
(cherry picked from commit 599be68)

Co-authored-by: Thomas Grainger <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jan 15, 2025

GH-128870 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 15, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jan 15, 2025

GH-128871 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jan 15, 2025
serhiy-storchaka pushed a commit that referenced this pull request Jan 16, 2025
@miss-islington @graingert
[3.13] gh-128816: Fix warnings in test_doctest (GH-128817) (GH-128870)
c927fd9 
* Fix a deprecation warning for using importlib.resources.abc.ResourceReader.
* Fix an import warning when importing readline (if it has not yet been imported).
(cherry picked from commit 599be68)

Co-authored-by: Thomas Grainger <[email protected]>
serhiy-storchaka pushed a commit that referenced this pull request Jan 16, 2025
@miss-islington @graingert
[3.12] gh-128816: Fix warnings in test_doctest (GH-128817) (GH-128871)
45b89bf 
* Fix a deprecation warning for using importlib.resources.abc.ResourceReader.
* Fix an import warning when importing readline (if it has not yet been imported).
(cherry picked from commit 599be68)

Co-authored-by: Thomas Grainger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees
No one assigned
Labels
skip news tests Tests in the Lib/test dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@graingert @serhiy-storchaka @ambv