跳转到主要内容

将mypy集成到现有代码库中。

项目描述

mypy-baseline

一个用于轻松将mypy集成到现有Python项目的命令行工具。当您第一次运行它时,它将记住项目中所有已有的类型错误(生成“基线”)。所有后续运行将忽略这些错误,并仅报告自那时起引入的错误。

此外,该工具还将向您展示自上次基线以来取得的进展,以鼓励您的团队解决mypy错误。

example of the command output

功能

  • 经过实战检验。
  • 快速简单。
  • 纯Python。
  • 无需对mypy进行修补或使用脏魔术。该工具仅与mypy的stdout进行交互。
  • 带有颜色的友好统计数据。
  • 可以精确检测引入了哪些错误以及解决了哪些错误,即使它们位于同一文件中。
  • 基线经过精心设计,以避免合并冲突。
  • 基线易于阅读,差异信息丰富。您的PR审查者将确切了解您解决了哪些错误以及引入了哪些错误。
  • 使用基于git的历史变更记录和解决类型违规的燃尽图跟踪您取得的进展。
  • 忽略特定的错误消息(使用正则表达式)和错误类别,以便有问题的mypy插件不会用假阳性错误消息打扰您。

安装

python3 -m pip install mypy-baseline

使用方法

创建基线(默认存储在mypy-baseline.txt中)

mypy | mypy-baseline sync

之后,您可以将mypy的输出通过管道传递到mypy-baseline过滤器,它将过滤掉所有已在基线中的问题

mypy | mypy-baseline filter

如果您引入了新的错误,请解决它们。如果您解决了现有错误,请再次运行 mypy-baseline sync 重新生成基准。在这两种情况下,mypy-baseline 都会告诉您出了什么问题以及如何解决。享受旅程吧!

更多详情请参考文档: mypy-baseline.orsinium.dev

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

mypy_baseline-0.7.1.tar.gz (319.6 kB 查看哈希值)

上传时间 源代码

构建分发

mypy_baseline-0.7.1-py3-none-any.whl (17.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面