matplotlib / matplotlib/pytest-mpl

Perceptual Image Hash

Abierto
#146 12 comentarios 15 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Thanks and congrats on `pytest-mpl`. It's really lovely :+1:

Over on [SciTools/iris](https://github.com/SciTools/iris) we've been using a very similar framework to perform graphical testing, but rather than using RMS or SHA-256 hashes we've opted to use perceptual image hashes.

Historically, we found using RMS/SHA-256 quite fragile and too sensitive to change, and that sometimes involved quite an overhead on devs to manually understand whether graphical test failures were significant or not; typically, it really depended on the nature of the image change involved, and that generally took time and effort to figure out.

However, for the last few years now we've adopted perceptual image hashing as a more robust and stable approach to graphical image testing, and we'd love to be able to use `pytest-mpl` as a general framework (rather than reinvent the wheel) as we're keen to use perceptual image hashing elsewhere in other packages other than `iris`.

If you want to know more about perceptual image hashing:
- here's a [gist notebook](https://gist.github.com/bjlittle/6440844ea509276edf4bfbea18c8d41a) detailing outcomes from our initial investigation of perceptual image hashing as an option for `SciTools/iris`
- here's a [scientific paper](https://www.sciencedirect.com/science/article/pii/S1877050921011030) (of which there are many) performing an analysis of perceptual image hashing algorithms

In the end, we opted to leverage the https://github.com/JohannesBuchner/imagehash package, which is available on both `conda-forge` and `pypi`, to perform the actual perceptual image hashing.

At this point, I guess my question to the `pytest-mpl` core developers are:
1. Have you considered using perceptual image hashing as an approach and decided not to use it? If so, why? That would be really great to know.
2. If you're not against the concept, would you be open to us making an additive change to `pytest-mpl` where the user can choose to opt-in to an alternative hashing algorithm, that they configure, to perform their graphical testing?

I think that option [2] would be possible and a valuable feature for the `pytest-mpl` community.

However, you guys have the vision of where you want `pytest-mpl` go and the use cases that you want to address. It would be really great to know whether you're open to offering configurable hashing kernels as a feature. If you are, then we'd be more than willing to do the work and contribute to `pytest-mpl` under your guidance and advice.

Thanks :smiley:

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 revisando el comportamiento existente de pytest-mpl para la comparación de imágenes gráficas y el hashing; después, examina cómo el paquete imagehash podría admitir una alternativa opt-in. Se considerará terminado cuando se haya tomado una decisión sobre el proyecto y, si se acepta, se haya definido una funcionalidad configurable de hashing perceptual con cobertura para su comportamiento de comparación de imágenes.

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
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.