Python plistlib 的 UID 与普通整数有什么区别

处理 macOS 或 iOS 的二进制 plist 时，plistlib.UID 和普通整数看起来都像“一个数字”，但它们表达的不是同一件事。UID 是 plist 文件里的类型标记，普通 int 只是 Python 数值；要保留原始语义，读取后不能一律转成整数，也不能随手用 XML 格式写回。

一、先看 UID 和 int 的类型边界

官方文档把 UID 定义为对 int 的包装，主要服务于 NSKeyedArchiver 和 NSKeyedUnarchiver 编码数据。它有一个 data 属性，范围是 0 。这意味着 UID 的重点是“这个数在 plist 里的身份”，不是增加一种新的算术类型。

import plistlib

# UID 保留 plist 文件中的 UID 类型语义，普通整数只保留数值。
uid = plistlib.UID(7)
number = 7

# 需要数值计算时显式转换；直接比较对象时，类型语义不会被抹平。
print(uid.data, int(uid))
print(uid == number)       # False
print(uid == plistlib.UID(7))  # True

实践中可以把 uid.data 当作稳定、直观的取值方式，把 int(uid) 留给需要和已有数字 API 对接的场景。不要用 isinstance(uid, int) 判断 UID；它不是普通整数实例。

二、构造一个可复用的读取判断函数

如果工具要遍历未知 plist，先识别 UID，再决定是否转成业务 ID。下面的函数只处理顶层字典，足以作为导入脚本的起点；嵌套列表和字典可以按同样规则递归扩展。

import plistlib
from pathlib import Path

def inspect_plist(path: str) -> list[tuple[str, str, int | None]]:
    # 以二进制方式打开，让 plistlib 自动识别 XML 或 binary plist。
    with Path(path).open("rb") as fp:
        root = plistlib.load(fp)

    if not isinstance(root, dict):
        raise TypeError("示例工具只接受顶层字典")

    result = []
    for key, value in root.items():
        # 先判 UID，避免把 UID 误归类为普通数字。
        if isinstance(value, plistlib.UID):
            result.append((key, "UID", value.data))
        elif isinstance(value, int) and not isinstance(value, bool):
            result.append((key, "int", value))
        else:
            result.append((key, type(value).__name__, None))
    return result

这里特意把 bool 排除在整数分支之外。Python 中布尔值虽然与整数有继承关系，但在 plist 业务里通常应继续表达为布尔类型。若 UID 出现在嵌套结构中，应把“先 UID、再 bool、再 int”的顺序放进递归函数。

三、用 binary plist 保留 UID 语义

UID 是二进制 plist 支持的特殊 token。写回时要显式指定 FMT_BINARY，并在重新读取后检查类型，而不只是检查数值。

import plistlib

value = {"record_id": plistlib.UID(7), "name": "demo"}

# binary plist 才能保留 UID token；写文件时使用二进制模式。
with open("record.plist", "wb") as fp:
    plistlib.dump(value, fp, fmt=plistlib.FMT_BINARY)

# 回读后检查类型和数值，确认语义没有被降级成普通 int。
with open("record.plist", "rb") as fp:
    loaded = plistlib.load(fp)
assert isinstance(loaded["record_id"], plistlib.UID)
assert loaded["record_id"].data == 7

如果把同一个对象传给 plistlib.dumps(..., fmt=plistlib.FMT_XML)，当前 Python 会因 XML 不支持 plistlib.UID 而抛出 TypeError。这不是 UID 数值越界，而是格式能力不匹配；若业务必须输出 XML，只能先明确把 UID 降级成普通整数，并接受类型信息丢失。

四、用检查清单验收结果

完成导入脚本后，至少复查四件事：源文件是否确实是 binary plist、UID 是否只在需要的字段转换、写回后类型是否仍为 plistlib.UID、下游是否真的需要 UID 语义。如果下游只接收数字，转换应发生在边界层，而不是读取阶段一开始就全量抹平。

相关问题

UID 能直接和普通整数比较吗？

不要把它们当成等价对象比较。需要比较数值时先取 uid.data 或显式调用 int(uid)，再与整数比较。

plistlib.UID 可以写进 XML plist 吗？

不能直接写。UID 是 binary plist 的类型语义；输出 XML 前必须由业务决定是否降级为普通整数。

为什么读取后不能只保留 UID 的数字？

因为再次写回 binary plist 时，普通整数和 UID token 的含义不同。是否转换应由下游协议决定，而不是由解析器默认决定。