Python代码检查器,用于检查项目中的TODO注释的一致性和最佳实践。
项目描述
flake8-todos
用于检查项目中TODO的flake8代码检查器插件。
好的
# TODO(gram): check performance
# https://github.com/orsinium-labs/flake8-todos/issues/1337
坏的
# FIXME idk how it works lol
检查
- T001: 使用TODO代替FIXME (或BUG) 以保持一致性。
- T002: 将作者添加到TODO中 (动机)。
- T003: 在TODO中添加问题链接。
- T004: TODO中缺少冒号。
- T005: TODO中缺少文本。
- T006: 使用TODO而不是ToDo (使用大写字母)。
- T007: TODO中冒号后缺少空格。
安装
python3 -m pip install --user flake8-todos
用法
检查插件是否已添加到您的flake8中
$ python3 -m flake8 --version
3.7.7 (flake8-todos: 1.0.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux
如果您在上一个命令输出中没有看到flake8-todos
,请检查flake8
和flake8-todos
是否安装在同一解释器中。
如果一切正常,请运行flake8
python -m flake8 example.py
许可证
- 此存储库的内容包含由EclecticIQ B.V.开发的flake8-todos的公共分支。软件包的0.1.2版本根据BSD 3-Clause许可证授权。文件LICENSE包含原始许可证文件。
- 分支软件采用相同的许可协议和条件。
- 版本0.1.2、所有早期版本及相应源代码均受“2019 EclecticIQ”版权许可。
- 从0.1.4版本开始的所有后续更改和分发均受“2020 Gram gram@orsinium.dev”版权许可。
- 由于它包含了双方的更改,因此这两个版权均包含在分支软件的发布中。
创建分支是为了提供项目的源代码、分发和维护。
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
flake8_todos-0.3.1.tar.gz (7.9 kB 查看哈希值)
构建分发
flake8_todos-0.3.1-py3-none-any.whl (7.4 kB 查看哈希值)
关闭
flake8_todos-0.3.1.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 942101a08f831d7d9f7d864d86169f3bcfaf8b6d56a004c0280eb51725266b16 |
|
MD5 | a313089b1c87853fec391382260afdb4 |
|
BLAKE2b-256 | 8869e4ecde7f50c3c874046f03dc7bda67d7be8e7cc28380f3f44c07456b45ad |
关闭
flake8_todos-0.3.1-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 0b4faca80bec49be7bf8e5dd46eec12f619e09cecac8a84a87775272300222b2 |
|
MD5 | 3137b962b827ff0b5ccfe324ebef86f5 |
|
BLAKE2b-256 | ba8e805907f920d171eda033ac825d23595072a1c04dd716106c8bc8ec9eec9e |