Construyendo una Herramienta de Línea de Comandos Completa
En este paso, combinaremos todo lo que hemos aprendido para construir una herramienta de línea de comandos completa. Creemos un administrador de tareas simple que permita a los usuarios agregar, listar y eliminar tareas utilizando argumentos de línea de comandos.
Creando el Administrador de Tareas
- Cree un nuevo archivo llamado
task_manager.py en el directorio /home/labex/project
- Agregue el siguiente código:
import argparse
import json
import os
## File to store tasks
TASKS_FILE = "/home/labex/project/tasks.json"
def load_tasks():
"""Load tasks from the JSON file."""
if os.path.exists(TASKS_FILE):
with open(TASKS_FILE, 'r') as f:
try:
return json.load(f)
except json.JSONDecodeError:
return []
return []
def save_tasks(tasks):
"""Save tasks to the JSON file."""
with open(TASKS_FILE, 'w') as f:
json.dump(tasks, f, indent=2)
def main():
## Create the main parser
parser = argparse.ArgumentParser(description='Task Manager CLI')
subparsers = parser.add_subparsers(dest='command', help='Command to run')
## Add command
add_parser = subparsers.add_parser('add', help='Add a new task')
add_parser.add_argument('title', help='Task title')
add_parser.add_argument('-p', '--priority',
choices=['low', 'medium', 'high'],
default='medium',
help='Task priority (default: medium)')
add_parser.add_argument('-d', '--due',
help='Due date (format: YYYY-MM-DD)')
## List command
list_parser = subparsers.add_parser('list', help='List all tasks')
list_parser.add_argument('-p', '--priority',
choices=['low', 'medium', 'high'],
help='Filter tasks by priority')
list_parser.add_argument('-s', '--sort',
choices=['priority', 'title'],
default='priority',
help='Sort tasks by criteria (default: priority)')
## Delete command
delete_parser = subparsers.add_parser('delete', help='Delete a task')
delete_parser.add_argument('task_id', type=int, help='Task ID to delete')
## Parse arguments
args = parser.parse_args()
## Load existing tasks
tasks = load_tasks()
## Handle commands
if args.command == 'add':
## Add a new task
new_task = {
'id': len(tasks) + 1,
'title': args.title,
'priority': args.priority,
'due': args.due
}
tasks.append(new_task)
save_tasks(tasks)
print(f"Task added: {new_task['title']} (ID: {new_task['id']})")
elif args.command == 'list':
## List tasks
if not tasks:
print("No tasks found.")
return
## Filter by priority if specified
if args.priority:
filtered_tasks = [t for t in tasks if t['priority'] == args.priority]
else:
filtered_tasks = tasks
## Sort tasks
if args.sort == 'priority':
## Custom priority sorting
priority_order = {'high': 0, 'medium': 1, 'low': 2}
sorted_tasks = sorted(filtered_tasks, key=lambda x: priority_order[x['priority']])
else:
## Sort by title
sorted_tasks = sorted(filtered_tasks, key=lambda x: x['title'])
## Display tasks
print("ID | Title | Priority | Due Date")
print("-" * 50)
for task in sorted_tasks:
due_date = task['due'] if task['due'] else 'N/A'
print(f"{task['id']:2} | {task['title'][:20]:<20} | {task['priority']:<8} | {due_date}")
elif args.command == 'delete':
## Delete a task
task_id = args.task_id
task_found = False
for i, task in enumerate(tasks):
if task['id'] == task_id:
del tasks[i]
task_found = True
break
if task_found:
save_tasks(tasks)
print(f"Task {task_id} deleted.")
else:
print(f"Task {task_id} not found.")
else:
## No command specified
parser.print_help()
if __name__ == "__main__":
main()
Comprender el Administrador de Tareas
Este script demuestra varias características avanzadas de argparse:
- Subparsers (Subparsers) - Creación de conjuntos de argumentos específicos para cada comando
- Argumentos específicos para cada comando (Command-specific arguments) - Diferentes argumentos para los comandos add, list y delete
- Validación anidada - Opciones de prioridad limitadas a valores específicos
- Valores predeterminados - Proporcionar valores predeterminados sensatos para argumentos opcionales
Probando el Administrador de Tareas
Ejecutemos el script con diferentes comandos para ver cómo funciona:
-
Agregar tareas:
python3 task_manager.py add "Complete Python tutorial" -p high -d 2023-12-31
Salida:
Task added: Complete Python tutorial (ID: 1)
Agregue algunas tareas más:
python3 task_manager.py add "Read documentation" -p medium
python3 task_manager.py add "Take a break" -p low -d 2023-12-25
-
Listar tareas:
python3 task_manager.py list
Salida:
ID | Title | Priority | Due Date
--------------------------------------------------
1 | Complete Python tutor | high | 2023-12-31
2 | Read documentation | medium | N/A
3 | Take a break | low | 2023-12-25
-
Listar tareas con filtrado y ordenamiento:
python3 task_manager.py list -s title
Salida:
ID | Title | Priority | Due Date
--------------------------------------------------
1 | Complete Python tutor | high | 2023-12-31
2 | Read documentation | medium | N/A
3 | Take a break | low | 2023-12-25
-
Filtrar por prioridad:
python3 task_manager.py list -p high
Salida:
ID | Title | Priority | Due Date
--------------------------------------------------
1 | Complete Python tutor | high | 2023-12-31
-
Eliminar una tarea:
python3 task_manager.py delete 2
Salida:
Task 2 deleted.
Verifique que la tarea se eliminó:
python3 task_manager.py list
Salida:
ID | Title | Priority | Due Date
--------------------------------------------------
1 | Complete Python tutor | high | 2023-12-31
3 | Take a break | low | 2023-12-25
Obtener Ayuda para Subcomandos
Argparse genera automáticamente ayuda para cada subcomando:
python3 task_manager.py add --help
Salida:
usage: task_manager.py add [-h] [-p {low,medium,high}] [-d DUE] title
positional arguments:
title Task title
options:
-h, --help show this help message and exit
-p {low,medium,high}, --priority {low,medium,high}
Task priority (default: medium)
-d DUE, --due DUE Due date (format: YYYY-MM-DD)
Puntos Clave sobre los Subparsers
- Los subparsers crean conjuntos de argumentos específicos para cada comando
- Cada subparser puede tener sus propios argumentos
- El parámetro
dest especifica dónde se almacenará el nombre del comando
- Los mensajes de ayuda se generan automáticamente para cada subcomando
- Puede mezclar argumentos posicionales y opcionales en los subparsers
Ahora tiene una herramienta de línea de comandos completamente funcional que demuestra el poder y la flexibilidad de argparse para manejar escenarios de argumentos complejos.
