雨 雨天小六

读懂 Codex（6.32）：Apply Patch Freeform Tool Spec 和 Lark Grammar

· 更新于 2026-08-02 · 专栏：读懂 Codex

#Codex#Agent Runtime#Tool Calling#Sandbox#软件架构

Apply Patch 使用 Freeform + Lark Grammar，让模型直接生成补丁文档；多环境时才把 environment_id 作为格式扩展加入合同。

这里先把自由文本编译成结构化操作，再讨论权限和副作用。解析成功只说明语法可解释，不代表路径已经获准，也不代表写入具备事务性。 本节只追踪“模型生成语法与本地补丁 Parser”以内的机制；相邻工具的业务行为不在这里混写。

启用条件与所有权

维度当前实现不满足时
门控存在环境且模型声明支持 Apply Patch Tool 类型不建立候选、从模型工具面移除，或转成模型可读拒绝
输入完整 Patch 自由文本在进入状态所有者前拒绝错误 Payload/参数
状态所有者ApplyPatchHandler、ApplyPatchRuntime 与目标 FileSystem不允许临时 Handler 私自复制长期状态
输出ApplyPatchToolOutput、Committed Delta 与 Turn Diff必须保持调用关联后才能进入 History

这里最容易出现的误解，是把“规格里写了什么”当作 Runtime 已经强制了什么。description、Schema 和自然语言提示只帮助模型生成更好的调用；真正的名称查找、类型校验、审批、资源约束和取消收尾仍由客户端完成。

机制调用链

构造 Freeform Spec
→ 选择是否含 environment_id
→ 发送 Lark definition
→ 接收 CustomToolCall
→ 完整 Parser 验证
Apply Patch Freeform Tool Spec 和 Lark Grammar从输入、门控、状态所有者到输出回灌的机制流程图
图 6.32-1：构造 Freeform Spec → 选择是否含 environment_id → 发送 Lark definition → 接收 CustomToolCall → 完整 Parser 验证。

图中的箭头代表控制权转移，不只是数据复制。每越过一步，下一层只接收已经满足上一层合同的数据；若该层拥有异步状态，它还必须保留原 Step、call_id 或环境身份，避免晚到结果被新一轮配置解释。

源码机制拆解

Grammar 覆盖标记行

Begin/End、Add/Delete/Update、Move、Hunk 与前缀行在生成合同中有明确产生式。

这条约束位于“选择是否含 environment_id”附近。把它前移会缺少必要状态，把它后移则可能让错误数据或副作用先穿过边界。

环境字段是动态协议

单环境无需模型选择；多环境才允许补丁文本携带目标环境。

这条约束位于“发送 Lark definition”附近。把它前移会缺少必要状态，把它后移则可能让错误数据或副作用先穿过边界。

流式预览不代替最终解析

Delta Parser 只用于 UI 预览，执行采用 Done item 的完整输入。

这条约束位于“接收 CustomToolCall”附近。把它前移会缺少必要状态，把它后移则可能让错误数据或副作用先穿过边界。

Python 风格伪代码

伪代码保留会改变结果的门控、状态读取、异步等待和协议编码；省略 Rust 所有权样板、日志字段以及与本机制无关的 Provider 适配。它不是源码翻译，也不能替代平台级安全实现。

def parse_apply_patch_freeform_spec(raw_text, context):
    # 1. 构造 Freeform Spec
    # 2. 选择是否含 environment_id
    # 3. 发送 Lark definition
    # 4. 接收 CustomToolCall
    # 5. 完整 Parser 验证
    syntax = parse_complete_document(raw_text)
    operations = resolve_operations(syntax, context.cwd)
    if not operations:
        raise ModelVisibleError("没有可执行操作")
    return ValidatedOperationSet(operations=operations, context_id=context.id)

逐行理解时要抓住三个不变量：输入先验证，状态由明确对象持有，输出用原调用身份编码。任何“先执行，之后再补关联”的简化都会在并发、取消或 Step 更新时产生悬空结果。

失败、取消与恢复

Apply Patch Freeform Tool Spec 和 Lark Grammar的失败分支、责任边界和恢复路径图
图 6.32-2：失败不会自动跨过“模型生成语法与本地补丁 Parser”这条边界；恢复动作必须由对应状态所有者完成。
故障点已发生的状态或副作用对模型/调用方的结果恢复动作
缺少 End Patch流式预览可能已有内容最终 Parser 拒绝模型重新生成完整文档
Grammar 与 Parser 宽松度不同Provider 可生成边缘文本以本地 Parser 结果为准维护双向测试
Turn 取消可能已经注册等待者、启动任务或提交部分副作用生成 Aborted/Failed 终态，不能留下无结果调用由 ApplyPatchHandler、ApplyPatchRuntime 与目标 FileSystem 注销等待者、终止资源并保持 Call/Output 配对

取消不是删除历史。模型已经发出的调用先进入转录；Runtime 必须补上可编码的终态。若副作用已经提交，Aborted 也不表示回滚。需要事务性的功能必须在自己的写入协议里实现原子提交或补偿。

设计思路与代价

当前设计保护的核心不变量是：Grammar 规定外形，Handler 仍用完整文本 Parser 验证 Begin/End 与操作内容。它让模型合同、执行状态和安全边界能够分别演进，却增加了快照、适配器和终态处理代码。更短的实现可以少一层对象，但会把“可见”“可执行”“获准”“已完成”压成同一个布尔值，无法解释延迟工具、审批拒绝、沙箱失败或晚到结果。

本节的设计动机有一部分是从类型边界和测试行为推断出来的；源码没有把所有取舍写成设计文档。可以直接证明的是字段、分支、状态所有者和失败结果，不能从这些证据外推服务端内部实现。

测试与复现实验

可验证契约复现方式预期结果
codex-rs/core/src/tools/handlers/apply_patch_tests.rs构造正常值、边界值和拒绝值结果与调用 ID/状态所有者保持一致
codex-rs/apply-patch/tests/suite/mod.rs构造正常值、边界值和拒绝值结果与调用 ID/状态所有者保持一致

本地复核应同时搜索生产符号和相邻测试，不能只跑快乐路径。推荐先对源码执行 rg -n 查找本节索引中的类型/函数，再构造一个合法调用、一个类型错误和一个取消或拒绝场景。当前环境没有 Cargo，因此本轮以锁定提交下的源码—测试静态对读、博客构建和图形渲染为验证边界，不伪报 Rust 测试执行。

Mini Codex 对照

Mini Codex 可以复刻本节的纯协议或状态机不变量，例如名称去重、调用配对、Head/Tail 缓冲与单次升级；不能用 Python 模拟结果证明 Seatbelt、seccomp、Restricted Token、远程 Exec Server 或 Provider Hosted Tool 的真实安全性质。

本节边界

本节已经证明 Grammar 规定外形，Handler 仍用完整文本 Parser 验证 Begin/End 与操作内容。它没有把相邻机制折叠进来：模型生成语法与本地补丁 Parser 之外的判断仍由其各自单元负责。

阅读导航

上一节：6.31 User Shell Command 为什么不经过模型 Tool Call · 下一节：6.33 Patch 文本的 Add、Update、Delete 与 Move 语法

评论

← 返回文章列表