MagicStack / MagicStack/uvloop
Qualify claim of being drop-in replacement to asyncio
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 11.9k
- Forks
- 616
- PR merge metrics
- No merged PRs in 30d
Description
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)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the repository README and the opening uvloop documentation, then review the linked Windows and missing-feature issues to confirm the caveats. Update both claims to explain that uvloop is not available on Windows and does not support all built-in asyncio features, including sendfile; done means the documentation no longer overstates drop-in compatibility.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100