openzim / openzim/python-scraperlib
Calls to third party code not respecting type hints
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 31
- Forks
- 27
- Merge medio
- 3 d 7 h
- PR fusionados (30 d)
- 2
Descripción
Following #227, scraperlib users are not allowed to send values of unexpected types to our API.
We should apply the same strict treatment to our usage of other's APIs.
beartype allows setting this in our code and raising or warning on incorrect calls. Once we fix the codebase, we would keep it and it would serve as automated test for this.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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
Comienza revisando la base de código de scraperlib en busca de llamadas a APIs de terceros y de la aplicación de las sugerencias de tipos descrita en #227. Usa beartype para identificar llamadas incorrectas; se considerará terminado cuando la base de código supere esta comprobación sin tipos de argumentos inesperados, manteniendo las comprobaciones como pruebas automatizadas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api
- Tipo de issue
- Refactorización
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100