如何通过应用程序内的 python 控制台修改 Sublime Text 3 文档？

Question

我想对文档的文本应用一些功能。例如运行正则表达式替换，然后将结果文本转换为小写（或者一些更复杂的示例，使用提供的工具无法轻松完成）。

我知道如何使用 python 执行此操作，因此我可以从 python 解释器运行一个简单的脚本来加载、修改和保存数据。然而，这可能非常烦人，并且考虑到 sublime text 的 python API 的存在，应该有一种方法可以直接运行脚本来修改打开的文档。

我也希望避免使用宏，因为它们需要我保存一个.sublime-macro，但此类替代解决方案同样受欢迎。

我怎样才能实现这个目标？

Answer 1

在sublime控制台中， 符号view代表当前聚焦的视图（文件），window代表当前窗口。

因此，您可以使用插件 API方法sublime.View.substr()将当前选定视图的内容收集为字符串以进行进一步操作：

content = view.substr(sublime.Region(0, view.size()))

或者，如果您愿意，您可以先选择一些文本，然后获取所选内容。此示例仅抓取第一个选择的内容；如果您想一次获取多个选择的内容，请根据需要进行修改。

content = view.substr(view.sel()[0])

从这里你可以做任何你想做的事情。您的问题是完成后将内容放回缓冲区。

所有编辑操作都需要被跟踪，以便 Sublime 能够撤消更改。因此，底层 API 需要所有修改缓冲区的调用（插入、追加或替换文本等）来提供对象edit。然而，这些物体受到严格控制；只有 Sublime 可以代表您创建一个。

因此，修改缓冲区的唯一方法是实现您自己的缓冲区TextCommand，或者通过该方法利用现有命令sublime.View.run_command()。

content = view.substr(sublime.Region(0, view.size()))
content = content.replace("Hello", "Bonjour")
content = content.replace("Goodbye", "Au Revoir")
view.run_command("select_all")
view.run_command("insert", {"characters": content})

在这里，我将文本从缓冲区中取出，进行了一些替换，然后通过首先选择所有内容，然后将新内容插入回，将整个修改后的字符串放回到缓冲区中。

请注意，如果您从 a 执行此操作TextCommand，则需要self.view在任何地方使用而不仅仅是view.