prompt_toolkit的Completion接口text参数反斜杠转义加倍问题求解

触发反斜杠加倍的原因 #

prompt_toolkit的补全插入流程默认内置shell特殊字符转义逻辑，会自动为反斜杠、引号、空格等字符额外添加转义反斜杠，避免内容被shell错误解析。该逻辑属于输入缓冲区的内置处理逻辑，未在Completion类的公开接口文档中单独标注，因此无法通过查询Completion的参数说明找到相关信息。

解决方案 #

方案1：全局关闭转义（最适配类POSIX路径补全场景）

自定义路径补全场景不需要shell语法解析能力，直接将输入框的词法分析器替换为无转义的纯文本解析器即可，该方案兼容2.x、3.x全版本prompt-toolkit，适配全平台：

from prompt_toolkit.lexers import PlainLexer
from prompt_toolkit import PromptSession

# 初始化PromptSession时指定lexer为PlainLexer
session = PromptSession(
    lexer=PlainLexer(),
    completer=your_custom_completer, # 替换为你自己的补全器实例
    # 保留其余原有初始化参数
)

修改后Completion的text参数会原样插入到输入框，不会额外增加转义字符，display参数的原有表现不受影响。

方案2：针对指定补全关闭转义

如果部分补全场景仍需要保留shell转义能力，可以通过绑定补全选中事件手动控制插入逻辑：

from prompt_toolkit.buffer import Buffer
from prompt_toolkit import PromptSession

def handle_completion_select(buffer: Buffer):
    current_comp = buffer.complete_state.current_completion
    # 给不需要转义的补全添加自定义标记，比如display_meta设为raw
    if current_comp and current_comp.display_meta == "raw":
        # 计算需要替换的文本范围
        replace_start = buffer.cursor_position + current_comp.start_position
        buffer.delete(replace_start, buffer.cursor_position)
        # 直接插入原始文本，跳过默认转义流程
        buffer.insert_text(current_comp.text)
        return True

session = PromptSession(
    completer=your_custom_completer,
    buffer=Buffer(on_completion_selected=handle_completion_select)
)

使用时只需要给不需要转义的Completion添加display_meta="raw"参数即可：

Completion(text=n, display=n + '/', start_position=-len(name), display_meta="raw")

方案3：快速验证用临时方案

如果仅需要快速验证效果，可以在构造Completion前对text做一次反向转义：

# 仅用于临时测试，不建议生产环境使用，存在跨平台转义规则兼容风险
raw_text = n.encode('utf-8').decode('unicode_escape')
Completion(text=raw_text, display=n + '/', start_position=-len(name))

兼容说明 #

以上方案1、2均兼容Python 3.6及以上版本，覆盖prompt-toolkit 2.x、3.x全版本，Windows、Linux、macOS平台表现一致。

内容的提问来源于stack exchange，提问作者dstromberg