Add a way for mypy coverage reports to omit certain lines or functions from precision checking

未关闭
#9,106 0 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

该 issue 没有指明文件或测试。首先定位 mypy 的覆盖率精度报告和配置解析，然后跟踪如何识别被报告的使用情况。完成的标准是：用户可以为指定的函数或使用情况配置排除项，并且覆盖率报告会省略这些条目，同时不影响正常的类型检查。

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

描述

feature

When looking at a coverage report which shows the precision of the types on my code, I very frequently find that the same handful of functions are responsible for lines being marked "imprecise".

In general:

  • library or stdlib functions which really consume Any, like Logger.debug
  • library or stdlib functions which produce Any, like sqlalchemy.orm.query.Query.scalar
  • functions in my own code where the type is Any to avoid other issues (e.g. absence of unsafe unions)

I would like to be able to tell mypy to exempt certain usages from its reporting.
Several tools support this via comments (# pragma: no cover, # fmt: off, # noqa), but coverage has another interface which may be better suited to mypy: you can specify expressions which are skipped. (tool.coverage.report.exclude_lines in pyproject.toml).

Being able to stipulate something like:

mypy-coverage-precision-exclude =
    logging.Logger.debug
    logging.Logger.error
    sqlalchemy.orm.query.Query.scalar
    mymodule.myfunc

would make the coverage reporting much more useful, because it would eliminate "false negatives" on lines that really ought to have imprecise types.

主要语言
Python
星标
20.6k
派生
3.3k
平均合并
1 天 18 小时
30 天内合并 PR
54

贡献指南

打开贡献指南

从这里开始

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

python/mypy 的其他 Issue

查看 python/mypy 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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