Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
fd0212d
gh-134215: Improve ModuleCompleter module
kevteg May 19, 2025
3e314e8
Merge branch 'main' into pyrepl_underscored_fix
kevteg May 19, 2025
7c4f4c8
Remove unused import
kevteg May 19, 2025
ff6b6a3
Merge branch 'pyrepl_underscored_fix' of github.com:kevteg/cpython in…
kevteg May 19, 2025
f7a2db9
Add news
kevteg May 19, 2025
2c5f81e
Rename method
kevteg May 19, 2025
1472148
Update method name
kevteg May 19, 2025
5f97959
Feedback
kevteg May 19, 2025
a04ecdf
Feedback
kevteg May 19, 2025
ca89754
Update docstring
kevteg May 19, 2025
5636adb
Merge branch 'main' into pyrepl_underscored_fix
kevteg May 19, 2025
dc1a403
Merge branch 'pyrepl_underscored_fix' of github.com:kevteg/cpython in…
kevteg May 19, 2025
4a2872a
Update tests
kevteg May 19, 2025
e854d10
Update Lib/test/test_pyrepl/test_pyrepl.py
kevteg May 19, 2025
e3fc8e0
Update Misc/NEWS.d/next/Tools-Demos/2025-05-19-14-57-46.gh-issue-1342…
kevteg May 19, 2025
4918343
Fix
kevteg May 19, 2025
04f78cf
Merge branch 'pyrepl_underscored_fix' of github.com:kevteg/cpython in…
kevteg May 19, 2025
ff02e15
Merge branch 'main' into pyrepl_underscored_fix
kevteg May 20, 2025
262b4e1
Merge branch 'main' into pyrepl_underscored_fix
kevteg May 20, 2025
0323ec3
Small refactor
kevteg May 20, 2025
038fc4e
Merge branch 'pyrepl_underscored_fix' of github.com:kevteg/cpython in…
kevteg May 20, 2025
76435a0
Merge branch 'main' into pyrepl_underscored_fix
kevteg May 20, 2025
14cac01
Remove docstring
kevteg May 20, 2025
e1ac435
Merge branch 'pyrepl_underscored_fix' of github.com:kevteg/cpython in…
kevteg May 20, 2025
1e88864
Update Lib/_pyrepl/_module_completer.py
ambv May 20, 2025
99a3d6b
Merge branch 'main' into pyrepl_underscored_fix
ambv May 20, 2025
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
17 changes: 14 additions & 3 deletions Lib/_pyrepl/_module_completer.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,10 @@ def find_modules(self, path: str, prefix: str) -> list[str]:
def _find_modules(self, path: str, prefix: str) -> list[str]:
if not path:
# Top-level import (e.g. `import foo<tab>`` or `from foo<tab>`)`
builtin_modules = [name for name in sys.builtin_module_names if name.startswith(prefix)]
third_party_modules = [name for _, name, _ in self.global_cache if name.startswith(prefix)]
builtin_modules = [name for name in sys.builtin_module_names
if self.is_suggestion_match(name, prefix)]
third_party_modules = [module.name for module in self.global_cache
if self.is_suggestion_match(module.name, prefix)]
return sorted(builtin_modules + third_party_modules)

if path.startswith('.'):
Expand All @@ -98,7 +100,16 @@ def _find_modules(self, path: str, prefix: str) -> list[str]:
if mod_info.ispkg and mod_info.name == segment]
modules = self.iter_submodules(modules)
return [module.name for module in modules
if module.name.startswith(prefix)]
if self.is_suggestion_match(module.name, prefix)]

def is_suggestion_match(self, module_name: str, prefix: str) -> bool:
"""
Return True if the module name matches the prefix or if no prefix is specified.
Return False if the name is private (starts with _) and no prefix is specified
"""
if prefix:
return module_name.startswith(prefix)
return not module_name.startswith("_")

def iter_submodules(self, parent_modules: list[pkgutil.ModuleInfo]) -> Iterator[pkgutil.ModuleInfo]:
"""Iterate over all submodules of the given parent modules."""
Expand Down
41 changes: 41 additions & 0 deletions Lib/test/test_pyrepl/test_pyrepl.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import subprocess
import sys
import tempfile
from pkgutil import ModuleInfo
from unittest import TestCase, skipUnless, skipIf
from unittest.mock import patch
from test.support import force_not_colorized, make_clean_env, Py_DEBUG
Expand Down Expand Up @@ -959,6 +960,46 @@ def test_import_completions(self):
output = reader.readline()
self.assertEqual(output, expected)

@patch("pkgutil.iter_modules", lambda: [(None, 'public', None),
(None, '_private', None)])
@patch("sys.builtin_module_names", ())
def test_private_completions(self):
cases = (
# Return public methods by default
("import \t\n", "import public"),
("from \t\n", "from public"),
# Return private methods if explicitly specified
("import _\t\n", "import _private"),
("from _\t\n", "from _private"),
)
for code, expected in cases:
with self.subTest(code=code):
events = code_to_events(code)
reader = self.prepare_reader(events, namespace={})
output = reader.readline()
self.assertEqual(output, expected)

@patch(
"_pyrepl._module_completer.ModuleCompleter.iter_submodules",
lambda *_: [
ModuleInfo(None, "public", True),
ModuleInfo(None, "_private", True),
],
)
def test_sub_module_private_completions(self):
cases = (
# Return public methods by default
("from foo import \t\n", "from foo import public"),
# Return private methods if explicitly specified
("from foo import _\t\n", "from foo import _private"),
)
for code, expected in cases:
with self.subTest(code=code):
events = code_to_events(code)
reader = self.prepare_reader(events, namespace={})
output = reader.readline()
self.assertEqual(output, expected)

def test_builtin_completion_top_level(self):
import importlib
# Make iter_modules() search only the standard library.
Expand Down
1 change: 1 addition & 0 deletions Misc/ACKS
Original file line number Diff line number Diff line change
Expand Up @@ -763,6 +763,7 @@ Chris Herborth
Ivan Herman
Jürgen Hermann
Joshua Jay Herman
Kevin Hernandez
Gary Herron
Ernie Hershey
Thomas Herve
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
autocompletion return the private modules (start with _) only if explicitly specified
Loading