¿Qué significa if __name__ == “__main__”: en Python?

Al revisar programas escritos en Python es bastante probable encontrarse con una línea de código cómo la siguiente: if __name__ == "__main__":. El código dentro del bloque if solamente se ejecutará cuando el archivo es llamado directamente con el intérprete de Python, no cuando es importado como un módulo. Permitiendo de este modo reutilizar el código de manera más sencilla. Así, en este bloque if, es habitual encontrar las instrucciones para inicializar un programa o ejemplos con los que probar las funciones y clases escritas.

El valor de la variable __name__

__name__ es una variable especial de Python que existe en todos los módulos e indica su nombre. Por defecto es el nombre del archivo en el que se encuentra el código, salvo el archivo que se indica al intérprete de Python cuyo nombre es __main__. Esto es algo que se puede entender bastante bien con un ejemplo. Se puede crear un archivo name_1.py en el que se escribe el siguiente código

print("El valor de __name__ en 1 es {}".format(__name__))

Ahora, si se ejecuta desde la terminal se puede ver que el valor de la variable __name__ es __main__.

% python name_1.py 
El valor de __name__ en 1 es __main__

Una vez hecho esto se puede crear un segundo archivo name_2.py como el siguiente que importe el anterior como como un módulo.

import name_1
     
print("El valor de __name__ en 2 es {}".format(__name__))

Al ejecutar este segundo archivo se puede ver que el resultado es diferente al anterior.

% python name_2.py
El valor de __name__ en 1 es name_1
El valor de __name__ en 2 es __main__

Ahora, el valor de la variable __name__ en el archivo name_1.py es name_1, mientras que en name_2.py es __main__. Lo que nos indica que el programa se ha iniciado en el segundo archivo.

Aplicaciones de if __name__ == "__main__":

Al revisar el ejemplo anterior se pueden apreciar varias cosas interesantes sobre el funcionamiento de Python. En primer lugar, el valor de la variable __name__ indica si el archivo se ha llamado directamente desde el intérprete o se ha cargado como un módulo. Por otro lado, al cargar el módulo el código dentro de este se ejecuta. Algo que se puede apreciar al ver por pantalla la línea generada por ambos archivos. Lo que es un problema al importar un archivo como módulo.

Cuando se crea un archivo Python, al que se puede llamar program_1.py, para resolver un problema se escriben varias funciones y se ejecutan dentro del mismo.

def function_1(name):
    print("Función 1 con {}".format(name))

def function_2(name):
    print("Función 2 con {}".format(name))

function_1('uno')
function_2('dos')

% python program_1.py 
Función 1 con uno
Función 2 con dos

Una vez implementado el código se puede ver que estas funciones son útiles en otra situación. En vez de copiar y pegar el código simple que sea necesario es más eficiente importar el primer archivo como un módulo. Simplificando el nuevo archivo.

import program_1

program_1.function_1("A")
program_1.function_2("B")

% python program_2.py 
Función 1 con uno
Función 2 con dos
Función 1 con A
Función 2 con B

El problema, como ya se ha visto antes, es que el código del primer archivo también se ejecuta. Algo que no es deseable cuando es un módulo. Para evitar este problema se puede usar la línea if __name__ == "__main__": y dejar dentro del bloque el caso particular. De este modo, si se modifica program_1.py como se muestra a continuación.

def function_1(name):
    print("Función 1 con {}".format(name))

def function_2(name):
    print("Función 2 con {}".format(name))

if __name__ == "__main__":
    function_1('uno')
    function_2('dos')

Ahora, al ejecutar el contenido de program_2.py se obtendrá el resultado deseado.

% python program_2.py 
Función 1 con A
Función 2 con B

Conclusiones

En esta entrada se ha visto que lo que se encuentra detrás de la línea if __name__ == "__main__":, la cual se puede ver en múltiples programas de Python. Algo que sí nos acostumbramos a incluir en nuestro código hará que este sea más fácilmente reutilizable.

Imagen de Aaron Olson en Pixabay