matplotlib / matplotlib/pytest-mpl

Generate result filenames that are easier to bulk update

Abierto
#123 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
272
Forks
53
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Currently, this plugin organizes its outputs as given in this example:

```
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/baseline.png
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/result-failed-diff.png
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/result.png
```

https://github.com/matplotlib/pytest-mpl/blob/2611bd020b523ab4fff1c9fa7db936b68dad7113/pytest_mpl/plugin.py#L425

But what `result.png` compares to is named as such:

https://github.com/astropy/astropy-data/blob/gh-pages/testing/astropy/2019-08-02T11:38:58.288466/3.1.x/test_tick_angles_non_square_axes.png

As a result, to save the new `result.png` as a new "truth," I have to manually rename the file. When I have to bulk update like 50 of these, there is a high risk of human error of renaming the wrong stuff.

Would be more dev friendly to perhaps re-organize the naming to be something like this?

```
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/baseline.png
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/result-failed-diff.png
results/astropy.visualization.wcsaxes.tests.test_images.test_tick_angles_non_square_axes/test_tick_angles_non_square_axes.png
```

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza en pytest_mpl/plugin.py, alrededor de la línea 425, donde se organizan los nombres de archivo de los resultados. Compara el nombre actual result.png con el nombre de archivo específico de la prueba solicitado y, a continuación, verifica que las salidas generadas utilicen el nombre de la prueba, de modo que las actualizaciones masivas de truth no requieran cambiar los nombres manualmente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
testing-qa
Tipo de issue
Nueva funcionalidad
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.