mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 00:14:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

fix: remove custom handling of osc tokens for ptk prompt (#4629)

Browse source 
https://github.com/prompt-toolkit/python-prompt-toolkit/blob/master/examples/prompts/finalterm-shell-integration.py

fixes #374
This commit is contained in:
Noorhteen Raja NJ 2022-01-08 04:04:52 +05:30 • committed by GitHub
parent 7c4e207abd
commit 70dd8bf24b
Failed to generate hash of commit
3 changed files with 26 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
news/fix-ptk-osc-in-prompt.rst Normal file
View file

@ -0,0 +1,24 @@
**Added:**
* <news item>
**Changed:**
* <news item>
**Deprecated:**
* <news item>
**Removed:**
* <news item>
**Fixed:**
* OSC codes in ``$PROMPT`` is no longer removed when using ptk shell.
These codes need to be escaped with ``\001..\002`` instead.
**Security:**
* <news item>

29
tests/test_ptk_shell.py
View file

@ -7,7 +7,7 @@ import pyte
# verify error if ptk not installed or below min
from xonsh.ptk_shell.shell import tokenize_ansi, remove_ansi_osc
from xonsh.ptk_shell.shell import tokenize_ansi
from xonsh.shell import Shell
@ -99,33 +99,6 @@ def test_tokenize_ansi(prompt_tokens, ansi_string_parts):
assert token[1] == text
@pytest.mark.parametrize(
"raw_prompt, prompt, osc_tokens",
[
# no title
("test prompt", "test prompt", []),
# starts w/ title
("\033]0;TITLE THIS\007test prompt", "test prompt", ["\033]0;TITLE THIS\007"]),
# ends w/ title
("test prompt\033]0;TITLE THIS\007", "test prompt", ["\033]0;TITLE THIS\007"]),
# title in the middle
("test \033]0;TITLE THIS\007prompt", "test prompt", ["\033]0;TITLE THIS\007"]),
# title + iTerm2 OSC exapmle
(
"test \033]0;TITLE THIS\007prompt \033]133;A\007here",
"test prompt here",
["\033]0;TITLE THIS\007", "\033]133;A\007"],
),
],
)
def test_remove_ansi_osc(raw_prompt, prompt, osc_tokens):
checked_prompt, removed_osc = remove_ansi_osc(raw_prompt)
assert prompt == checked_prompt
assert len(removed_osc) == len(osc_tokens)
for removed, ref in zip(removed_osc, osc_tokens):
assert removed == ref
@pytest.mark.parametrize(
"line, exp",
[

27
xonsh/ptk_shell/shell.py
View file

@ -43,7 +43,6 @@ try:
except ImportError:
HAVE_SYS_CLIPBOARD = False
ANSI_OSC_PATTERN = re.compile("\x1b].*?\007")
CAPITAL_PATTERN = re.compile(r"([a-z])([A-Z])")
Token = _TokenType()
@ -84,19 +83,6 @@ def tokenize_ansi(tokens):
return ansi_tokens
def remove_ansi_osc(prompt):
"""Removes the ANSI OSC escape codes - ``prompt_toolkit`` does not support them.
Some terminal emulators - like iTerm2 - uses them for various things.
See: https://www.iterm2.com/documentation-escape-codes.html
"""
osc_tokens = ANSI_OSC_PATTERN.findall(prompt)
prompt = ANSI_OSC_PATTERN.sub("", prompt)
return prompt, osc_tokens
def _pygments_token_to_classname(token):
"""Converts pygments Tokens, token names (strings) to PTK style names."""
if token and isinstance(token, str):
@ -358,7 +344,6 @@ class PromptToolkitShell(BaseShell):
"refresh_interval": refresh_interval,
"complete_in_thread": complete_in_thread,
}
if env["ENABLE_ASYNC_PROMPT"]:
# once the prompt is done, update it in background as each future is completed
prompt_args["pre_run"] = self.prompt_formatter.start_update
@ -427,16 +412,6 @@ class PromptToolkitShell(BaseShell):
except Exception: # pylint: disable=broad-except
print_exception()
p, osc_tokens = remove_ansi_osc(p)
if kwargs.get("handle_osc_tokens"):
# handle OSC tokens
for osc in osc_tokens:
if osc[2:4] == "0;":
env["TITLE"] = osc[4:-1]
else:
print(osc, file=sys.__stdout__, flush=True)
toks = partial_color_tokenize(p)
return tokenize_ansi(PygmentsTokens(toks))
@ -447,7 +422,7 @@ class PromptToolkitShell(BaseShell):
carriage_return()
self._first_prompt = False
tokens = self._get_prompt_tokens("PROMPT", "message", handle_osc_tokens=True)
tokens = self._get_prompt_tokens("PROMPT", "message")
self.settitle()
return tokens