theupdateframework / theupdateframework/python-tuf
New API: Don't hardcode metadata files extension
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 304
- Merge medio
- 1g 2h
- PR unite (30g)
- 17
Descrizione
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
jsonstrings 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 aRepositoryclass or helper functions for each of the metadata classes.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Leggi tuf/api/metadata.py intorno all’uso collegato di JSON hardcoded e esamina la PR collegata sul serializer astratto. Fai un inventario delle supposizioni su JSON nelle classi dei metadati e nella documentazione; il lavoro è completato quando tali supposizioni vengono rimosse e viene supportato un altro tipo di file di metadati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- api, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100