Consider the following sample code:
# -*- coding: utf-8 -*-
"""Test module."""
def test():
"""Tets function"""
return 10
pylint
gives it 10 of 10, flake8
doesn't find any warnings:
$ pylint test.py
...
Global evaluation
-----------------
Your code has been rated at 10.00/10
...
$ flake8 test.py
$
But, as you may see, there is a typo in the test
function's docstring. And, your editor would probably highlight it automagically, for example, here's how Pycharm does it:
Thanks to the https://stackoverflow.com/questions/2151300/whats-the-best-way-to-spell-check-python-source-code topic, now I know that there is a relevant spell-checking library called PyEnchant
that can be used to detect typos.
My end goal is to automatically detect typos in the project and make the spell check a part of a continuous build, test and code-quality check run.
Is there a way to achieve that with pylint
? If not, I would also appreciate any hints on applying PyEnchant
to docstrings and comments project-wise (in this case, pylint
or pyflakes
plugin could be made out of it).
Please, also, let me know if I'm getting insanely concerned about the code quality.