Автоматизированное и комментарии строка документации проверка орфографии

Question

Рассмотрим следующий пример кода:

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


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

pylint дает ей 10 из 10, flake8 не находит каких-либо предупреждений:

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

Но, как вы можете видеть, , есть опечатка в docstring функции test. И, ваш редактор, вероятно, выделить его автомагически, к примеру, вот как PyCharm делает это:

Благодаря https://stackoverflow.com/questions/2151300/whats-the-best-way-to-spell-check-python-source-code теме, теперь я знаю, что есть соответствующая проверка орфографии библиотека называется PyEnchant, которая может используется для обнаружения опечаток.

Моей конечной целью является автоматически определить опечатки в проекте и сделать проверку орфографии частью непрерывной сборки, проверки и проверки качества кода.

Есть ли способ достичь этого с помощью pylint? Если нет, я бы также оценил любые рекомендации по применению PyEnchant к docstrings и комментариям по проекту (в этом случае можно было бы сделать из него плагин pylint или pyflakes).

^{Пожалуйста, также сообщите мне, если я безумно обеспокоен качеством кода.}

Answer 1

Pylint только что выпустил 1.4.0, который включает в себя spell-checker. Вот начальный pull-request.

Обратите внимание, что для выполнения проверки необходимо установить модуль python pyenchant и установить библиотеку 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)