openzim / openzim/python-scraperlib
Calls to third party code not respecting type hints
オープン
まだ誰も着手していません。
bug
- 主要言語
- Python
- スター
- 31
- フォーク
- 27
- 平均マージ
- 3日 7時間
- マージ済み PR（30日）
- 2
説明
Following #227, scraperlib users are not allowed to send values of unexpected types to our API.
We should apply the same strict treatment to our usage of other's APIs.
beartype allows setting this in our code and raising or warning on incorrect calls. Once we fix the codebase, we would keep it and it would serve as automated test for this.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず scraperlib のコードベースを確認し、サードパーティ API の呼び出しと、#227 で説明されている型ヒントの適用を調べます。beartype を使用して誤った呼び出しを特定します。コードベースが予期しない引数型なしでこのチェックに合格し、チェックを自動テストとして維持できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api
- issue の種類
- リファクタリング
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100