Fix shell integration decoration bug for Windows pwsh (#22572)

Attempt to fix colorless and randomized circle decoration for Python REPL usage by Windows Powershell users. Resolves: #22546 #22535
microsoft · Nov 30, 2023 · bffc9b3 · bffc9b3
1 parent e1b54d0
commit bffc9b3
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/pythonFiles/pythonrc.py b/pythonFiles/pythonrc.py
@@ -39,14 +39,15 @@ def __str__(self):
             exit_code = 0
 
         # Guide following official VS Code doc for shell integration sequence:
-        # result = "{command_finished}{prompt_started}{prompt}{command_start}{command_executed}".format(
-        #     command_finished="\x1b]633;D;" + str(exit_code) + "0\x07",
-        #     prompt_started="\x1b]633;A\x07",
-        #     prompt=original_ps1,
-        #     command_start="\x1b]633;B\x07",
-        #     command_executed="\x1b]633;C\x07",
-        # )
-        result = f"{chr(27)}]633;D;{exit_code}{chr(7)}{chr(27)}]633;A{chr(7)}{original_ps1}{chr(27)}]633;B{chr(7)}{chr(27)}]633;C{chr(7)}"
+        result = "{command_explicit}{command_finished}{prompt_started}{prompt}{command_start}{command_executed}".format(
+            command_explicit="\x1b]633;E;\x07",
+            command_finished="\x1b]633;D;" + str(exit_code) + "\x07",
+            prompt_started="\x1b]633;A\x07",
+            prompt=original_ps1,
+            command_start="\x1b]633;B\x07",
+            command_executed="\x1b]633;C\x07",
+        )
+        # result = f"{chr(27)}]633;D;{exit_code}{chr(7)}{chr(27)}]633;A{chr(7)}{original_ps1}{chr(27)}]633;B{chr(7)}{chr(27)}]633;C{chr(7)}"
 
         return result
 

diff --git a/pythonFiles/tests/test_shell_integration.py b/pythonFiles/tests/test_shell_integration.py
@@ -10,7 +10,10 @@ def test_decoration_success():
 
     ps1.hooks.failure_flag = False
     result = str(ps1)
-    assert result == "\x1b]633;D;0\x07\x1b]633;A\x07>>> \x1b]633;B\x07\x1b]633;C\x07"
+    assert (
+        result
+        == "\x1b]633;E;\x07\x1b]633;D;0\x07\x1b]633;A\x07>>> \x1b]633;B\x07\x1b]633;C\x07"
+    )
 
 
 def test_decoration_failure():
@@ -20,7 +23,10 @@ def test_decoration_failure():
     ps1.hooks.failure_flag = True
     result = str(ps1)
 
-    assert result == "\x1b]633;D;1\x07\x1b]633;A\x07>>> \x1b]633;B\x07\x1b]633;C\x07"
+    assert (
+        result
+        == "\x1b]633;E;\x07\x1b]633;D;1\x07\x1b]633;A\x07>>> \x1b]633;B\x07\x1b]633;C\x07"
+    )
 
 
 def test_displayhook_call():