一个用于检查类型注解覆盖率的flake8扩展
项目描述
flake8-annotations-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 | 文件中类型注解太少 |
贡献
我们非常欢迎您为我们的项目做出贡献。这很简单
- 创建一个关于您发现的错误或您拥有的建议的问题。等待维护者的批准。
- 创建一个拉取请求。确保所有检查都为绿色。
- 如有必要,修复审阅评论。
- 做得很棒。
以下是一些有用的提示
- 您可以使用
make check
运行所有检查和测试。请在 CI 执行之前这样做。 - 我们使用 BestDoctor Python 风格指南。
- 我们尊重 Django 行为准则。温柔,不胡说。
项目详情
关闭
flake8_annotations_coverage-0.0.6.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | b94d34b35e558be23991d14f685a13a4a77a46c16586f9bbff90b40c13724ce1 |
|
MD5 | 62f0bf3dbe1b43ca0950aaa0d98f5dff |
|
BLAKE2b-256 | 45c4b886d34b99909a65eb2d2be6aca8359a2826b436f4635ed58807a31f7524 |
关闭
flake8_annotations_coverage-0.0.6-py3-none-any.whl 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 9662ca85d4b40acbe683bb87fa08d9ff28e28b2aab3d2403974b09a9ee5f6a04 |
|
MD5 | 92c30e34dda6edd7ebe5186a41b77200 |
|
BLAKE2b-256 | e77fb29442bd2697219d7b31ba9bd166e6277cff046621d8ca85ade57b3d36c9 |