python / python/pyperformance

Add type hints?

オープン
#282 コメント 0 件 リアクション 4 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
1k
フォーク
203
平均マージ
1時間 20分
マージ済み PR(30日)
2

説明

How would we feel about adding type hints to the pyperformance codebase?

Running a type checker on pyperformance might catch some bugs. But more importantly, in my opinion, it would make some parts of the code base a lot easier to read and reason about -- it would be self-evident what kind of object is being accepted and returned by various functions.

There are various tools that we could use to add "obvious" type hints quickly to the code base, such as autotyping and MonkeyType.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ファイルやテストは指定されていません。まず pyperformance のコードベースを確認し、出発点の候補として autotyping と MonkeyType を評価してください。型ヒントを追加する範囲と、可読性を向上させてバグを検出できる型チェックのアプローチについて合意できれば、完了となります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
tooling
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。