python / python/cpython

plistlib documentation should indicate that it base64-encodes data implicitly

Aberta
#97,541 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Leia a documentação de plistlib em https://docs.python.org/3/library/plistlib.html e a implementação referenciada em Lib/plistlib.py por volta da linha 369. Atualize a documentação para informar que Python bytes values são implicitamente codificados em base64 nos plist data, para que os usuários não precisem codificá-los previamente.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.