python - 使用 pyflakes/pylint 忽略 doctests/docstrings

Question

现在，如果我有这样的函数，我希望能够得到关于未定义索引的错误，同时忽略未定义 some_index 的错误。

def myfunction(ind, other):
   """
   Parameters
   ----------
   ind: Index
   other: Index or set

   Returns
   -------
   Index.

   Examples
   --------

   >>> myfunction(some_index, other)
   """
   return index + other

如果我通过 flake8 运行它，我会得到:

file.py:15:1: F821 undefined name 'other'
file.py:15:1: F821 undefined name 'some_index'
file.py:17:1: F821 undefined name 'index'

但我想看到的只是索引错误而忽略其他:

file.py:17:1: F821 undefined name 'index'

如果我在上面运行 pylint 或 pyflakes，会给出一个关于 some_index 和其他未定义的错误(这是真的，但不一定一直有用)。我如何告诉程序跳过这些错误？我正在开发一个大型图书馆，其中散布着许多示例，其中一些未定义但只是设置为如何调用它们的示例。是的，不能运行 doctests 不是很好，但就目前而言，它会给 pylint 或 pyflakes 输出增加吨噪音。 Flake8 似乎也没有提供跳过它们的选项。

我怎样才能使这项工作？有没有一种简单的方法来检测哪些东西是 Python 中的文档字符串并以这种方式过滤结果？

Answer 1

检查文档字符串是一个 regression in pyflakes ;请对该错误发表评论，以便将您的声音添加到讨论中。

您现在可以通过设置环境变量 PYFLAKES_NODOCTEST 来禁用它。