Importaciones relativas vs absolutas en Python

Si bien puede poner proyectos simples en un solo archivo, la mayoría de los proyectos de desarrollo de Python requerirán varios archivos para mantenerlos manejables. Eso significa que necesitas un...

Si bien puede poner proyectos simples en un solo archivo, la mayoría de los proyectos de desarrollo de Python requerirán varios archivos para mantenerlos manejables. Eso significa que necesita una forma de importar un archivo a otro. Sin embargo, muchos pitonistas encuentran que la importación de archivos es confusa. Afortunadamente, es fácil si conoce la diferencia entre las diversas declaraciones de importación de Python.

¿Qué es Importar?

La importación se refiere a permitir que un archivo de Python o un módulo de Python acceda al script desde otro archivo o módulo de Python. Solo puede usar funciones y propiedades a las que puede acceder su programa. Por ejemplo, si desea utilizar funcionalidades matemáticas, primero debe importar el paquete matemático. Esto se debe a que debe definir todo lo que desea usar en Python antes de usarlo.

Por ejemplo, Python daría un NameError para el siguiente código:

1
myPi = math.pi

Esto se debe a que ni el objeto matemático ni sus propiedades y métodos están disponibles de forma nativa para el propio lenguaje. Para usar el objeto math, primero debe importarlo.

1
2
3
4
import math

myPi = math.pi
print myPi

La instrucción importar agrega el objeto al alcance actual de su programa.

Cómo funcionan las importaciones

Las declaraciones de importación hacen mucho para importar archivos o módulos. Primero, buscan su módulo o paquete en sys.modules, donde Python almacena su código previamente importado. Si Python no puede encontrar el módulo allí, lo buscará en la Biblioteca estándar de Python. Si Python aún no puede encontrar el módulo, revisará todo su espacio de almacenamiento, comenzando con el directorio actual y los que figuran en su system.path. Si el módulo se encuentra en estos lugares, lo agregará a su programa; de lo contrario, generará un ModuleNotFoundError.

Sintaxis de instrucciones de importación

Para importar un módulo directamente, simplemente coloque el nombre del módulo o paquete después de la palabra clave import. Tenga en cuenta que esta declaración distingue entre mayúsculas y minúsculas.

1
import mymodule

Sin embargo, Python ofrece una sintaxis más sofisticada para importar código. Este segundo formato también incluye la palabra clave from.

1
from mypackage import mymodule

En este formato, especifica tanto el módulo o código que desea como dónde está. Pones el nombre de tu código, módulo o subpaquete para mymodule, y su ubicación para mypackage. Tal declaración de importación es excelente si solo desea importar parte del código del paquete mencionado, y no el paquete en sí.

Incluso puede cambiar el nombre del módulo incluyendo la palabra clave as.

1
import mymodule as oMyFunction

También puede utilizar el asterisco (*) como comodín. La siguiente declaración importará todas las funciones y propiedades contenidas en el paquete math.

1
from math import *

Independientemente de la sintaxis, siempre debe seguir la [importación de mejores prácticas] recomendada (https://pep8.org/#imports).

Importaciones absolutas

Las importaciones absolutas incluyen la ruta completa a su secuencia de comandos, comenzando con la carpeta raíz del programa. Si bien debe separar cada carpeta por un punto, puede tenerlo todo el tiempo que lo necesite.

Los siguientes son ejemplos de importaciones absolutas:

1
2
from package1.firstmodule import firstmodule
import package1.secondmodule.myfunction
Ventajas y desventajas de la importación absoluta {#ventajas y desventajas de la importación absoluta}

A diferencia de otros lenguajes, la mayoría de los desarrolladores de Python prefieren usar importaciones absolutas sobre sus primos relativos. Esto se debe a que las importaciones absolutas dejan muy claro lo que está tratando de hacer. La ubicación real de sus archivos está justo ahí en su código. De hecho, puede usarlos en cualquier parte de su código. Simplemente funcionarán.

Sin embargo, las importaciones absolutas pueden ser bastante largas. Si su proyecto tiene subpaquetes en subpaquetes en subpaquetes, sus declaraciones de importación pueden expandirse más allá de una sola línea de código. Cuando eso sucede, es mucho mejor usar importaciones relativas en su lugar.

También puede descubrir un problema cuando inicia su programa usando diferentes archivos de inicio. El intérprete de Python solo declara la carpeta actual del archivo inicial como la raíz del paquete sys.path. Esto está bien si solo carga su programa usando archivos de la carpeta raíz. Esto se debe a que sys.path permanecerá estático a lo largo de su secuencia de comandos.

Sin embargo, la situación cambia cuando inicia su programa desde una subcarpeta, o en cualquier otra situación en la que su sys.path pueda cambiar. Entonces, su "carpeta raíz" es la subcarpeta. Debido a que no puede usar importaciones implícitas (como veremos a continuación), cualquier archivo fuera de la subcarpeta se vuelve inaccesible para su programa.

Tienes dos soluciones para esto. Puede iniciar su script de subcarpeta como un módulo importado o puede agregar sys.path directamente en su código.

Por ejemplo:

  • Importación de módulos como tiempo de ejecución: python -m packA.a2
  • Agregue sys.path antes de importar sus archivos:
1
2
3
import os, sys
sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
from packA.subA import sa2

Importaciones relativas {#importaciones relativas}

Con las importaciones relativas, solo especifica dónde están sus recursos en relación con el archivo de código actual. Puede hacer esto de forma implícita o explícita, aunque las importaciones relativas implícitas se eliminaron en Python 3.

En cuanto a la sintaxis, las importaciones relativas hacen uso de la notación de puntos. Los puntos individuales representan el directorio del script actual. Dos puntos representan la carpeta principal. Thress puntos significa el abuelo, y así sucesivamente. Es posible que esté familiarizado con este sistema si utiliza un sistema operativo similar a UNIX o la consola de Windows.

Los siguientes son ejemplos de importaciones relativas:

  • Importaciones explícitas
1
2
3
import other
from . import some_class
from .subA import sa1
  • Importaciones implícitas
1
2
3
from .some_module import some_class
import some_function
import subA.sa1
Importaciones relativas y sus ventajas y desventajas {#importaciones relativas y sus ventajas y desventajas}

Las importaciones relativas rara vez crecen tanto como las importaciones absolutas. Incluso pueden convertir una declaración absoluta ridículamente larga en algo tan simple como:

1
from ..my_sub_package.my_module import my_function

Sin embargo, también ocultan las rutas a sus módulos. Esto podría estar bien si usted es el único desarrollador, pero se complica si es parte de un equipo de desarrollo donde la estructura real del directorio puede cambiar.

¿Qué importación usar?

A menos que esté trabajando en un proyecto grande con varias capas de subpaquetes, siempre debe usar importaciones absolutas. De esa manera, cualquier persona que lo mire entenderá fácilmente su código, incluido usted mismo si volvió a consultarlo para actualizarlo más tarde. Incluso si tiene rutas largas, aún debe intentar escribir su programa para usar solo declaraciones absolutas para simplificar su código y su vida.

Conclusión

Como cualquier otro lenguaje de programación moderno, Python le permite importar código de otros archivos o módulos. Sin embargo, esto puede convertirse en un proceso confuso y propenso a errores, a menos que comprenda los conceptos detrás del sistema de importación.

En este artículo, analizamos las diversas formas de importar código a nuestros programas de Python, incluidas las importaciones absolutas y relativas. También comparamos los pros y los contras de cada uno, que tienen sus ventajas en diferentes casos de uso.

Licensed under CC BY-NC-SA 4.0