跳转到主要内容

一个用于检查类型注解覆盖率的flake8扩展

项目描述

flake8-annotations-coverage

Build Status Maintainability Test Coverage

一个用于flake8的扩展,用于报告带有大量代码且没有类型注解的文件。

这在您向现有大型代码库添加类型注解并想知道是否有新注解模块中的代码被注解时非常有用。

每个文件的最低注解覆盖率百分比可以通过--min-coverage-percents选项进行配置,默认为75%。

如果函数至少有一个参数或返回类型的注解,则将其视为已注解。这足以让mypy将函数视为非动态类型。

安装

pip install flake8-annotations-coverage

示例

示例文件

# test.py

def annotated_function(some_arg: int):
    pass


def unannotated_function():
    pass

使用方法

$ flake8 test.py
test.py:0:1: TAE001 too few type annotations

错误代码

错误代码 描述
TAE001 文件中类型注解太少

贡献

我们非常欢迎您为我们的项目做出贡献。这很简单

  1. 创建一个关于您发现的错误或您拥有的建议的问题。等待维护者的批准。
  2. 创建一个拉取请求。确保所有检查都为绿色。
  3. 如有必要,修复审阅评论。
  4. 做得很棒。

以下是一些有用的提示

项目详情


下载文件

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

源代码分发

flake8_annotations_coverage-0.0.6.tar.gz (4.4 kB 查看哈希值)

上传时间 源代码

构建分发

flake8_annotations_coverage-0.0.6-py3-none-any.whl (5.0 kB 查看哈希值)

上传时间 Python 3