sublime的Python API如何入门？ (插件开发基础)

Sublime Text插件开发核心是事件驱动+命令注册+视图交互，需继承TextCommand/WindowCommand并重写run方法，通过edit对象安全修改文本，用ViewEventListener监听事件，调试依赖status_message和控制台输出。

Sublime Text 的 Python API 是插件开发的核心，它让你能直接操作编辑器的视图、窗口、设置、命令等。入门的关键不是学完所有 API，而是先跑通一个最小插件，理解“事件驱动 + 命令注册 + 视图交互”这个主线。

从一个 .py 文件开始

Sublime 插件本质就是 Python 脚本，放在 Packages/User/ 目录下（可通过 Preferences → Browse Packages… 打开）。文件名决定命令名：比如 hello_world.py 会自动注册一个 hello_world 命令。

• 每个插件至少要继承 sublime_plugin.TextCommand（作用于当前视图）或 sublime_plugin.WindowCommand（作用于当前窗口）
• run(self, edit) 是必重写的方法，edit 对象是文本修改的唯一合法入口
• 别直接用 view.replace() 或 view.insert()，必须传入 edit

快速写个可运行的插件

在 Packages/User/hello_world.py 中写：

import sublime
import sublime_plugin

class HelloWorldCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        self.view.insert(edit, 0, "Hello from Sublime API!\n")

登录后复制

保存后，按 Ctrl+Shift+P（Win/Linux）或 Cmd+Shift+P（macOS），输入 hello world，回车即可执行——文本就插入到光标位置（第 0 行开头）。

立即学习“Python免费学习笔记（深入）”；

标签： linux python sublime git github mac macos win cos