Herramienta para convertir código Python para que sea compatible con PEP8

Sé que hay herramientas que validan si su código Python es compatible con PEP8, por ejemplo, hay un servicio en línea y un módulo Python .

Sin embargo, no puedo encontrar un servicio o módulo que pueda convertir mi archivo Python en un archivo Python válido PEP8 autónomo. ¿Alguien sabe si hay alguno?
Supongo que es factible ya que PEP8 tiene que ver con la apariencia del código, ¿verdad?

Desafortunadamente, "pep8 storming" (todo el proyecto) tiene varios efectos secundarios negativos:

• muchos conflictos de fusión
• romper la culpa
• dificultar la revisión del código

Como alternativa (y gracias a @yp por la idea ), escribí un pequeño paquete que autopep8s solo aquellas líneas en las que has estado trabajando desde la última confirmación / rama:

Básicamente, dejar el proyecto un poco mejor de lo que lo encontró :

pip install pep8radius

Suponga que ha terminado su trabajo mastery está listo para comprometerse:

# be somewhere in your project directory
# see the diff with pep, see the changes you've made since master
pep8radius master --diff
# make those changes
pep8radius master --diff --in-place

O para limpiar las nuevas líneas que ha comprometido desde la última confirmación:

pep8radius --diff
pep8radius --diff --in-place

# the lines which changed since a specific commit `git diff 98f51f`
pep8radius 98f51f --diff

Básicamente, pep8radiusse aplica autopep8 a las líneas en la salida de git / hg diff (de la última confirmación compartida ).

Este script actualmente funciona con git y hg, si está usando otra cosa y quiere que esto funcione, por favor publique un comentario / problema / PR .

¡Puedes usar autopep8 ! Mientras se prepara una taza de café, esta herramienta elimina felizmente todas esas molestas violaciones de PEP8 que no cambian el significado del código.

Instálelo a través de pip:

pip install autopep8

Aplicar esto a un archivo específico:

autopep8 py_file --in-place

o para su proyecto (recursivamente), la opción detallada le da algunos comentarios de cómo va :

autopep8 project_dir --recursive --in-place --pep8-passes 2000 --verbose

Nota: A veces, el valor predeterminado de 100 pasadas no es suficiente, lo configuro en 2000 ya que es razonablemente alto y capturará todos los archivos menos los más problemáticos (deja de pasar una vez que no encuentra infracciones pep8 resolubles) ...

En este punto, sugiero volver a probar y hacer un compromiso.

Si desea un cumplimiento "total" de PEP8: una táctica que he usado es ejecutar autopep8 como se indicó anteriormente, luego ejecute PEP8, que imprime las infracciones restantes (archivo, número de línea y qué):

pep8 project_dir --ignore=E501

y cámbielos manualmente individualmente (por ejemplo, E712s - comparación con booleanos).

Nota: autopep8 ofrece un --aggressiveargumento (para "arreglar" despiadadamente estas violaciones que cambian de significado), pero tenga cuidado si usa agresivo, puede que tenga que depurar ... (por ejemplo, en numpy / pandas, ¡ True == np.bool_(True)pero no True is np.bool_(True)!)

Puede comprobar cuántas infracciones de cada tipo (antes y después):

pep8 --quiet --statistics .

Nota: Considero que los E501 (línea demasiado larga) son un caso especial, ya que probablemente habrá muchos de estos en su código y, a veces, autopep8 no los corrige.

Como ejemplo, apliqué esta técnica al código base de pandas .

@Andy Hayden dio una buena descripción general de autopep8. Además de eso, hay un paquete más llamado pep8ify que también hace lo mismo.

Sin embargo, ambos paquetes solo pueden eliminar los errores de pelusa, pero no pueden formatear el código.

little = more[3:   5]

El código anterior permanece igual después de pep8ificar también. Pero el código aún no se ve bien. Puede utilizar formateadores como yapf , que formatearán el código incluso si el código es compatible con PEP8. El código anterior se formateará para

little = more[3:5]

Algunas veces esto incluso destruye su formateo manual. Por ejemplo

BAZ = {
    [1, 2, 3, 4],
    [5, 6, 7, 8],
    [9, 10, 11, 12]
}

será convertido a

BAZ = {[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]}

Pero puedes decirle que ignore algunas partes.

BAZ = {
   [1, 2, 3, 4],
   [5, 6, 7, 8],
   [9, 10, 11, 12]
}  # yapf: disable

Tomado de mi antigua publicación de blog: ¡ PEP8 automáticamente y formatee su código Python!

Si está utilizando eclipse + PyDev, simplemente puede activar autopep8 desde la configuración de PyDev: Windows -> Preferencias -> escriba 'autopep8' en el filtro de búsqueda.

Marque la casilla '¿usar autopep8.py para formatear el código?' -> Aceptar

Ahora el formato de código CTRL-SHIFT-F de eclipse debería formatear su código usando autopep8 :)

Hice una amplia investigación sobre diferentes instrumentos para Python y estilo de código. Hay dos tipos de instrumentos: linters: analizan su código y dan algunas advertencias sobre estilos de código mal usados ​​y muestran consejos sobre cómo solucionarlo, y formateadores de código: cuando guarda su archivo, vuelve a formatear su documento usando el estilo PEP.

Debido a que el reformateo debe ser más preciso (si remorgrasa algo que no quieres que se vuelva inútil) cubren menos parte de PEP, los linters muestran mucho más.

Todos ellos tienen diferentes permisos de configuración, por ejemplo, pylinter configurable en todas sus reglas (puede activar / desactivar todo tipo de advertencias), negro inconfigurable en absoluto.

Aquí hay algunos enlaces útiles y tutoriales:

Documentación:

• Convenciones de cadenas de documentos PEP-257: https://www.python.org/dev/peps/pep-0257/
• PEP-484 Tipo de sugerencia: https://www.python.org/dev/peps/pep-0484
• Guía de estilo de Chromium https://chromium.googlesource.com/chromiumos/docs/+/master/styleguide/python.md
• Estilo de código para autotest https://chromium.googlesource.com/chromiumos/third_party/autotest/+/master/docs/coding-style.md
• Guía de estilo de codificación de Khan Academy https://github.com/Khan/style-guides/blob/master/style/python.md
• La guía del autoestopista de Python https://docs.python-guide.org/
• Guía de estilo de EdX Python https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html
• Artículo de estilo de código en RealPython https://realpython.com/python-pep8/

Linters (en orden de popularidad):

• mypy https://github.com/python/mypy linter para verificaciones de tipo (PEP-484)
• pycodestyle https://github.com/PyCQA/pycodestyle - bueno usando PEP-8, muy popular. A menudo se utiliza junto con pilint y flake8 (simultáneamente)
• pylint https://github.com/PyCQA/pylint muy configurable, con soporte activo
• bandido https://github.com/PyCQA/bandit линтер по безопасности
• prospector https://github.com/PyCQA/prospector pylint + verificación de dificultad del código
• flake8 https://github.com/PyCQA/flake8 envoltorio pycodestyle con capacidad para activar complementos. Lista muy grande de diferentes complementos configurables. Aquí hay un increíble repositorio de flake8: https://github.com/DmytroLitvinov/awesome-flake8-extensions
• wemake https://github.com/wemake-services/wemake-python-styleguide - tratando de combinar muchos linters diferentes en un proyecto (en realidad es un complemento flake8 que combina estilos de varios otros linters)
• pylama https://github.com/klen/pylama tratando de combinar otros 10 linters en uno (mypy, pylint, pycodeestyle, pydocstyle и др.). Puedo ver el único problema aquí: la versión anterior (sin actualizaciones en el repositorio de github durante aproximadamente 10 meses).
• pydocstyle https://github.com/PyCQA/pydocstyle docstrings linter (PEP-257)

Formateadores de código (en orden de popularidad):

• black https://github.com/psf/black formateador más popular, utilizado en varias grandes empresas. Se creó más tarde que yapf, pero ya tiene más inicios en GitHub
• yapf https://github.com/google/yapf Formateador de código de Google
• autopep8 https://github.com/hhatto/autopep8 construir sobre el pycodestyle

Hay muchos.

Los IDE suelen tener alguna capacidad de formateo incorporada. IntelliJ Idea / PyCharm sí, lo mismo ocurre con el complemento de Python para Eclipse, y así sucesivamente.

Hay formateadores / linters que pueden apuntar a varios idiomas. https://coala.io es un buen ejemplo de eso.

Luego están las herramientas de propósito único, de las cuales muchas se mencionan en otras respuestas.

Un método específico de reformateo automático es analizar el archivo en el árbol AST (sin dejar comentarios) y luego volcarlo de nuevo al texto (lo que significa que no se conserva nada del formato original). Ejemplo de eso sería https://github.com/python/black .