-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-128862: use importlib.resources to acquire doctest resources #128865
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
graingert
wants to merge
16
commits into
python:main
Choose a base branch
from
graingert:use-importlib-resources-for-doctest
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
2006516
gh-128862: use importlib.resources to acquire doctest resources
graingert 626233e
only compute module relative path when falling back from importlib.re…
graingert 6b30ba8
📜🤖 Added by blurb_it.
blurb-it[bot] 1cb9321
Update Lib/doctest.py
graingert dca3a82
Merge branch 'main' into use-importlib-resources-for-doctest
graingert 1df5ed7
Merge branch 'main' into use-importlib-resources-for-doctest
graingert 2472168
Merge branch 'main' into use-importlib-resources-for-doctest
graingert f8f4e63
Merge branch 'main' into use-importlib-resources-for-doctest
graingert 57a37f2
Update Lib/doctest.py
graingert 6a530c4
Merge branch 'main' into use-importlib-resources-for-doctest
graingert 6bda92b
Update doctest.py
graingert 68475b6
Update Lib/doctest.py
AA-Turner b9ba4e1
Merge branch 'main' into use-importlib-resources-for-doctest
AA-Turner 0621551
Merge branch 'main' into use-importlib-resources-for-doctest
graingert 24c06b8
Apply suggestion
AA-Turner 05f0403
Update 2025-01-15-11-57-42.gh-issue-128862.TDHQdR.rst
AA-Turner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
# Module doctest. | ||
# Released to the public domain 16-Jan-2001, by Tim Peters (tim@python.org). | ||
# Major enhancements and refactoring by: | ||
# Jim Fulton | ||
|
@@ -102,7 +101,8 @@ def _test(): | |
import sys | ||
import traceback | ||
import unittest | ||
from io import StringIO, IncrementalNewlineDecoder | ||
import importlib.resources | ||
from io import StringIO | ||
from collections import namedtuple | ||
import _colorize # Used in doctests | ||
from _colorize import ANSIColors, can_colorize | ||
|
@@ -235,25 +235,32 @@ def _normalize_module(module, depth=2): | |
else: | ||
raise TypeError("Expected a module, string, or None") | ||
|
||
def _newline_convert(data): | ||
# The IO module provides a handy decoder for universal newline conversion | ||
return IncrementalNewlineDecoder(None, True).decode(data, True) | ||
|
||
def _load_testfile(filename, package, module_relative, encoding): | ||
if module_relative: | ||
package = _normalize_module(package, 3) | ||
try: | ||
loader = package.__loader__ | ||
except AttributeError: | ||
pass | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it raised by |
||
else: | ||
if loader is not None: | ||
return ( | ||
importlib.resources.read_text(package, filename, encoding=encoding), | ||
filename, | ||
) | ||
|
||
try: | ||
package.__spec__.loader | ||
except AttributeError: | ||
pass | ||
else: | ||
return ( | ||
importlib.resources.read_text(package, filename, encoding=encoding), | ||
filename, | ||
) | ||
|
||
graingert marked this conversation as resolved.
Show resolved
Hide resolved
graingert marked this conversation as resolved.
Show resolved
Hide resolved
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
filename = _module_relative_path(package, filename) | ||
if (loader := getattr(package, '__loader__', None)) is None: | ||
try: | ||
loader = package.__spec__.loader | ||
except AttributeError: | ||
pass | ||
if hasattr(loader, 'get_data'): | ||
file_contents = loader.get_data(filename) | ||
file_contents = file_contents.decode(encoding) | ||
# get_data() opens files as 'rb', so one must do the equivalent | ||
# conversion as universal newlines would do. | ||
return _newline_convert(file_contents), filename | ||
|
||
with open(filename, encoding=encoding) as f: | ||
return f.read(), filename | ||
|
||
|
1 change: 1 addition & 0 deletions
1
Misc/NEWS.d/next/Library/2025-01-15-11-57-42.gh-issue-128862.TDHQdR.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Use ``importlib.resources`` to acquire test files in ``doctest`` | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.