Nombre: Xavier Eduardo Navia Bravo

Carrera: Ingeniería de software

Asignatura: LABORATORIO OBJETOS Y

ABSTRACCIÓN DE DATOS

Docente: CEVALLOS VILLA GUILLERMO JOSE

Tarea: PEP8 de Python

Fecha: 11-07-2022

Periodo Académico 2022

 El documento completo se llama PEP 8. El uso del documento trata sobre
una guía de estilo que hace que el código sea más fácil de leer y coherente entre
diferentes programas de usuario. Esta guía es opcional pero muy recomendable.
Las funciones principales del PEP 8 son enseñar y guiar al usuario de Python a
escribir código para así demostrar un tipo de formato o nomenclatura única con
la intención de que el código se vea elegante y formal cuando sea leído. De
acuerdo con Guido van Rossum, el código es leído más veces que escrito, por
lo que resulta importante escribir código que no sólo funcione correctamente,
sino que además pueda ser leído con facilidad
“Una guía de estilo se trata de consistencia. La consistencia con esta guía es
importante. La consistencia dentro de un proyecto es más importante. La
consistencia dentro de un módulo o función es aún más importante” (Van
Rossum, Warsaw, & Coghlan, 2001)

Dos mismos códigos pueden realizar lo mismo funcionalmente, pero si no se

siguen unas directrices estilísticas, se puede acabar teniendo un código muy
difícil de leer. Los problemas más frecuentes suelen ser por ejemplos las líneas
son demasiado largas, nombres de variables poco explicativos, código mal
comentado y uso incorrecto de espacios y líneas en blanco.

Ahora cuando hablamos de la implementación de dicho código tenemos varios

ejemplos.

El diseño del código usa cuatro espacios por indentación. Para código realmente
antiguo que no quieras estropear, puedes continuar usando indentaciones de
ocho espacios. Las líneas de continuación deben alinearse verticalmente con el
carácter que se ha utilizado (paréntesis, llaves, corchetes) o haciendo uso de la
“hanging indent” (aplicar tabulaciones en todas las líneas con excepción de la
primera). Al utilizar este último método, no debe haber argumentos en la primera
línea, y más tabulación debe utilizarse para que la actual se entienda como una
(línea) de continuación.

Figura 1.- Ejemplo del diseño de código aplicando indentación

Es importante mencionar que nunca mezcles tabulaciones y espacios. El método
de indentación más popular en Python es con espacios. El segundo más popular
es con tabulaciones, sin mezclar unos con otros. Para nuevos proyectos, solo se
prefieren los espacios a las pestañas. La mayoría de los editores tienen
funciones que facilitan esta tarea.
Cuando hablamos de máxima longitud de las líneas esta debe ser limitada a un
máximo de 79 caracteres y para las líneas blancas se debe separar las
definiciones de las clases y funciones con dos líneas en blanco. Los métodos
dentro de clases se separan con una línea en blanco. Se recomienda utilizar
líneas en blanco para separar partes del código, por ejemplo, dentro de una
función, que realizan tareas diferenciadas.
Otros ejemplos importantes son los imports. Ellos deben tener distintos módulos
y deben estar en líneas diferentes:

Figura 2.- Ejemplo del Imports en forma escrita.

Las importaciones siempre se colocan al comienzo del archivo, simplemente

luego de cualquier comentario o documentación del módulo, y antes de globales
y constantes. Las importaciones deben estar agrupadas en el siguiente orden:
1. importaciones de la librería estándar
2. importaciones terceras relacionadas
3. importaciones locales de la aplicación / librería
“Las importaciones relativas (relative imports) para intra-paquete (intra-package)
son altamente desalentadas (poco recomendadas). Siempre usa la ruta absoluta
del paquete para todas las importaciones. Incluso ahora que el PEP 328 está
completamente implementado en Python 2.5, su estilo de importaciones relativas
explícitas es activamente desalentado; las importaciones absolutas (absolute
imports) son más portables y legibles” (Van Rossum, Warsaw, & Coghlan, 2001)
Cuando hablamos de los comentarios en código para un uso didáctico o
notificativo deben ser oraciones completas. Si un comentario es una frase u
oración, su primera palabra debe comenzar con una letra mayúscula, a menos
que sea un identificador que comience con una letra minúscula. Los comentarios
en línea deberían estar separados por al menos dos espacios de la sentencia.
Deberían empezar con un # (numeral) seguido de un espacio.
Como muchos de nosotros sabemos, a los desarrolladores de software
generalmente no les gustan las responsabilidades que se les asignan en sus
trabajos y, con el tiempo, nos dimos cuenta de que toda la comunidad usa una
guía de estilo porque, en última instancia, facilita nuestro trabajo. y aumenta
considerablemente nuestra productividad. Ahora para avanzar el tema tenemos
que ver las ventajas y desventajas del PEP8.
Ventajas:
 Es una guía extensa y llena de información
 Ayuda a programadores novatos escribir bien código
 Es una forma de escribir de forma elegante en código
 Facilita la lectura para otros programadores
 Presenta varios ejemplos de cómo realizar la escritura
Desventajas:
 Es un documento grande
 La sintaxis es mayormente única para Python, otros lenguajes de
programación pueden tener una nomenclatura distinta.

Para concluir mi opinión sobre el PEP8. Claramente es un manual para novatos

y un documento que debes leer para poder aprender a leer y escribir código de
forma más notable y limpia. Especialmente para mí que estoy aprendiendo
Python. Debe decir que el documento tiene mucho contenido que presenta varios
temas y es un ejemplar para todos los programadores que desean tener una
ética para trabajar. Francamente no es obligatorio escribir código de esta
manera, se trata sobre todo de recomendaciones. Y para saber si su estilo de
codificación está lejos de la "propuesta" o "norma" de estilo. Cada programador
tiene su propio estilo y personalidad en su código. Esto para mi trata de mostrar
que un código ordenado muestra un programador capaz para trabajar.
Referencias
Van Rossum, G., Warsaw, B., & Coghlan, N. (05 de Julio de 2001). https://peps.python.org/.
Obtenido de https://peps.python.org/pep-0008/