如何禁用" TODO" pylint的警告?

时间:2015-10-15 20:30:37

标签: pylint

在python文件上运行pylint时,它默认显示有关TODO注释的警告。 E.g:

  

*************模块foo
  W:200,0:TODO(SE):解决这个问题! (FIXME)
  W:294,0:TODO(SE):积压项目(fixme)
  W:412,0:TODO(SE):删除桶? (FIXME)

虽然我觉得这种行为很有用,但我想知道一种暂时和/或永久性地打开或关闭这些特定警告的方法。

我能够生成一个pylint配置文件: pylint --generate-rcfile > ~/.pylintrc

我要注意确保在此文件中放置什么来禁用TODO评论的警告。

3 个答案:

答案 0 :(得分:23)

在生成的配置文件中,您应该看到一个部分

~/.pylintrc

简单地从"笔记中删除TODO"列表。

配置文件位于

pylint --generate-rcfile > ~/.pylintrc

如果您尚未生成配置文件,可以使用

完成
protected void Button1_Click(object sender, EventArgs e)
{
    //do mail stuff here
    HttpContext.Current.Response.Redirect(@"https://www.vine.com/test.jsp");
}

答案 1 :(得分:0)

与@sthenault发布的解决方案一起使用,您可以禁用所有警告,Pylint还允许您忽略一行(如果将来希望使用此行则很有帮助),如下所示:

A_CONSTANT = 'ugh.'  # TODO: update value  # pylint: disable=fixme

或通过说明规则ID:

A_CONSTANT = 'ugh.'  # TODO: update value  # pylint: disable=W0511

答案 2 :(得分:0)

在我们的项目中,我们有一个 pylint.cfg 文件。我们使用--rcfile pylint选项指向该文件。

在pylint.cfg中,我可以禁用检查器 W0511 ,该检查器抱怨“ TODO”和注释中的类似术语。只需将W0511添加到参数disable的逗号分隔列表中即可。

但是请记住,就像鲍勃·马丁叔叔说的那样,TODO并不是在系统中留下不良代码的借口,应该定期扫描代码以删除TODO,并且pylint和/或声纳法问题可以解决作为这样做的良好提醒和动力。