检查项目中的待办事项

flake8-todos的Python项目详细描述


用于flake8linter检查python源代码中todo注释的插件。

好:

# TODO(jamie): check performance# https://github.com/eclecticiq/flake8-todos/issues/1337

错误:

# FIXME idk how it works lol

为什么?

检查

  • t001:使用todo而不是fixme(或bug)来保持一致性。
  • t002:将author添加到todo(read about motivation here)中。
  • t003:将有问题的链接添加到todo中。
  • t004:TOdo中缺少冒号。
  • t005:TOdo中缺少文本。
  • t006:写入todo而不是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,请检查flake8flake8-todos是否使用同一个解释器安装。实际上,这意味着两者都需要安装到同一个虚拟环境中。

如果一切正常,运行flake8

python -m flake8 example.py

配置

flake8docs解释了how to configure flake8flake8-todos插件使用以字母T开头的代码。请参阅上面的检查以获取完整列表。

许可证

此存储库的内容在3-clause BSD license下发布。 有关详细信息,请参见LICENSE文件。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
不同窗口中的java视图   java创建SQL插入语句到CSV文件   java效率检查:Opengl动画代码   在clojure中处理Java可选<T>   java理解camel中的输入/输出交换模式行为   对于使用jpackage构建的应用程序,java LSOpenURLsWithRole()失败,错误为10810   多线程Java同步:多重倒计时闩锁   java哪个类应该做这项工作?   java在运行时出现问题。getRuntime()。执行官   java我们不能在GAE中使用集合或集合作为返回类型吗?   amazon web服务返回类型与RequestHandler<Object,String>不兼容。JAVA中的HandlerRequest(对象、上下文)   如何在Java中使用ExecutorService设置任务的超时时间