如何为Ruby的create_bridge方法编写正确的RBS类型签名？

问题核心 #

你的Ruby方法create_bridge要求必填关键字参数caps、url，以及可选关键字参数http_client（带默认值nil），但调用时通过**opts传递参数，导致Steep类型检查出现矛盾：

• 若签名把必填参数标为可选，Steep会警告调用时可能缺少必填项；
• 若签名把所有参数设为可选，又和Ruby方法的实际参数定义冲突。

正确的RBS基础签名 #

首先要准确反映Ruby方法的参数规则：caps和url是必填，http_client是可选。对应的RBS签名应为：

def create_bridge: (caps: untyped, url: untyped, ?http_client: untyped) -> Remote::Bridge

• 不带?的caps:和url:表示必填关键字参数；
• 带?的?http_client:表示可选关键字参数（对应Ruby里的http_client: nil）；
• 返回值替换为Remote::Bridge（而非untyped），更贴合实际逻辑。

解决调用处的类型错误 #

调用时使用**opts传递参数，Steep会质疑opts是否包含caps和url两个必填项。你需要给initialize方法的**opts定义正确的类型：
在initialize的RBS签名中，把**opts指定为包含必填键的哈希类型：

def initialize: (?bridge: untyped, ?listener: untyped, **opts: { caps: untyped, url: untyped, **untyped }) -> void

这样Steep就能确认opts里必然包含caps和url，不会再触发报错。

权宜方案（不推荐长期使用） #

如果暂时无法细化opts的类型，可以使用unchecked关键字抑制Steep的检查，明确告知它信任调用方的参数传递：

bridge ||= create_bridge(**opts) # steep: unchecked

但这只是临时绕过方案，长期来看还是推荐明确参数类型以保证类型检查的严谨性。

内容的提问来源于stack exchange，提问作者Augustin Gottlieb Pequeno