python - missing - Docstring automatizado y corrector ortográfico de comentarios

python documentation generator

Question

Considere el siguiente código de ejemplo:

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


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

pylint le da 10 de 10, flake8 no encuentra ninguna advertencia:

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

Pero, como puede ver, hay un error tipográfico en la cadena de documentación de la función de prueba. Y, probablemente, su editor lo resalte automáticamente, por ejemplo, así es como lo hace Pycharm:

Gracias al tema https://stackoverflow.com/questions/2151300/whats-the-best-way-to-spell-check-python-source-code , ahora sé que hay una biblioteca de corrección ortográfica relevante llamada PyEnchant que se puede utilizar para detectar errores tipográficos.

Mi objetivo final es detectar automáticamente errores tipográficos en el proyecto y hacer que la revisión ortográfica forme parte de una ejecución continua de prueba, de prueba y de calidad de código.

¿Hay una manera de lograr eso con pylint ? Si no, también agradecería cualquier sugerencia sobre la aplicación de PyEnchant a las PyEnchant de documentación y los comentarios del proyecto (en este caso, el pylint o pyflakes podría estar hecho de él).

^{Por favor, también, avíseme si estoy realmente preocupado por la calidad del código.}

Answer 1

Pylint acaba de lanzar 1.4.0, que incluye un spell-checker . Aquí está la pull-request inicial.

Tenga en cuenta que, para hacer que el comprobador funcione, debe instalar el módulo PyEnchant python y tener una biblioteca PyEnchant instalada en todo el sistema. En mac, se puede instalar vía brew :

$ brew install enchant

Por defecto, el spelling ortográfico está desactivado. Puede habilitarlo ya sea en el archivo de configuración de pylint rc , o desde la línea de comandos:

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