lunes, 8 de diciembre de 2008

Los 12 Mandamientos del código Python

Para una mejor codificación les recomiendo la Guía de estilo del código Python, escrita por Guido van Rossum, creador de Python, y Barry Warsaw y Modismos y Anti-Modismos en Python, de Moshe Zadka. Pero para aquellos demasiado vagos para leerlos, también les puede ser de utilidad estos 12 mandamientos del código Python de Command Line Warriors.

Guido, que te sacó de la tierra de Visual Basic, de la casa de la servidumbre, habló así:

Los nombres de los módulos deben estar en minúsculas - hola.py
Los nombres de las clases deben usar CamelCase
Los métodos y funciones deben usar minusculas_con_guion_bajo
Los métodos privados para uso interno comienzan con _guion_bajo
Los atributos de clase con __doble_guion_bajo
Las constantes en el primer nivel del código (las que no se encuentran dentro de una función o una clase) deben usar LETRASMAYUSCULAS. Usar demasiadas constantes puede hacer que tu código sea menos reutilizable.
Si una variable en una función o método es tan temporal que no puedes darle un nombre, utiliza i para la primera, j para la segunda, y k para la tercera.
Indenta con cuatro espacios por nivel. Sin tabuladores. Si rompes este mandamiento serás lapidado en la plaza del pueblo.
Las líneas no deberían tener nunca más de 80 caracteres. Divide las líneas usando una barra invertida. No necesitas hacer esto si hay paréntesis, llaves o corchetes.
Espacio después de una coma (huevos, verdes, con, jamon)
Espacio antes y después de un operador i = i + 1
Escribe cadenas de documentación para todos los módulos, funciones, clases y métodos públicos. Python es una comunidad internacional, así que utiliza el inglés para las cadenas de documentación, los nombres de los objetos y los comentarios.

0 comentarios: