gh-128862: use importlib.resources to acquire doctest resources #128865
+11
−16
Conversation
This file contains 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
graingert
commented
Jan 15, 2025
AA-Turner
reviewed
Feb 2, 2025
jaraco
reviewed
Feb 2, 2025
Co-authored-by: Jason R. Coombs <[email protected]>
jaraco
approved these changes
Mar 23, 2025
| def _load_testfile(filename, package, module_relative, encoding): | ||
| if module_relative: | ||
| package = _normalize_module(package, 3) | ||
| with contextlib.suppress(Exception): |
There was a problem hiding this comment.
What exceptions should be suppressed?
Exception is too wide class. It includes OSError, UnicodeDecodingError, MemoryError, which currently are not suppressed.
There was a problem hiding this comment.
This control flow feels odd, because we're returning in a suppress context manager.
Perhaps:
text = None
if module_relative:
package = _normalize_module(package, depth=3)
try:
text = resources.read_text(package, filename, encoding=encoding)
except:
filename = _module_relative_path(package, filename)
if text is None:
with open(filename, encoding=encoding) as f:
text = f.read()
return text, filename
Comment on lines
+244
to
+247
| return ( | ||
| importlib.resources.read_text(package, filename, encoding=encoding), | ||
| filename, | ||
| ) |
There was a problem hiding this comment.
Style nitpick. I think that the following code may look better:
Suggested change
| return ( | |
| importlib.resources.read_text(package, filename, encoding=encoding), | |
| filename, | |
| ) | |
| text = importlib.resources.read_text(package, filename, | |
| encoding=encoding) | |
| return text, filename |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
doctest._load_testfileuses deprecated Loader.get_data API, it should use importlib.resources #128862