Objetivos Generales Ciclo 1

[diegoabeltran16]

• Establecer la estructura básica del proyecto.
• Implementar el manejo básico de comandos.
• Establecer la base de datos SQLite y las operaciones CRUD.
• Integrar el soporte multilingüe básico.

[diegoabeltran16]

Esstructura básica del proyecto

'''

Passive-Expenses-Bot Estructura del proyecto Ciclo #1

Este documento subraya la estructura para el proyecto de Passive-Expenses-Bot.

Direcotrios y Documentos de Raiz

• docs/:

  • Esta carpeta de documentacion es para API reference, setup, and usage.
  • Documentos: api_reference.md, setup.md, usage.md

• project_details/:

  • Una carpeta que tiene información específica del proyecto

• src/:

  • El directorio central donde reside todo el código fuente del bot.
  • Contiene la lógica, los comandos, las utilidades y la configuración del bot.

• tests/:

  • Directorio para pruebas unitarias y marco de pruebas.

• unidad_practica/:

  • Documentacion de entrega para compensar

• .editorconfig:

  • Archivo utilizado para mantener estilos de codificación consistentes entre diferentes editores e IDEs.

• .env:

  • Configuración de variables de entorno (normalmente contiene configuraciones específicas del entorno).

• .flake8:

  • Configuración de Python linting para hacer cumplir las normas de formato de código utilizando flake8.

• .gitignore:

  • Garantiza que los archivos sensibles (como config.yaml) y los archivos innecesarios no sean rastreados en el control de versiones.

• .gitlab-ci.yml:

  • Configuración CI para GitLab, utilizada para la integración continua (por ejemplo, pruebas o compilaciones automatizadas).

• environment.yml:

  • Especificar las dependencias del entorno.

• LICENSE:

  • Información sobre la licencia de proyectos.

• README.md:

  • Archivo principal de documentación para configurar, utilizar y comprender el proyecto.

• requirements.txt:

  • Dependencias de Python necesarias para el proyecto.

• Shell scripts:

  • sync_branch.sh, sync_feature.sh, sync_hotfix.sh, sync_merge_features.sh, sync_repos.sh:
  • Scripts de shell para ayudar con el flujo de trabajo de Git, la sincronización de ramas y la automatización de las operaciones de Git.

src/: Fuente del Codigo

• commands/:

  • Contiene archivos individuales para cada comando implementado en el bot.
  • Documentos:
  • log_expense.py
  • delete_expense.py
  • list_expenses.py
  • generate_report.py

• config/:

  • Ajustes de configuración del bot.
  • Contiene config.yaml (excluido del git en .gitignore).

• utils/:

  • Utilidades y scripts de ayuda para el bot.
  • Documentos:
  • ai.py: Marcador de posición para la funcionalidad basada en IA.
  • logging_config.py: Configuración para el registro.
  • nlu.py: Marcador de posición para la comprensión o el análisis sintáctico del lenguaje natural.
  • scheduler.py: Gestiona tareas periódicas o programadas.
  • validation.py: Validación de entradas y lógica general de validación.

• bot.py:

  • Punto de entrada principal del bot, responsable de ejecutar el bot y manejar los eventos.

• database.py:

  • Marcador de posición o archivo implementado para interactuar con una base de datos (como SQLite).

tests/: Testing Framework

• test_commands/:

  • Contiene archivos de prueba para cada comando.
  • Documentos:
  • test_log_expense.py
  • test_delete_expense.py
  • test_list_expenses.py
  • test_generate_report.py

• test_utils/:

  • Contiene pruebas para scripts de utilidades.
  • Documentos:
  • test_ai.py
  • test_logging.py
  • test_nlu.py
  • test_scheduler.py
  • test_validation.py

• test_bot.py:

  • Prueba la funcionalidad general del bot.

• test_database.py:

  • Pruebas de interacciones con la base de datos, que probablemente cubran operaciones CRUD para gastos.

---

[diegoabeltran16]

Implementacion de Gestión basico de comandos

Resumen

Este documento resume el desarrollo de la función Command Handling para el Passive-Expenses-Bot. El objetivo de esta función es proporcionar un manejo de comandos estructurado y modularizado utilizando el framework discord.ext.commands de Discord. La función incluye el manejo de las solicitudes de los usuarios para registrar y eliminar los gastos, así como un simple comando ping para probar la capacidad de respuesta del bot.

Proceso de desarrollo

Paso 1: Configuración inicial del Bot

El bot fue configurado usando la clase discord.ext.commands.Bot de Discord. El bot lee su configuración de un archivo YAML (config/config.yaml) donde se almacenan ajustes como el token del bot y el prefijo del comando. Se han habilitado intentos privilegiados para permitir al bot leer el contenido de los mensajes y procesar comandos.

Step 2: Implementacion de comandos basicos

1. Comando Ping:

   • Se ha implementado un comando simple (!ping) para comprobar si el bot responde.
   • Cuando un usuario envía !ping, el bot responde con Pong!, confirmando la actividad del bot.
   • Implementado en bot.py.

2. Comando de registro de gastos (!log_expense [amount] [description]):

   • Propósito: Permitir a los usuarios registrar gastos.
   • Parámetros:
     • importe: Un valor flotante que representa el valor monetario del gasto.
     • Descripción Una cadena que describe el gasto.
   • Respuesta: El bot responde con un mensaje de confirmación, por ejemplo, «Gasto registrado: 100 para comer en la cafetería».
   • El comando se implementó dentro de una clase Confg (LogExpense) ubicada en commands/log_expense.py.

3. Comando Borrar Gasto (!delete_expense [expense_id]): - Propósito: Permitir a los usuarios borrar un gasto por ID. - Parámetros: - expense_id: Un número entero que representa el ID del gasto que se va a eliminar. - Respuesta: El bot responde con un mensaje de confirmación, por ejemplo, "Gasto con ID 1 eliminado". - El comando se implementó dentro de una clase Cog (DeleteExpense) ubicada en commands/delete_expense.py.

Paso 3: Depuración y Manejo Asíncrono

Durante el desarrollo, se encontraron problemas relacionados con la naturaleza asíncrona del método bot.add_cog() y la incapacidad del bot para leer el contenido del mensaje debido a la falta de intents privilegiados.

Estos problemas se resolvieron mediante:

1. Esperando bot.add_cog():

   • El método bot.add_cog() necesitaba ser esperado, ya que es una operación asíncrona.
   • La función setup tanto en log_expense.py como en delete_expense.py fue convertida a asíncrona para asegurar la correcta carga de comandos.

2. Activación de intenciones privilegiadas:

   • Se ha concedido al bot la Intención de contenido de mensaje en el Portal del Desarrollador de Discord para garantizar que pueda leer mensajes y procesar comandos.
   • Se han ajustado las intenciones en bot.py habilitando tanto intents.message_content como intents.messages.

Paso 4: Pruebas con éxito

Después de implementar estos cambios, el bot fue probado ejecutando los comandos !log_expense y !delete_expense en Discord. El bot respondió satisfactoriamente con las confirmaciones correctas, indicando que los comandos se estaban procesando como se esperaba.

Paso 5: Estructura del proyecto

La estructura general del proyecto incluye los siguientes directorios y archivos clave:

Passive-Expenses-Bot/
│
├── docs/
│   ├── api_reference.md
│   ├── setup.md
│   └── usage.md
│
├── src/
│   ├── commands/
│   │   ├── __init__.py
│   │   ├── log_expense.py
│   │   └── delete_expense.py
│   ├── bot.py
│   ├── config/
│   │   └── config.yaml
│   └── utils/
│       ├── ai.py
│       └── validation.py
│
├── tests/
│   ├── test_commands/
│   └── test_utils/
│
└── .gitignore

• Los comandos están modularizados en el directorio commands/.
• Las pruebas están configuradas en el directorio tests/ para asegurar que la lógica de gestión de comandos funciona como se espera.

Conclusión

La función de gestión de comandos se ha implementado y probado con éxito. El bot ya puede procesar los comandos log_expense y delete_expense, lo que permite a los usuarios registrar y eliminar gastos de forma interactiva. Se habilitaron las intenciones privilegiadas para permitir al bot acceder al contenido de los mensajes, y todo el proceso de carga de comandos se hizo asíncrono para garantizar una ejecución fluida. El sistema de comandos del bot es modular y puede ampliarse fácilmente para incluir más comandos según sea necesario.