MagicStack / MagicStack/uvloop

Qualify claim of being drop-in replacement to asyncio

Aperta
#605 0 commenti 7 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Cython
Stelle
11.9k
Fork
616
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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](https://github.com/MagicStack/uvloop/issues?q=is%3Aissue+is%3Aopen+label%3A%22missing+feature%22))

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Leggi il README del repository e la documentazione introduttiva di uvloop, quindi esamina le issue collegate relative a Windows e alle funzionalità mancanti per confermare le limitazioni. Aggiorna entrambe le affermazioni per spiegare che uvloop non è disponibile su Windows e non supporta tutte le funzionalità integrate di asyncio, incluso sendfile; il lavoro è completato quando la documentazione non sopravvaluta più la compatibilità drop-in.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
50/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.