Aprende a organizar las librerías de un programa de código

Estamos seguros de que en algún momento, durante tu trayectoria por la programación, te has encontrado con un caos de librerías que no has sabido manejar. Organizar las librerías de un programa de código no es para nada una tarea secundaria, por el contrario, es sumamente importante para mantener tu proyecto limpio, eficiente y, sobre todo, para que funcione como debe funcionar. Es por esto que aquí te daremos algunos consejos y tips prácticos que te ayudarán a organizar código, haciéndolo más legible y mucho más fácil de manejar. De modo que, si estás listo para que tu entorno de programación sea tan organizado como tu playlist favorito, quédate y sigue leyendo.

Tips previos para organizar un programa de código

Antes de explicarte cómo organizar las librerías de un programa de código, te daremos una serie de tips previos que te serán de gran ayuda en este proceso:

• En primer lugar, debes saber cómo organizar las librerías que vas a importar a tu script principal.
• Te recomendamos comentar los códigos de una manera clara tanto para ti como para el posible colaborador de tu script. Esto nos lleva a que te hagas a la idea de que, en algún momento, este código será compartido, por lo que debe ser comprendido objetivamente.
• Debes controlar los espacios entre clases, métodos o funciones, es decir, si es necesario poner un espacio entre dos funciones diferentes para que se entiendan, deberías dejarlo.
• Te aconsejamos organizar los assets o recursos de tus programas con etiquetas o nombres claros y cortos. Por ejemplo, si tenemos una carpeta de recursos donde se guarden imágenes que se van a importar en el programa de código, recomendamos que tenga un nombre corto, pero claro y que, por otro lado, no sea similar a otro nombre o etiqueta.

Ya que tienes algunos tips para implementar en tu proceso de organizar código, estás listo para entender cómo organizar las librerías de un programa de código.

Cómo organizar las librerías de un programa de código

Para organizar las librerías de un programa de código es necesario tener en cuenta que estos son los elementos que se importan en un script específico, de otras instancias o ficheros de un programa o, por el contrario, de un lenguaje de programación. Usualmente vienen con la función import [nombre del fichero o la librería] u otras formas o funciones para hacerlo.

Ahora, en muchas ocasiones hay gran variedad de librerías que se importan en un solo programa de código, por tanto, tendrás que organizarlo de una manera específica. Así pues, te recomendamos seguir un orden alfabético y, a su vez, dividirlo por bloques de sentido.

Es muy importante que conozcas los tres bloques de organización para las librerías importadas en tu fichero o módulo principal:

• El primer bloque de organización para las librerías corresponden a las librerías estándar del lenguaje de programación.
• En el segundo bloque se proponen las librerías que no son tuyas, es decir, las dependencias que has instalado para el desarrollo de tu programa de código, tal como Pygame. Estas son las librerías externas.
• El tercer bloque de organización corresponde a las librerías propias. Es decir, los ficheros que tú has integrado o realizado. Este bloque se divide en dos puntos. El primero corresponde a otros módulos, y el segundo, al módulo actual.

A continuación, te mostramos el paso a paso de este proceso para organizar las librerías de un programa de código:

Debes recordar que siempre se deben organizar las librerías de un programa de código a partir de los tres bloques que te mencionamos y, además, responder a un orden alfabético. Ahora, si quieres aprender cómo importar librerías y ficheros con la función import en tus programas de código, te recomendamos visitar nuestro artículo sobre la importación de ficheros en Python.

Ejemplo práctico para organizar las librerías de un programa

Un ejemplo práctico de cómo organizar las librerías de un programa de código podría ser el manejo de dependencias en un proyecto de Python utilizando virtualenv y requirements.txt. Aquí te dejamos una guía paso a paso:

• Crear un entorno virtual:

Primero, instala virtualenv si aún no lo tienes. En tu terminal, ejecuta:

pip install virtualenv

Crea un entorno virtual en la carpeta de tu proyecto para aislar las dependencias:

virtualenv mi_entorno

Activa el entorno virtual:

• En Windows: .\mi_entorno\Scripts\activate
• En macOS y Linux: source mi_entorno/bin/activate

• Instalar librerías:

Con el entorno virtual activado, instala las librerías que tu proyecto necesita. Por ejemplo:

pip install flask 
pip install requests

Es crucial instalar solo las librerías que vas a utilizar para mantener el proyecto limpio y optimizado.

• Congelar las dependencias:

Guarda una lista de todas las librerías instaladas y sus versiones en un archivo requirements.txt. Esto asegura que cualquier persona (o tú en el futuro) pueda instalar exactamente las mismas versiones de las librerías fácilmente:

pip freeze > requirements.txt

• Organizar las importaciones en tu código:

En tus archivos de Python, agrupa las importaciones de librerías al principio del archivo. Primero, coloca las librerías estándar, luego las de terceros y finalmente las importaciones locales. Por ejemplo:

import os 
import sys 

from flask import Flask 
import requests 

import mymodule

• Mantenimiento:

Regularmente revisa las librerías para actualizarlas o eliminar las que ya no uses. Esto se puede hacer revisando el requirements.txt y ejecutando comandos de actualización:

pip install -r requirements.txt --upgrade

Cuantos más tips y recomendaciones sigas, más cerca estás de recorrer tu camino en la programación. Saber cómo organizar las librerías de un programa de código, te permite interactuar libremente con el script. Ahora, si quieres seguir aprendiendo aspectos más funcionales y prácticos de la programación con Python, te recomendamos echarle un vistazo al temario del Aprende a Programar desde Cero Full Stack Jr. Bootcamp. De esta manera, podrás seguir aprendiendo y, en pocos meses, convertirte en un programador experto.