openzim / openzim/python-scraperlib

Calls to third party code not respecting type hints

未关闭
#228 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

bug
主要语言
Python
星标
31
派生
27
平均合并
3 天 7 小时
30 天内合并 PR
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.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查 scraperlib 代码库中对第三方 API 的调用,以及 #227 中描述的类型提示强制执行。使用 beartype 识别不正确的调用;完成的标准是代码库在没有意外参数类型的情况下通过这项检查,同时保留这些检查作为自动化测试。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
api
Issue 类型
重构
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。