¿Cuál es la funcionalidad de import argparse en Python?

Import argparse es la forma en la que importas la biblioteca argparse, perteneciente a Python. La biblioteca de argparse nos ayuda a construir interfaces de línea de comandos más flexibles y amigables. Gracias a ella podemos definir argumentos para nuestro programa y ya la biblioteca se encarga de analizarlos de forma automática desde la línea de comandos, lo que resulta en mensajes de ayuda y alerta sobre errores cuando los argumentos no cumplen con las expectativas.

¿Qué es import argparse?

El de import argparse es un módulo que está predeterminado en Python y ha sido diseñado para gestionar argumentos en programas que se ejecutan desde la línea de comandos. Tiene un objetivo principal es simplificar la creación de aplicaciones interactivas por medio del procesamiento fácil de opciones, parámetros y subcomandos que el usuario ingresa cuando ejecuta el programa. Este módulo nos proporciona un conjunto de herramientas que son altamente personalizables para manejar argumentos posicionales, opcionales y subcomandos.

¿Cómo empezar con import argparse?

Si quieres usar la funcionalidad de argparse, lo primero que necesitas es importar la biblioteca en tu programa por medio de import argparse. Acto seguido, creas un objeto ArgumentParser, que sirve como núcleo donde se van a definir y manejar los argumentos de tu aplicación. A continuación, agregas argumentos específicos usando el método add_argument. Veamos cómo hacerlo:

import argparse

# Crear el parser
parser = argparse.ArgumentParser(description="Este programa demuestra el uso de argparse")

# Agregar argumentos
parser.add_argument('nombre', help="El nombre del usuario")
parser.add_argument('--edad', type=int, help="La edad del usuario", default=18)

# Analizar los argumentos
args = parser.parse_args()

# Mostrar los resultados
print(f"Hola, {args.nombre}. Tienes {args.edad} años.")

Si ejecutas este programa desde la terminal con python programa.py Juan –edad 25, mostrará: “Hola, Juan. Tienes 25 años“.

Ejemplo: analizador de múltiples opciones

Veamos un ejemplo de import argparse en el que quieres crear un programa que acepta una lista de números y calcula su suma o promedio, dependiendo de las opciones proporcionadas:

import argparse

parser = argparse.ArgumentParser(description="Calculadora de suma o promedio")
parser.add_argument('numeros', type=float, nargs='+', help="Lista de números")
parser.add_argument('--operacion', choices=['suma', 'promedio'], default='suma', help="Operación a realizar")

args = parser.parse_args()

if args.operacion == 'suma':
    resultado = sum(args.numeros)
else:
    resultado = sum(args.numeros) / len(args.numeros)

print(f"El resultado es: {resultado}")

Ejecutando python programa.py 10 20 30 –operacion promedio, obtendrás: “El resultado es: 20.0“.

¿Cuáles son las principales funcionalidades de import argparse?

El módulo perteneciente a import argparse incluye algunas funcionalidades que lo convierten en una excelente opción para manejar argumentos. Veamos:

• Argumentos posicionales: son obligatorios y pueden identificarse por su posición dentro de la línea de comandos. En el ejemplo anterior de más arriba, nombre es un argumento posicional.
• Argumentos opcionales: pueden ser identificados por medio de un prefijo (como es – o –) y no son obligatorios. Tienes la posibilidad de establecer valores por defecto o bien tipos específicos. Por ejemplo, edad es un argumento opcional.
• Generación automática de ayuda: argparse puede generar de forma automática un mensaje de ayuda con diferentes detalles que está basado en los argumentos definidos. Si ejecutas python programa.py – h verás algo similar a esto:

usage: programa.py [-h] [--edad EDAD] nombre

Este programa demuestra el uso de argparse

positional arguments:
  nombre        El nombre del usuario

options:
  -h, --help    show this help message and exit
  --edad EDAD   La edad del usuario (default: 18)

• Validación automática: En caso de que los argumentos proporcionados no coincidan con las especificaciones, argparse muestra un error y la sintaxis esperada. Esto puede evitar problemas comunes, como tipos de datos incorrectos.
• Subcomandos: estos permiten estructurar programas complejos con múltiples funcionalidades. Por ejemplo, una aplicación puede tener comandos tales como crear o borrar, cada uno puede tener sus propios argumentos:

subparsers = parser.add_subparsers(dest="comando")

crear_parser = subparsers.add_parser("crear")
crear_parser.add_argument("archivo", help="Nombre del archivo a crear")

borrar_parser = subparsers.add_parser("borrar")
borrar_parser.add_argument("archivo", help="Nombre del archivo a borrar")

¿Te emociona la idea de dominar más recursos como este y dar un paso más hacia el camino de la programación? Entonces el Bootcamp de programación para principiantes de KeepCoding es para ti. En un tiempo récord, te abrirás paso en el sector tecnológico, reconocido por su alta demanda de profesionales, salarios excelentes y una gran seguridad laboral. Atrévete a cambiar tu vida e inscríbete hoy, esta es la oportunidad que estabas esperando.