Automatisierte docstring und Kommentare Rechtschreibprüfung

Question

Betrachten Sie den folgenden Beispielcode:

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


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

pylint es 10 von 10 gibt, flake8 keine Warnungen nicht findet:

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

Aber, wie Sie sehen können , gibt es einen Tippfehler in der test Funktion Docstring. Und Ihr Editor wahrscheinlich markiert automagically würde zum Beispiel hier, wie PyCharm es tut:

Dank das https://stackoverflow.com/questions/2151300/whats-the-best-way-to-spell-check-python-source-code Thema, jetzt weiß ich, dass es eine entsprechende Rechtschreibprüfung ist Bibliothek PyEnchant genannt das kann verwendet werden, um Tippfehler zu erkennen.

Mein Endziel ist automatisch Tippfehler in dem Projekt zu erkennen und machen die Rechtschreibprüfung ein Teil einer kontinuierlichen Build-, Test-und Code-Qualitätsprüfung ausgeführt.

Gibt es eine Möglichkeit, das mit pylint zu erreichen? Wenn nicht, würde ich auch alle Hinweise zur Anwendung von PyEnchant auf DocStrings und Kommentare projektweise (in diesem Fall pylint oder pyflakes Plugin könnte daraus gemacht werden) zu schätzen wissen.

^{Bitte, lassen Sie mich auch wissen, wenn ich wahnsinnig besorgt über die Code-Qualität bin.}

Answer 1

Pylint gerade veröffentlicht 1.4.0, die eine spell-checker enthält. Hier ist die ursprüngliche pull-request.

Beachten Sie, dass das Prüforgan Arbeit zu machen, müssen Sie pyenchant Python-Modul installieren und haben eine enchant Bibliothek installiert systemweit. Auf dem Mac kann über brew installiert werden:

$ brew install enchant 

standardmäßig das spelling Pylint checker ausgeschaltet ist. Sie können es entweder in der Pylint rc Konfigurationsdatei oder von der Kommandozeile aktivieren:

$ 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)