普贤教程 › 包参考

snapshot 包

快照测试（比对序列化输出与已存快照）

snapshot.px — 快照测试（比对序列化输出与已存快照）

项	值
包名	`snapshot`
版本	`0.1.0`
入口	`snapshot.px`
分类	`可观测与测试`
文件数 / 行数	`1 / 77`

安装与引入

bash

pxpkg init          # 首次
pxpkg add snapshot@0.1.0
pxpkg install

import snapshot

所属分类教程：可观测与测试

公开接口

函数	参数
`snap_new`	`name`
`snap_serialize`	`val`
`snap_has_snapshot`	`snap`
`snap_match`	`snap, actual`
`snap_diff`	`snap, actual`
`snap_update`	`snap, actual`

其余 1 个 def（内部与辅助，可直接调用但不属稳定接口）

函数	参数
`snap_set_stored`	`snap, value`

包内说明（源码头注释）

text

snapshot.px — 快照测试（比对序列化输出与已存快照）
依赖: 无

函数列表:
snap_new(name)                → dict   # 创建快照上下文
snap_match(snap, actual)      → bool   # 比对实际值与快照
snap_diff(snap, actual)       → string  # 返回差异描述
snap_update(snap, actual)     → string  # 更新快照（返回新快照值）
snap_serialize(val)           → string  # 序列化值为可比较字符串
snap_has_snapshot(snap)       → bool   # 是否有已存快照