自动文档字符串和注释拼写检查

Question

考虑以下示例代码：

# -*- coding: utf-8 -*-
"""Test module."""


def test():
    """Tets function"""
    return 10

pylint 给它 10 of 10，flake8 没有找到任何警告：

$ pylint test.py 
...
Global evaluation
-----------------
Your code has been rated at 10.00/10
...
$ flake8 test.py
$

但是，如您所见，test 函数的文档字符串中有一个错字。而且，您的编辑器可能会自动突出显示它，例如，Pycharm 是这样做的：

感谢https://stackoverflow.com/questions/2151300/whats-the-best-way-to-spell-check-python-source-code 话题，现在我知道有一个相关的拼写检查库，叫做PyEnchant，可以用来检测拼写错误。

我的最终目标是自动检测项目中的拼写错误，并使拼写检查成为持续构建、测试和代码质量检查运行的一部分。

有没有办法通过pylint 实现这一目标？如果没有，我也很感激有关将 PyEnchant 应用于 docstrings 和 cmets 项目的任何提示（在这种情况下，可以使用 pylint 或 pyflakes 插件）。

^{如果我非常担心代码质量，请告诉我。}

Answer 1

Pylint 刚刚发布了 1.4.0，其中包括一个 spell-checker。这是最初的pull-request。

请注意，要使检查器正常工作，您需要安装 pyenchant python 模块并在系统范围内安装 enchant 库。 mac上可以通过brew安装：

$ brew install enchant

默认情况下，spelling pylint 检查器处于关闭状态。您可以在 pylint rc 配置文件或命令行中启用它：

$ cat test.py
# I am the tyop

$ pylint --disable all --enable spelling --spelling-dict en_US test.py
C:  1, 0: Wrong spelling of a word 'tyop' in a comment:
# I am the tyop
           ^^^^
Did you mean: 'typo' or 'top' or 'tip' or 'topi'? (wrong-spelling-in-comment)