Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

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
wants to merge 16 commits into
base: main
Choose a base branch
Loading
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 24 additions & 17 deletions 41 Lib/doctest.py
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:
graingert marked this conversation as resolved.
Show resolved Hide resolved
# Jim Fulton
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

Is it raised by importlib.resources.files() or by file.read_text()? Can text be None?

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

Expand Down
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
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.