python / python/cpython

Improve wave module error messages to include the offending value

Abierto
#149,306 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

stdlib type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Summary

The wave module currently raises errors without the offending value:

wave.Error: bad # of channels
wave.Error: bad sample width
wave.Error: bad frame rate

When values come from variables, configuration, or parsed data, the
traceback shows the call site but not the actual offending value. For
Wave_read, the values are parsed from the WAV file header and never
appear in the traceback at all.

Reproduction

import wave, io
wave.open(io.BytesIO(), 'wb').setframerate(-1)
# wave.Error: bad frame rate

After this change:

wave.Error: bad frame rate: -1

I have a patch ready and will open a PR shortly.

Linked PRs
  • gh-149307

Guía de contribución

Abrir la guía de contribución

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 con las rutas de validación del módulo wave, incluido setframerate(-1), y con el análisis de la cabecera de Wave_read mencionado en el issue. Reproduce los errores actuales y, después, verifica que cada mensaje relevante incluya el valor que causó el error y que el comportamiento existente de wave se mantenga intacto.

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

Evaluación

Stack tecnológico
python
Área
audio-video-rtc
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.