python / python/cpython

plistlib documentation should indicate that it base64-encodes data implicitly

Offen
#97,541 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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)...

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Lesen Sie die plistlib-Dokumentation unter https://docs.python.org/3/library/plistlib.html und die referenzierte Implementierung in Lib/plistlib.py um Zeile 369. Aktualisieren Sie die Dokumentation dahingehend, dass Python bytes values in plist data implizit base64-encoded werden, sodass Benutzer sie nicht vorher codieren müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.