TypeError too vague when a key is missing its value in language file

Aberta Para iniciantes
#108 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
88/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
backend

Direção de pesquisa

Comece pelas linhas referenciadas em src/hexdoc/utils/deserialize/yml.py e src/hexdoc/utils/deserialize/json.py, onde a issue identifica os erros que devem ser melhorados. Verifique como cada desserializador lida com um valor ausente e inclua a chave na mensagem TypeError resultante. O trabalho estará concluído quando ambos os erros identificarem a chave e o valor, como no exemplo; a issue não indica um teste a ser executado.

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

Descrição

good first issue for humans

When erroring, it will spit out a not very helpful error:

TypeError: None

This can be fixed by including the key in the error:

raise TypeError(f"key: '{key}' had type error for value: {value}")

Which might produce something like this instead:

TypeError: key: 'hexcasting.mishap.bad_item.fishcasting.fishing_hook' had type error for value: None

These are the files with the lines which might be changed to make it easier to debug.
https://github.com/hexdoc-dev/hexdoc/blob/83a0add52ef796b5e341ef9c34fb0bf12a7b1603/src/hexdoc/utils/deserialize/yml.py#L43
https://github.com/hexdoc-dev/hexdoc/blob/83a0add52ef796b5e341ef9c34fb0bf12a7b1603/src/hexdoc/utils/deserialize/json.py#L54

Example run showing the TypeError: None message:
https://github.com/hauveli/fishcasting/actions/runs/38193644736/job/114631513504

Linguagem predominante
Python
Estrelas
7
Forks
10
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

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.

Mais de hexdoc-dev/hexdoc

Todas as issues de hexdoc-dev/hexdoc

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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