MIT-LCP / MIT-LCP/wfdb-python

Use a single `path` argument (and deprecate `pn_dir` and `file_name`)

Abierto
#534 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Jupyter Notebook
Estrellas
853
Forks
322
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Currently the WFDB API uses 2 arguments to specify the location of files: pn_dir and file_name. This is confusing for users and confusing for developers (e.g. see: https://github.com/MIT-LCP/wfdb-python/pull/523/files).

I think the reason for having two arguments is to support auto-detection of files (e.g. get locally if local and if not get from the PhysioNet servers). This kind of behaviour doesn't seem like a good idea. If WFDB is retrieving a remote file, it should be explicit.

My preference would be to:

  • Introduce a new path argument
  • Deprecate pn_dir and file_name
  • Remove any logic that automatically retrieves files from remote servers.

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 rastreando los puntos de entrada de la API de WFDB que aceptan pn_dir y file_name; después, identifica la lógica que recupera automáticamente archivos de los servidores de PhysioNet. Define las llamadas afectadas y el comportamiento de compatibilidad antes de modificarlas. Se considera terminado cuando se admite un único argumento path, los argumentos anteriores están obsoletos y se ha eliminado la recuperación remota implícita.

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

Evaluación

Stack tecnológico
python
Área
backend-api-design
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.