promypy

你决定在代码源中添加类型注解。你的计划是什么？ 😅

这个包是一组小工具，可以帮助你实现梦想中的完全类型注解项目。🚀

使用 mypy，你可能会在配置文件中添加一个 files 条目，每次团队中有人想要在文件上添加类型注解时，你会在 files 列表中添加。这种方法有一些问题

1. 每个新文件都不会添加到 files 列表。
2. 如果文件被完全注解，你不会注意到，它也不会添加到 files 列表。

第 1. 点更重要，因为我们不希望我们的代码源完全注解的目标出现回退。但你也无需担心第 2. 点...

这个包的作用

• dump：生成当前未注解的文件列表。
• check：给定一组文件
  • 如果文件在列表中，并且已完全注解，它将从中删除。
  • 如果文件在列表中，但没有完全注解，它将被忽略。
  • 如果文件不在列表中，但已完全注解，它将被忽略。
  • 如果文件不在列表中，并且没有完全标注，将会引发错误。

安装

按照常规操作。

pip install promypy

用法

有两个命令可用：dump 和 check。

导出

这个命令的目的是将未完全类型标注的文件列表存储到文件中。

Usage: promypy dump [OPTIONS] FILES...

  Generate a list of files that are not fully type annotated.

Arguments:
  FILES...  [required]

Options:
  --mypy-args TEXT
  --output TEXT
  --help            Show this message and exit.

检查

Usage: promypy check [OPTIONS] FILES...

  Check the given files with mypy, applying a set of custom rules.

Arguments:
  FILES...  [required]

Options:
  -f, --ignore-file PATH  [required]
  --mypy-args TEXT
  --help                  Show this message and exit.

预提交

将以下内容添加到您的 .pre-commit-config.yaml 文件中

  - repo: https://github.com/Kludex/promypy
    rev: 0.3.0
    hooks:
      - id: promypy
        args:
        - --ignore-file=<dump_filename>

许可证

本项目遵循 MIT 许可协议。