MagicStack / MagicStack/uvloop
Qualify claim of being drop-in replacement to asyncio
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Cython
- Estrellas
- 11.9k
- Forks
- 616
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The readme of this repo as well as the start of the uvloop documentation claims that uvloop is a "drop-in replacement of the built-in asyncio event loop". I know of at least two important caveats to this claim that I think should be mentioned somewhere in the readme/documentation:
- uvloop does not work on Windows, whereas built-in asyncio does (https://github.com/MagicStack/uvloop/issues/14, https://github.com/MagicStack/uvloop/issues/536)
- there are a couple of missing features that built-in asyncio has had for years that uvloop does not support, most notably sendfile (https://github.com/MagicStack/uvloop/issues/228, others)
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
Lee el README del repositorio y la documentación inicial de uvloop; después, revisa las issues enlazadas sobre Windows y las funciones que faltan para confirmar las salvedades. Actualiza ambas afirmaciones para explicar que uvloop no está disponible en Windows y no admite todas las funciones integradas de asyncio, incluido sendfile; la tarea estará terminada cuando la documentación ya no exagere la compatibilidad drop-in.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 50/100