sublime text插件需放在packages对应目录下、文件名以.py结尾且无特殊字符,继承textcommand/windowcommand并实现run()方法,命令名为xxx_command格式,修改后须重启或手动重载插件才能生效。

Sublime Text 的插件不是靠“教”出来的,而是靠改 sublime-plugin 文件、重启、试错、再改出来的——它没有热重载,没有调试器,也没有官方文档能告诉你为什么 view.run_command() 没反应。
怎么让 Sublime 加载你的 Python 文件
Sublime 插件本质就是 Python 3.x 模块(对应 Sublime 版本的 Python 运行时),必须放在 Packages 目录下,且文件名以 .py 结尾、不含空格和特殊字符。
- Windows:
%APPDATA%\Sublime Text\Packages\MyPlugin\my_plugin.py - macOS:
~/Library/Application Support/Sublime Text/Packages/MyPlugin/my_plugin.py - Linux:
~/.config/sublime-text/Packages/MyPlugin/my_plugin.py
别放错位置——放错目录(比如丢进 Packages/User/ 但没建子文件夹)或文件名带连字符(my-plugin.py)会导致 Sublime 完全忽略它。插件启用后,可在 Preferences → Package Settings 里看到菜单项,否则就是没加载成功。
写一个能被 Command Palette 调用的命令
所有可调用功能都得继承 sublime_plugin.TextCommand 或 WindowCommand,并实现 run() 方法。名字必须是 xxx_command 形式,Sublime 才能自动转成 xxx 命令名。
import sublime
import sublime_plugin
class InsertTimestampCommand(sublime_plugin.TextCommand):
def run(self, edit):
import datetime
now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
for region in self.view.sel():
if region.empty():
self.view.insert(edit, region.a, now)
else:
self.view.replace(edit, region, now)
注意三点:
-
edit对象必须传给insert()/replace(),否则修改无效 -
self.view.sel()返回的是多个选区(多光标),要遍历处理 - 命令名是
insert_timestamp(类名去掉Command后缀,转下划线),在 Command Palette 里搜 “Insert Timestamp” 就能触发
为什么改完代码没生效?
Sublime 不会自动重载插件,改完保存后必须手动重启,或者用快捷键 Ctrl+Shift+P(Win/Linux)或 Cmd+Shift+P(macOS)调出 Command Palette,输入 Package Control: Satisfy Dependencies(其实没用),真正有效的是:View → Show Console,然后敲 sublime_plugin.reload_plugin("MyPlugin.my_plugin") —— 但前提是模块名拼写完全一致,且没语法错误。
- 语法错误会导致整个插件加载失败,Console 里会打印
ImportError或SyntaxError - 如果用了第三方库(如
requests),Sublime 默认不支持——它只有内置 stdlib,不能 pip install -
print()输出不会显示在编辑器里,只能看 Console 面板,且建议用sublime.status_message("...")给用户反馈
想加菜单或快捷键?配 JSON 就行
不需要写 Python,新建 MyPlugin/Default.sublime-commands(定义命令显示名)、MyPlugin/Main.sublime-menu(右键菜单)、MyPlugin/Default (Windows).sublime-keymap(快捷键),都是 JSON 格式。
[
{
"caption": "Insert Current Timestamp",
"command": "insert_timestamp"
}
]
关键点:
- 菜单项的
command字段必须和 Python 类里的命令名一致(小写+下划线) - 快捷键文件名必须匹配系统(
Default (Windows)/Default (OSX)/Default (Linux)),否则不生效 - 路径层级必须严格:所有配置文件都在
MyPlugin/目录下,和my_plugin.py平级
最常卡住的地方不是逻辑,是路径、命名、大小写、JSON 逗号、以及忘了重启——这些比写代码花的时间多得多。











