Saltar al contenido

Reglas de estilo Python – PythonForBeginners.com

Como escribí en la Parte 1 de la Guía de estilo de Python, Google ha elaborado un resumen de la guía de estilo realmente agradable. Esta guía de estilo es una lista de lo que se debe y no se debe hacer para los programas de Python.

Una guía de estilo tiene que ver con la coherencia. La coherencia con esta guía de estilo es importante. La coherencia dentro de un proyecto es más importante. La coherencia dentro de un módulo o función es lo más importante.

PEP8 ha surgido como la guía de estilo que más proyectos. promueve un estilo de codificación muy legible y agradable a la vista. PEP8 ha surgido como la guía de estilo que más proyectos. promueve un estilo de codificación muy legible y agradable a la vista. Es una convención bien establecida en la comunidad de Python y, en general, deberíamos seguirlas.

La página se puede encontrar aquí: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

Cada punto de estilo tiene un resumen para el que hay información adicional.

Reglas de estilo Python

Punto y coma

No termine sus líneas con punto y coma y no use punto y coma para poner
dos comandos en la misma línea.

Longitud de la línea

La longitud máxima de la línea es de 80 caracteres.

Paréntesis

Utilice paréntesis con moderación.

Sangría

Sangra los bloques de código con 4 espacios.

Líneas en blanco

Dos líneas en blanco entre las definiciones de nivel superior, una línea en blanco entre el método
definiciones.

Espacio en blanco

Siga las reglas tipográficas estándar para el uso de espacios alrededor de la puntuación.

Línea Shebang

¡La mayoría de los archivos .py no necesitan comenzar con un #! línea.

Inicie el archivo principal de un programa con #! / Usr / bin / python.

Comentarios

Asegúrese de utilizar el estilo correcto para el módulo, la función, el método y los comentarios en línea.

Clases

Si una clase no hereda de ninguna otra clase base, hereda explícitamente del objeto.

Entrenamiento de Python recomendado

Para el entrenamiento de Python, nuestra principal recomendación es DataCamp.

Esto también se aplica a las clases anidadas.

Instrumentos de cuerda

Utilice el operador% para formatear cadenas, incluso cuando los parámetros son todos
instrumentos de cuerda.

Sin embargo, use su mejor criterio para decidir entre + y%.

Archivos y sockets

Cierre explícitamente archivos y sockets cuando termine con ellos.

TODO Comentarios

Utilice los comentarios TODO para el código que es temporal, una solución a corto plazo,
o suficientemente bueno pero no perfecto.

Formato de importaciones

Las importaciones deben estar en líneas separadas.

Declaraciones

Generalmente, solo una declaración por línea.

Control de acceso

Si una función de acceso sería trivial, debe usar variables públicas
en lugar de funciones de acceso para evitar el costo adicional de las llamadas a funciones en Python.

Cuando se agrega más funcionalidad, puede usar la propiedad para mantener la sintaxis
consistente.

Nombrar

nombre_módulo, nombre_paquete, ClassName, nombre_método, ExceptionName,
function_name, GLOBAL_CONSTANT_NAME, global_var_name,
nombre_var_instancia, nombre_parámetro_función, nombre_var_local.

Principal

Incluso un archivo destinado a ser utilizado como un script debe ser importable y una mera importación
no debería tener el efecto secundario de ejecutar la funcionalidad principal del script.

La funcionalidad principal debe estar en una función main ().

Entrenamiento de Python recomendado

Para el entrenamiento de Python, nuestra principal recomendación es DataCamp.