MagicStack / MagicStack/uvloop
Qualify claim of being drop-in replacement to asyncio
オープン
まだ誰も着手していません。
- 主要言語
- Cython
- スター
- 11.9k
- フォーク
- 616
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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)
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リポジトリの README と uvloop の冒頭のドキュメントを読み、その後、制限事項を確認するために、リンクされている Windows および不足している機能に関する issue を確認します。uvloop は Windows では利用できず、sendfile を含む asyncio 組み込み機能のすべてをサポートしているわけではないことを説明するよう、両方の記述を更新します。完了条件は、ドキュメントが drop-in 互換性を過大に主張しなくなることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 50/100