chore: add logging level to .env

Author: lpm0073

.env-example

@@ -2,11 +2,11 @@ OPENAI_API_KEY=ADD-YOUR-OPENAI_API_KEY-HERE
 ENVIRONMENT=dev
 DOCKERHUB_USERNAME=ADD-YOUR-DOCKERHUB_USERNAME-HERE
 DOCKERHUB_ACCESS_TOKEN=ADD-YOUR-DOCKERHUB_ACCESS_TOKEN-HERE
-
-# MySQL Database Configuration
+LOGGING_LEVEL=20
 MYSQL_HOST=your-mysql-host.com
 MYSQL_PORT=3306
 MYSQL_USER=your-username
 MYSQL_PASSWORD=your-password
 MYSQL_DATABASE=your-database-name
 MYSQL_CHARSET=utf8mb4
+TOOL_CHOICE=required

Makefile

@@ -81,7 +81,7 @@ docker-push:
 	docker push ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
 
 docker-run:
-	docker run -it -e OPENAI_API_KEY=${OPENAI_API_KEY} -e ENVIRONMENT=prod -e MYSQL_HOST=${MYSQL_HOST} -e MYSQL_PORT=${MYSQL_PORT} -e MYSQL_USER=${MYSQL_USER} -e MYSQL_PASSWORD=${MYSQL_PASSWORD} -e MYSQL_DATABASE=${MYSQL_DATABASE} -e MYSQL_CHARSET=${MYSQL_CHARSET} ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
+	docker run -it -e OPENAI_API_KEY=${OPENAI_API_KEY} -e ENVIRONMENT=prod -e MYSQL_HOST=${MYSQL_HOST} -e MYSQL_PORT=${MYSQL_PORT} -e MYSQL_USER=${MYSQL_USER} -e MYSQL_PASSWORD=${MYSQL_PASSWORD} -e MYSQL_DATABASE=${MYSQL_DATABASE} -e MYSQL_CHARSET=${MYSQL_CHARSET} -e LOGGING_LEVEL=${LOGGING_LEVEL} -e TOOL_CHOICE=${TOOL_CHOICE} ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
 
 docker-prune:
 	@if [ "`docker ps -aq`" ]; then \

app/agent.py

@@ -23,7 +23,7 @@ def main(prompts: Optional[Tuple[str, ...]] = None) -> None:
     user_prompt = prompts[i] if prompts else input("Welcome to Stackademy! How can I assist you today? ")
 
     response, functions_called = completion(prompt=user_prompt)
-    while response.choices[0].message.content != "Goodbye!":
+    while response and response.choices[0].message.content != "Goodbye!":
         i += 1
         message = response.choices[0].message
         response_message = message.content or ""

app/const.py

@@ -2,3 +2,12 @@
 """Constants for the Stackademy application."""
 
 MISSING = "MISSING"
+
+
+class ToolChoice:
+    """Enumeration for tool choice strategies."""
+
+    AUTO = "auto"
+    REQUIRED = "required"
+    NONE = "none"
+    GET_COURSES = {"type": "function", "function": {"name": "get_courses"}}

app/logging_config.py

@@ -6,8 +6,10 @@
 import logging
 import sys
 
+from app.settings import LOGGING_LEVEL
 
-def setup_logging(level: int = logging.INFO) -> logging.Logger:
+
+def setup_logging(level: int = LOGGING_LEVEL) -> logging.Logger:
     """
     Configure logging for the application.
 

app/prompt.py

@@ -5,7 +5,7 @@
 """
 
 import json
-from typing import Union
+from typing import Optional, Union
 
 import openai
 from openai.types.chat import (
@@ -19,9 +19,11 @@
 )
 
 from app import settings
-from app.const import MISSING
+from app.const import MISSING, ToolChoice
 from app.logging_config import get_logger, setup_logging
+from app.settings import TOOL_CHOICE
 from app.stackademy import stackademy_app
+from app.utils import dump_json_colored
 
 
 setup_logging()
@@ -120,12 +122,13 @@ def process_tool_calls(message: ChatCompletionMessage) -> list[str]:
             messages.append(tool_message)
 
         logger.debug(
-            "Updated messages: %s", [msg.model_dump() if not isinstance(msg, dict) else msg for msg in messages]
+            "Updated messages: %s",
+            [dump_json_colored(msg.model_dump(), "blue") if not isinstance(msg, dict) else msg for msg in messages],
         )
     return functions_called
 
 
-def completion(prompt: str) -> tuple[ChatCompletion, list[str]]:
+def completion(prompt: str) -> tuple[Optional[ChatCompletion], list[str]]:
     """LLM text completion"""
 
     def handle_completion(tools, tool_choice) -> ChatCompletion:
@@ -134,6 +137,11 @@ def handle_completion(tools, tool_choice) -> ChatCompletion:
         model = settings.OPENAI_API_MODEL
 
         try:
+            logger.debug(
+                "Sending messages to OpenAI: %s %s",
+                dump_json_colored(messages, "blue"),
+                dump_json_colored(tools, "blue"),
+            )
             response = openai.chat.completions.create(
                 model=model,
                 messages=messages,
@@ -142,7 +150,7 @@ def handle_completion(tools, tool_choice) -> ChatCompletion:
                 temperature=settings.OPENAI_API_TEMPERATURE,
                 max_tokens=settings.OPENAI_API_MAX_TOKENS,
             )
-            logger.debug("OpenAI response: %s", response.model_dump())
+            logger.debug("OpenAI response: %s", dump_json_colored(response.model_dump(), "green"))
             return response
         except openai.RateLimitError as e:
             logger.error("OpenAI rate limit exceeded: %s", e)
@@ -164,15 +172,19 @@ def handle_completion(tools, tool_choice) -> ChatCompletion:
             logger.error("Unexpected error during OpenAI completion: %s", e)
             raise
 
+    if not prompt.strip():
+        logger.warning("Received empty prompt.")
+        return None, []
+
     messages.append(ChatCompletionUserMessageParam(role="user", content=prompt))
     functions_called = []
 
     response = handle_completion(
         # tool_choice={"type": "function", "function": {"name": "get_courses"}},
-        tool_choice="required",
+        tool_choice=TOOL_CHOICE,
         tools=[stackademy_app.tool_factory_get_courses()],
     )
-    logger.debug("Initial response: %s", response.model_dump())
+    logger.debug("Initial response: %s", dump_json_colored(response.model_dump(), "green"))
 
     message = response.choices[0].message
     while message.tool_calls:
@@ -182,9 +194,9 @@ def handle_completion(tools, tool_choice) -> ChatCompletion:
 
         response = handle_completion(
             tools=[stackademy_app.tool_factory_get_courses(), stackademy_app.tool_factory_register()],
-            tool_choice="auto",
+            tool_choice=ToolChoice.AUTO,
         )
         message = response.choices[0].message
-        logger.debug("Updated response: %s", response.model_dump())
+        logger.debug("Updated response: %s", dump_json_colored(response.model_dump(), "green"))
 
     return response, functions_called

app/settings.py

@@ -1,16 +1,23 @@
 # -*- coding: utf-8 -*-
 """Settings for the app."""
 
+import logging
 import os
 
 from dotenv import load_dotenv
 
+from app.const import ToolChoice
 from app.exceptions import ConfigurationException
 
 
 # Load environment variables from .env file if available
 load_dotenv()
 
+# General settings
+LOGGING_LEVEL = int(os.getenv("LOGGING_LEVEL", str(logging.INFO)))
+TOOL_CHOICE = os.getenv("TOOL_CHOICE", ToolChoice.REQUIRED)
+
+
 # OpenAI API settings
 OPENAI_API_KEY = os.getenv("OPENAI_API_KEY", "SET-ME-PLEASE")
 OPENAI_API_MODEL = os.getenv("OPENAI_API_MODEL", "gpt-4o-mini")

app/utils.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+"""
+Utility functions for Stackademy.
+"""
+
+import json
+
+
+def dump_json_colored(data, color="reset", indent=2, sort_keys=False):
+    """
+    Dumps a JSON dictionary with colored text output.
+
+    Args:
+        data: Dictionary or JSON-serializable object to dump
+        color: Color for the text output ("blue" or "green")
+        indent: Number of spaces for JSON indentation (default: 2)
+        sort_keys: Whether to sort dictionary keys (default: True)
+
+    Returns:
+        str: Colored JSON string
+
+    Raises:
+        ValueError: If color is not "blue" or "green"
+        TypeError: If data is not JSON serializable
+    """
+    # ANSI color codes
+    colors = {
+        "blue": "\033[94m",  # Bright blue
+        "green": "\033[92m",  # Bright green
+        "reset": "\033[0m",  # Reset to default color
+    }
+
+    if color not in ["blue", "green"]:
+        raise ValueError("Color must be either 'blue' or 'green'")
+
+    try:
+        json_str = json.dumps(data, indent=indent, sort_keys=sort_keys, ensure_ascii=False)
+        colored_json = f"{colors[color]}{json_str}{colors['reset']}"
+        return colored_json
+    except (TypeError, ValueError) as e:
+        raise TypeError(f"Data is not JSON serializable: {e}") from e