python / python/cpython

plistlib documentation should indicate that it base64-encodes data implicitly

未关闭
#97,541 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
36k
PR 合并指标
PR 指标待抓取

描述

Documentation (plistlib)

The plistlib documentation (see https://docs.python.org/3/library/plistlib.html) should indicate that it implicitly base64-encodes plist "data" values (which are indicated by the values being Python bytes objects).
See code at: https://github.com/python/cpython/blob/96f8d3619d839266491b722b943de65892bb0e81/Lib/plistlib.py#L369

The plist file specifications require data values to be encoded with base64. However, I was thinking that I have to do that before using the plistlib, and was wondering what happened (since the data was encoded twice then in the resulting plist file)...

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

阅读 https://docs.python.org/3/library/plistlib.html 上的 plistlib 文档,以及 Lib/plistlib.py 中 369 行附近引用的实现。更新文档,说明 Python bytes values 会在 plist data 中隐式进行 base64-encoded,因此用户无需预先对其进行编码。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。