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
平均合併
1 天 9 小時
30 天內合併 PR
558

描述

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 摘要。