Python, guía de estilo PEP8

Cuando se escribe código, deben usarse las convenciones del lenguaje de programación que se utiliza.

Si aprende las convenciones correctas de nomenclatura y formato desde el principio, otras personas encontrarán su código más fácil de leer.

Python define sus convenciones en la guía de estilo PEP8. PEP son las siglas de Python Enhancement Proposals y es el lugar donde ocurren todas las mejoras y discusiones del lenguaje Python. Hay muchas propuestas de PEP, todas disponibles en https://www.python.org/dev/peps/.

La Guía PEP8 define el formato y algunas reglas sobre cómo escribir Python de forma “pitónica”.

Puede leer su contenido completo aquí: https://www.python.org/dev/peps/pep-0008/ pero aquí hay un resumen rápido de los puntos importantes con los que puede comenzar:

• Aplicar sangría mediante espacios, no tabulaciones
• Sangra usando 4 espacios.
• Los archivos de Python están codificados en UTF-8
• Utilice un máximo de 80 columnas para su código
• Escriba cada declaración en su propia línea
• Las funciones, los nombres de las variables y los nombres de los archivos están en minúsculas, con guiones bajos entre las palabras (snake_case)
• Los nombres de las clases están en mayúscula, las palabras separadas también se escriben con la letra mayúscula, (CamelCase)
• Los nombres de los paquetes están en minúsculas y no tienen guiones bajos entre las palabras.
• Las variables que no deben cambiar (constantes) se escriben en mayúsculas
• Los nombres de las variables deben ser significativos
• Agregue comentarios útiles, pero evite los comentarios obvios
• Agregar espacios alrededor de los operadores
• No use espacios en blanco innecesarios
• Agregar una línea en blanco antes de una función
• Agregar una línea en blanco entre los métodos de una clase
• Dentro de las funciones / métodos, las líneas en blanco se pueden usar para separar bloques de código relacionados para ayudar a la legibilidad