greatghoul
Ask and Learn

Ask and Learn

使用 python3 plistlib 修改 plist 文件时保持 key 的顺序不变

使用 python3 plistlib 修改 plist 文件时保持 key 的顺序不变

greatghoul's photo
greatghoul
·May 28, 2019·

1 min read

最近一段时间主要给公司维护一个 iOS 快捷指令(以下简称捷径)的社区,其中有个需求是给用户上传的捷径文件插入作者信息和更新步骤。

捷径的文件是一个二进制的 plist 文件,之前用了一个 nodejs 的库叫 simple-plist,不过因为 js 的局限性和这个库的 bug,导致读取捷径文件再修改保存后出现诸多问题,无奈切换到使用 python3 的标准库 plistlib 来修改捷径文件再进行转储,python2 的 plistlib 不支持读写二进制的 plist 文件,所以使用了 python3。

import plistlib

data = plistlib.load(open(filename, 'rb'))
# 一些处理 ...
plistlib.dump(data, out_file, fmt = plistlib.FMT_BINARY)

但是这样处理的捷径也存在一些问题,经过修改再保存,plist 文件部分 key value 的顺序乱套了,捷径的功能也受到了影响。

image

查阅了 plistlib 的文档后,发现解析和保存时,有两个参数,会影响 key 的顺序。

# dict_type
plistlib.load(fp, *, fmt=None, use_builtin_types=True, dict_type=dict)
# sort_keys
plistlib.dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False)

合理设置这两个参数,可以保证在读解析和保存时,保持 key 的顺序不发生改变。

import plistlib
import collections

data = plistlib.load(open(filename, 'rb'), dict_type = collections.OrderedDict)
# 一些处理 ...
plistlib.dump(data, out_file, fmt = plistlib.FMT_BINARY, sort_keys = False)

这个处理,我在 python 3.5.2 上面试验并没有成功,处理后的文件 key 依然会有错乱,但升级到 3.7.3 后就正常了,看文档 3.5.2 已经支持了这两个参数了,为什么处理不成功就不得而知了。


在下不才,也写了几个捷径,感兴趣的话,可以关注我的捷径社区主页

 
Share this