插件不生效八成卡在路径错、文件名无.py后缀、类名不合规三处:.py文件须放packages/user/或packages/插件名/下,类名必须camelcasecommand格式且继承sublime_plugin.textcommand等,命令id为类名转小写下划线。

插件文件放哪、叫什么名、类怎么写,三步定生死
插件不生效?八成卡在这三处:路径错、文件名没后缀、类名不合规。Sublime 只扫描 Packages/User/(或独立子目录)下的 .py 文件,且必须定义继承自 sublime_plugin.TextCommand 或 sublime_plugin.WindowCommand 的类。
常见错误:my_plugin.py 里只写 print("hi") —— 不会注册任何命令;HelloWorldCommand 没继承、或写成 hello_world_command(小写+下划线)—— Command Palette 里搜不到。
- 文件必须存于
Packages/User/下(推荐),或Packages/YourPluginName/ - 文件名任意,但必须以
.py结尾;类名必须是CamelCaseCommand格式,且以Command结尾,例如InsertTimestampCommand - 命令 ID 是类名转小写下划线的结果:
InsertTimestampCommand→ 命令 ID 是insert_timestamp
run(self, edit) 里怎么改文本,edit 到底能不能存、能不能延后用
edit 是 Sublime 给的“一次性编辑令牌”,只在当前 run() 执行期间有效。拿它当实例变量、传进 sublime.set_timeout 回调、或者在 run() 返回后再调用 view.insert(edit, ...),全都会触发 RuntimeError: Invalid edit object。
正确做法是:所有修改操作(insert、replace、erase)必须在同一个 edit 对象上调用,且必须在 run() 内完成。
- 想批量插入?别循环调
view.run_command('insert', ...),直接在一次run()里多次调view.insert(edit, pt, text) - 想延迟插入?不能把
edit带进回调。得先记下位置和内容,再用sublime.set_timeout(lambda: self.view.run_command('insert', {'characters': text}), 0)(前提是已注册insert命令) - 别在
__init__或on_activated里尝试用edit—— 那些地方根本没edit上下文
调试插件为什么 print 不出东西,控制台在哪、看什么
插件静默失效,不是代码错了,而是你没打开控制台看输出。Sublime 不弹窗报错,所有异常、import 失败、语法错误、print() 都只打在控制台里。
快捷键 Ctrl+`(反引号)呼出控制台,它会实时滚动显示加载日志。没反应?先确认:文件是否真在 Packages/User/ 下、是否以 .py 结尾、类是否继承正确、缩进是否全是 4 空格(混用 tab 会导致静默失败)。
- 重启 Sublime 后控制台清空,关键日志建议加前缀如
print("[myplugin] loaded") - 别用
logging,Sublime 控制台只认print -
view.run_command('insert_timestamp')在控制台手动执行,是最直接的功能验证方式 - 拼错命令名(比如
insert_datatime少个s)不会报错,只会没反应 —— 控制台也不会提示,只能靠你核对类名与命令 ID 规则
Python 版本和语法兼容性,ST3 和 ST4 能不能混用代码
Sublime Text 3 用 Python 3.3,Sublime Text 4 用 Python 3.8。两者不兼容:ST3 里写 f"hello {x}" 或 pathlib.Path 会直接报 invalid syntax;ST4 里用 yield from 没问题,但装不了 requests 这类第三方包。
你写的插件如果用户横跨两个版本,就得做语法降级或版本判断。最稳妥的做法是:默认按 ST4(Python 3.8)写,若需兼容 ST3,主动避开新语法。
- ST3 不支持:
f-string、:=海象运算符、typing.Union(需用Union字符串注解)、pathlib - ST4 支持但依然禁止:
import requests、async/await(除非用sublime.set_timeout_async包裹) - 所有插件都只能用内置模块:
sublime、sublime_plugin、os、re、datetime等
edit 生命周期没吃透,或者控制台没开就瞎猜。一个插件从保存到可用,中间只有三步:放对位置、起对类名、盯住控制台。其他都是锦上添花。











