10 Estándar de código

La falta de establecimiento de un estándar de código hace que sea difícil dar mantenimiento, esto complica el entendimiento de un sistema para la persona que no lo programó y disminuye la calidad del mismo. La programación con diferentes estándares de codificación en un mismo equipo de desarrollo crea conflictos a la hora de subir los cambios al repositorio.

El estándar de codificación brinda calidad a nuestro código por lo cuál es importante, sea cuál sea el lenguaje de programación en el que se esté acostumbrado a programar, ya que para todos los lenguajes de programación existe un estándar de código que se puede adoptar.

Si se está desarrollando de forma colaborativa, todos los desarrolladores deben adoptar el mismo estándar de código con lo cuál, debe parecer que el mismo desarrollador codificó todo el programa. Con un estándar de código establecido se facilitará el mantenimiento del mismo, por ejemplo, añadir nuevas características, modificar las ya existentes, depurar errores, o mejorar el rendimiento.

Por citar algunos ejemplos se mencionan los siguientes:

Identación. Usa 4 espacios por cada nivel de indentación.

¿Tabuladores o espacios?. Nunca mezcles tabuladores y espacios.

Tamaño máximo de línea. Limita todas las líneas a un máximo de 79 caracteres.

No usar espacios alrededor del signo. Igual cuando se encuentre en un listado de argumentos de una función:

• Correcto: def suma(a=0, b=0):
• Incorrecto: def suma(a = 0, b = 0):

No se debe realizar comentarios obvios.

Puedes encontrar mas información sobre el estandar de código aquí

10.1 Python Enhancement Proposals (PEP8).

Está dedicada a la recopilación de los estándares seguidos por los desarrolladores de Python a la hora de escribir código para la librería estándar, éste ejecuta las reglas automáticamente y genera un resultado de las líneas que no cumplen con el estándar de codificación.

Instalación

1 `sudo pip install flake8`

Actualización

1 `pip install --upgrade`

¿Cómo se usa?

Al ejecutar los siguientes comandos se mostraran las violaciónes que estan presentes en el estandar de codigo definido por Python.

1 `flake8 Nombre del archivo.py`
2            ó
3 `pep8 nombre del archivo.py`

Donde mostrará las violaciónes al estándar de código Python de la siguiente manera:

1 `pep8 ejercicio.py`

El siguiente comando cuenta las líneas que hay con error:

1 `flake8 python_lab.py | wc -l`

Ejercicio: Aplicar flake8 ó pep8 al archivo “python_lab.py” observar cuáles errores marca y corregir segun el estandar de python.