用途
该技能用于规范 SGLang 项目中三个核心类的 __init__ 方法编写风格,适用对象为:
Scheduler—python/sglang/srt/managers/scheduler.pyTokenizerManager—python/sglang/srt/managers/tokenizer_manager.pyModelRunner—python/sglang/srt/model_executor/model_runner.py
当你需要修改这三个类中任意一个的 __init__,或对其进行代码审查时,应遵循本规范。
背景与动机
下游分支(fork)通常会覆盖其中某一部分逻辑,例如 tokenizer、KV cache、IPC 等。如果初始化逻辑被内联写在 __init__ 中,下游就不得不复制整个 __init__,导致代码随上游演进而逐渐腐化、难以维护。将初始化拆分为 init_* 辅助方法后,下游可以精确覆盖自己需要的那一部分。参考形态为 python/sglang/srt/managers/tokenizer_manager.py 中的 TokenizerManager.__init__。
主要规则
__init__是编排者:由一系列self.init_*(...)调用加少量粘合代码组成,不内联任何非平凡的构造逻辑。- 每个可覆盖单元对应一个辅助方法:每个
init_*代表一个子类可能替换的关注点,不要混在一起。 - 命名规范:使用
init_<thing>(蛇形命名,名称体现组件)。条件构造使用maybe_init_<thing>,判断逻辑放在辅助方法内部。 - 禁止隐式状态耦合:辅助方法只读取由更早辅助方法设置的
self.*属性;调用顺序由__init__控制;共享的中间结果通过参数传递,而不是经由self.*。 - 新增逻辑即新增辅助方法:默认新增
init_<thing>,而不是再写一个内联代码块。单行赋值如self.foo = server_args.foo可以接受,但结构化逻辑不行。 - 保留覆盖点:优先对现有
init_*签名做增量修改;如有破坏性变更,需在 PR 中明确指出。
适用范围
仅适用于上述三个类,不适用于其他 manager 风格的类,也不适用于小型 dataclass 或工具类的构造函数。
限制
资料未提供该技能的具体安装命令、依赖要求、收费方式或平台支持信息,暂未提供。