Skip to content

Remove more v1 functions in converter (magic, file) #14731

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

Merged
Carreau merged 1 commit into from
Feb 10, 2025
Merged

Remove more v1 functions in converter (magic, file) #14731

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 35 additions & 28 deletions IPython/core/completer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2025,13 +2025,6 @@ def _clean_glob_win32(self, text:str):

@context_matcher()
def file_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
"""Same as :any:`file_matches`, but adopted to new Matcher API."""
matches = self.file_matches(context.token)
# TODO: add a heuristic for suppressing (e.g. if it has OS-specific delimiter,
# starts with `/home/`, `C:\`, etc)
return _convert_matcher_v1_result_to_v2(matches, type="path")

def file_matches(self, text: str) -> List[str]:
"""Match filenames, expanding ~USER type strings.

Most of the seemingly convoluted logic in this completer is an
Expand All @@ -2044,10 +2037,11 @@ def file_matches(self, text: str) -> List[str]:
full completions, as is normally done). I don't think with the
current (as of Python 2.3) Python readline it's possible to do
better.

.. deprecated:: 8.6
You can use :meth:`file_matcher` instead.
"""
# TODO: add a heuristic for suppressing (e.g. if it has OS-specific delimiter,
# starts with `/home/`, `C:\`, etc)

text = context.token

# chars that require escaping with backslash - i.e. chars
# that readline treats incorrectly as delimiters, but we
Expand All @@ -2074,7 +2068,10 @@ def file_matches(self, text: str) -> List[str]:
if open_quotes:
lsplit = text_until_cursor.split(open_quotes)[-1]
else:
return []
return {
"completions": [],
"suppress": False,
}
except IndexError:
# tab pressed on empty line
lsplit = ""
Expand All @@ -2088,7 +2085,15 @@ def file_matches(self, text: str) -> List[str]:
text = os.path.expanduser(text)

if text == "":
return [text_prefix + protect_filename(f) for f in self.glob("*")]
return {
"completions": [
SimpleCompletion(
text=text_prefix + protect_filename(f), type="path"
)
for f in self.glob("*")
],
"suppress": False,
}

# Compute the matches from the filesystem
if sys.platform == 'win32':
Expand All @@ -2115,26 +2120,21 @@ def file_matches(self, text: str) -> List[str]:
protect_filename(f) for f in m0]

# Mark directories in input list by appending '/' to their names.
return [x+'/' if os.path.isdir(x) else x for x in matches]
return {
"completions": [
SimpleCompletion(text=x + "/" if os.path.isdir(x) else x, type="path")
for x in matches
],
"suppress": False,
}

@context_matcher()
def magic_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
"""Match magics."""
text = context.token
matches = self.magic_matches(text)
result = _convert_matcher_v1_result_to_v2(matches, type="magic")
is_magic_prefix = len(text) > 0 and text[0] == "%"
result["suppress"] = is_magic_prefix and bool(result["completions"])
return result

def magic_matches(self, text: str) -> List[str]:
"""Match magics.

.. deprecated:: 8.6
You can use :meth:`magic_matcher` instead.
"""
# Get all shell magics now rather than statically, so magics loaded at
# runtime show up too.
text = context.token
lsm = self.shell.magics_manager.lsmagic()
line_magics = lsm['line']
cell_magics = lsm['cell']
Expand Down Expand Up @@ -2167,11 +2167,18 @@ def matches(magic):
def matches(magic):
return magic.startswith(bare_text)

comp = [ pre2+m for m in cell_magics if matches(m)]
completions = [pre2 + m for m in cell_magics if matches(m)]
if not text.startswith(pre2):
comp += [ pre+m for m in line_magics if matches(m)]
completions += [pre + m for m in line_magics if matches(m)]

is_magic_prefix = len(text) > 0 and text[0] == "%"

return comp
return {
"completions": [
SimpleCompletion(text=comp, type="magic") for comp in completions
],
"suppress": is_magic_prefix and len(completions) > 0,
}

@context_matcher()
def magic_config_matcher(self, context: CompletionContext) -> SimpleMatcherResult:
Expand Down