Libro de estilo

Introducción

Una guía de estilo de un lenguaje de programación es un conjunto de recomendaciones sobre la forma de dar formato a los programas. El interés de utilizar un estilo específico es facilitar la reutilización de código y la detección de errores. Existen muchos estilos de programación y no se puede decir que uno sea mejor que otro, pero sí que es conveniente adoptar algún estilo determinado y utilizarlo de forma consistente.

El estilo utilizado en estos apuntes y que se recomienda sigan los alumnos se basa en la guía de estilo oficial de Python.

Guía de estilo oficial de Python

La guía de estilo oficial de Python se encuentra en el PEP 8. Se recogen aquí algunas de las recomendaciones de esta guía:

Distribuir las ventanas en la pantalla

Normalmente, al trabajar con IDLE se suelen tener abiertas dos ventanas: la ventana de IDLE y la del programa que estés editando. Aunque es una cuestión de gustos, una forma cómoda de trabajar es tener las dos ventanas en mosaico horizontal, con IDLE en la parte izquierda y el programa que se esté editando en la parte derecha.

Para conseguir esta distribución de ventanas:

  1. Abra la ventana de IDLE y la ventana del programa. Haga clic en la ventana de IDLE para seleccionarla (y que se muestre por encima de la otra):

    Distribución de ventanas

  2. Haga clic derecho en una zona libre (sin iconos) de la barra de tareas y elija la opción Mostrar ventanas en paralelo:

    Distribución de ventanas

  3. Las ventanas se mostrarán una junta a otra, de la forma deseada:

    Distribución de ventanas

Poner nombres a las carpetas y archivos

Los programas de prueba se pueden guardar en la carpeta Mis documentos > Python > pruebas.

Los ejercicios se pueden guardar en la carpeta Mis documentos > Python > ejercicios. Se recomienda crear una subcarpeta para cada grupo de ejercicios (operaciones aritméticas, if elif else, etc.).

Se recomienda que el nombre del programa no contenga espacios sino guiones o subrayados. Por ejemplo, aritmeticas_1.py.

Comentarios en los programas

Es importante añadir comentarios a los programas para que sean más comprensibles para los humanos (el ordenador ignora completamente el contenido de los comentarios). En Python un comentario empieza por el carácter almohadilla (#) y acaba al final de la línea. No es necesario comentar todas las líneas, sino sólo aquellas que lo necesiten. Por ejemplo:

ep = 166.386 # Factor de conversión de euros a pesetas

Si se quiere comentar una línea completa, se puede hacer con el cursor situado en cualquier posición de la línea, pulsando la combinación de teclas Alt+3.

En caso de querer comentar varias líneas seguidas, se puede hacer de una sola vez seleccionando con el ratón las líneas a comentar y pulsando la combinación de teclas Alt+3. Cada vez que se pulsa Alt+3, se añaden dos almohadillas a cada línea

Si se quiere descomentar una línea completa, se puede hacer con el cursor situado en cualquier posición de la línea, pulsando la combinación de teclas Alt+4.

En caso de querer descomentar varias líneas seguidas seleccionando con el ratón las líneas a comentar y pulsando la combinación de teclas Alt+4. Cada vez que se pulsa Alt+4, se eliminan dos almohadillas de cada línea.

Cabecera de los programas

Para poder identificar qué hace cada programa, quién lo ha escrito y cuándo, se aconseja que los programas incluyan una cabecera similar a esta, hecha a base de comentarios:

# Archivo: XXXXXXX_XX.py
# Autor: XXXXX XXXXXXX (nombre y apellidos)
# Fecha: XX de XXXXXX de XXXX
# Descripción: Ejercicio XXXXXXX. Este programa bla bla bla
# Si la descripción es larga, escriba varias líneas