Creación de programas de Python para la línea de comandos

Introducción

La interfaz de línea de comandos de Python, también conocida como línea de comandos o interfaz de línea de comandos (CLI), es una forma de interactuar con un programa informático escribiendo comandos en una terminal o símbolo del sistema. Permite a los usuarios ejecutar un programa y pasarle argumentos, así como recibir la salida del programa en forma de texto. La interfaz de línea de comandos es particularmente útil para automatizar tareas, ejecutar scripts y realizar operaciones avanzadas o complejas que serían difíciles o imposibles de hacer a través de una interfaz gráfica de usuario (GUI).

En este laboratorio, aprenderemos a utilizar el módulo argparse para crear interfaces de línea de comandos para nuestros programas de Python. Comenzaremos con ejemplos sencillos y pasaremos gradualmente a otros más complejos. Al finalizar este laboratorio, debería tener una buena comprensión de cómo utilizar el módulo argparse para crear potentes interfaces de línea de comandos para sus programas de Python.

Logros

• Módulo argparse
• Scripts de Python

Importación del módulo Argparse

El primer paso para utilizar el módulo argparse es importarlo.

Necesita crear un archivo de Python que contendrá su código.

touch my_program.py

Podemos hacerlo añadiendo la siguiente línea de código al principio de nuestro script de Python:

import argparse

Creación de un objeto analizador (parser)

Una vez que hayamos importado el módulo argparse, podemos crear un objeto analizador llamando a la función ArgumentParser(). Esta función toma varios argumentos opcionales, pero por ahora, solo proporcionaremos una descripción simple de nuestro programa.

parser = argparse.ArgumentParser(description="Una interfaz de línea de comandos simple.")

Adición de argumentos

Ahora que tenemos un objeto analizador, podemos empezar a añadirle argumentos. Hay varios tipos de argumentos que podemos añadir, como argumentos posicionales y argumentos opcionales. Por ejemplo, podemos añadir un argumento posicional como este:

parser.add_argument("name", help="Tu nombre")

Y un argumento opcional como este:

parser.add_argument("-n", "--number", help="Número de veces que se repetirá el mensaje", type=int, default=1)

Análisis de argumentos

Una vez que hayamos añadido todos nuestros argumentos, podemos analizarlos llamando a la función parse_args() de nuestro objeto analizador. Esta función no toma argumentos y devuelve un objeto que contiene los valores de todos nuestros argumentos.

args = parser.parse_args()

Uso de los argumentos

Ahora que hemos analizado nuestros argumentos, podemos usarlos en nuestro programa. Por ejemplo, podemos usar el argumento de nombre así:

print("Hola, " + args.name)

Y el argumento opcional así:

print("Hola, " + args.name * args.number)

Código completo

Aquí está el código completo para el laboratorio que incluye todos los pasos descritos anteriormente:

import argparse

## Creación de un objeto analizador
parser = argparse.ArgumentParser(description="Una interfaz de línea de comandos simple.")

## Adición de argumentos
parser.add_argument("name", help="Tu nombre")
parser.add_argument("-n", "--number", help="Número de veces que se repetirá el mensaje", type=int, default=1)

## Análisis de argumentos
args = parser.parse_args()

## Uso de los argumentos
print("Hola, " + args.name * args.number)

Puede ejecutar el script navegando al directorio donde se encuentra el archivo en la línea de comandos y escribiendo python my_program.py seguido de los argumentos que desea pasar al script:

python my_program.py "John" --number 3

Esto imprimirá "Hola, JohnJohnJohn" en la consola.

Resumen

En este laboratorio, aprendimos a utilizar el módulo argparse para crear una interfaz de línea de comandos para un programa de Python. Vimos cómo importar el módulo argparse, crear un objeto analizador, añadir argumentos al analizador, analizar los argumentos y utilizarlos en nuestro programa. Con este conocimiento, debería ser capaz de crear potentes interfaces de línea de comandos para sus programas de Python.