theupdateframework / theupdateframework/python-tuf
New API: Don't hardcode metadata files extension
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 1.7k
- Forks
- 304
- Merge medio
- 1 d 2 h
- PR fusionados (30 d)
- 17
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee tuf/api/metadata.py alrededor del uso enlazado de JSON codificado de forma fija y revisa el PR enlazado del serializador abstracto. Haz un inventario de las suposiciones sobre JSON en las clases de metadatos y la documentación; el trabajo estará terminado cuando se eliminen esas suposiciones y se admita otro tipo de archivo de metadatos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100