Partes de un programa Python

Un programa Python tiene un punto de entrada que habitualmente es un fichero main.py. El intérprete de python lee el código linea a linea.

El siguiente código muestra la estructura básica del fichero main.py

# 1. IMPORTACIONES
# Las importaciones deben estar al principio del archivo y seguir el orden recomendado por PEP 8.
# (1): Librerías estándar (si las hay)
# (2): Librerías de terceros (si las hay)
# (3): Librerías locales (si las hay)

import os  # Módulo para interactuar con el sistema operativo
import sys  # Módulo para interactuar con el intérprete de Python

# 2. CONSTANTES
# Las constantes se escriben en mayúsculas con palabras separadas por guiones bajos.
# Deben ser sustantivos

PI = 3.14159  # Valor de PI

# 3. VARIABLES GLOBALES
# Las variables globales se definen fuera de cualquier función.
# Deben ser sustantivos

nombre_usuario = "Ana"  # Nombre del usuario
radio_circulo = 5  # Radio del círculo para el cálculo de área

# 4. DECLARACIÓN DE FUNCIONES
# Las funciones se deben declarar a continuación.
# Siguen la convención de usar snake_case para los nombres de funciones y deben ser verbos.

def saludar(nombre):
    """Función que saluda al usuario por su nombre"""
    return f"Hola, {nombre}!"

def calcular_area_radio(radio):
    """Función para calcular el área de un círculo"""
    import math  # Importación local de math para evitar dependencias globales
    return math.pi * radio ** 2

# 5. ENTRADA PRINCIPAL DEL PROGRAMA CON `if __name__ == "__main__":`
# Asegura que el código se ejecute solo si el archivo es ejecutado directamente, no cuando se importa como módulo.

if __name__ == "__main__":
    # Código principal del programa: se ejecuta cuando el script es ejecutado directamente.

    print(saludar(nombre_usuario))  # Imprime: "Hola, Ana!"

    # Calcular y mostrar el área del círculo
    area = calcular_area_radio(radio_circulo)
    print(f"El área del círculo con radio {radio_circulo} es: {area:.2f}")

    # Mostrar valor de la constante PI
    print(f"El valor de PI es: {PI}")

Ejecución

Para ejecutar este programa, bastaría con abrir una terminal y poner el siguiente comando:

python3 main.py

Siendo python3 el intérprete que vamos a emplear y el segundo valor la ruta absoluta o relativa al script main.py. main.py podría tener cualquier nombre, pero por convenio el programa principal se llama main.

El resultado de ejecutar ese programa es el siguiente:

Hola, Ana!
El área del círculo con radio 5 es: 78.54
El valor de PI es: 3.14159