Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

New API: Don't hardcode metadata files extension

Aberta
#1,333 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 10 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
api, documentation

Direção de pesquisa

Leia tuf/api/metadata.py ao redor do uso vinculado de JSON embutido no código e revise o PR vinculado do serializer abstrato. Faça um inventário das suposições sobre JSON nas classes de metadados e na documentação; o trabalho estará concluído quando essas suposições forem removidas e outro tipo de arquivo de metadados for compatível.

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

Descrição

enhancement

Description of issue or feature request:
In a review of a pr adding additional classes in the metadata API, @sechkova noticed that we have hardcoded
the usage of JSON files representing our metadata files after the implementation of abstract (de)serializer here.

For context: Teodoras comment

Current behavior:
Hardcoded *.json file names in a lot of places: https://github.com/theupdateframework/tuf/blob/52207862008cc54db8a43e1543a653be0d0333f7/tuf/api/metadata.py#L468

Expected behavior:
Don't hardcode the file names representing our metadata files with their file extensions.

TODO:

  • Remove hardcoded json strings from the code in all classes.
  • Fix our documentation to not give examples with JSON files or have a sentence like For JSON metadata files, here is how it will look like...
  • Add support for other metadata file types inside the metadata classes.
    This could be achieved with a configuration option in a Repository class or helper functions for each of the metadata classes.
Linguagem predominante
Python
Estrelas
1.7k
Forks
304
Merge médio
9h 25min
PRs com merge (30d)
14

Preparar o ambiente

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 theupdateframework/python-tuf

Todas as issues de theupdateframework/python-tuf

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.