BUENAS PRACTICAS DE PROGRAMACIÓN EN PYTHON PRESENTADO POR : JORGE LUIS CAMARGO CABRALES 27 DE ENERO DE 2022 BARRANQUILLA INTRODUCCIÓN Teniendo en cuenta que los programas y códigos que se desarrollen no son sólo para nosotros, esto se debe tener en cuenta para que sea de fácil comprensión para las demás personas y así pueda haber una linealidad a través del tiempo procurando la mejora de este. Objetivo único: Conocer sobre las buenas prácticas a la hora de programar en Python Buenas practicas a tener en cuenta. Al momento de realizar la investigación no se encontró una unificación de criterios pero en todas las mas importantes son: Lo primero que hay que tener en cuenta es la indentación, se sugiere que se haga con cuatro espacios no con tab. Escribir el código lo mas simple posible, esto con el fin de evitar que se vuelva muy confuso de entender. Hacer comentarios sobre el programa, cual es su propósito, cómo funciona y cual es el resultado esperado Agregar un comentario de cada función utilizada Ser claro en la definición de las constantes y variables que se vayan a usar, por ejemplo, se tiene un código que calcula el área de un cuadrado A= b*a Es más fácil de entender si se coloca: Area_cuadrado= base * altura Declarar las variables en líneas separadas para que sea fácil su descripción Definir bien las funciones, módulos y clases que mejor representen las acciones que estos realizan. Definir el tamaño de las sangrías para que sean consistentes para así facilitar la lectura en cualquier editor de código. Si se tiene líneas de código muy largas, se pueden cortar con\ y seguir en la siguiente línea Separar las variables de las líneas de instrucciones por medio de una línea en blanco. Evitar mas de una instrucción por línea ya que el programador está acostumbrado a leer una instrucción por línea Las secciones que se esperan estén en el programa son: 1.Encabezado con datos del equipo, universidad o empresa donde se trabaje y breve descripción del programa (no más de 5líneas), versionado del programa. 2.Definición de librerías utilizadas 3.Declaración de constantes 4.Declaración de variables globales 5.Declaración de funciones 6.Declaración bloque de inicialización si existiera 7.Declaración de bloque principal 8.Cierre del programa al salir del bloque principal si existiera Para el proyecto “Artefacto 1” se usa la librería llamada Pycodestyle creada por Johann C. Rocholl con licencia del MIT , la cual muestra todos los errores que tiene un código en Python mostrando el error y su ubicación para que sea corregida. BIBLIOGRAFÍA: https://github.com/python/peps/blob/master/pep-0008.txt Barry's GNU Mailman style guide http://barry.warsaw.us/software/STYLEGUIDE.txt https://www.argentina.gob.ar/sites/default/files/buenas_practicas_python.pdf https://pypi.org/project/pycodestyle/ manual del usuario resumen formato de table resumen de oportunidades de mejora investigar qué significa en el versionado el1.0 1.1.1.10 etc
