refactor: tweaks

Author: lpm0073

app/const.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+"""Constants for the Stackademy application."""
+
+MISSING = "MISSING"

app/prompt.py

@@ -19,22 +19,24 @@
 )
 
 from app import settings
+from app.const import MISSING
 from app.logging_config import get_logger, setup_logging
 from app.stackademy import stackademy_app
 
 
 setup_logging()
 logger = get_logger(__name__)
 
-
-messages: list[
+MessagesType = list[
     Union[
         ChatCompletionSystemMessageParam,
         ChatCompletionUserMessageParam,
         ChatCompletionAssistantMessageParam,
         ChatCompletionToolMessageParam,
     ]
-] = [
+]
+
+messages: MessagesType = [
     ChatCompletionSystemMessageParam(
         role="system",
         content="""You are a helpful assistant for the Stackademy online learning platform.
@@ -68,9 +70,9 @@ def handle_function_call(function_name: str, arguments: dict) -> str:
         return json.dumps(courses, default=str, indent=2)
 
     if function_name == "register_course":
-        course_code = arguments.get("course_code", "MISSING COURSE CODE")
-        email = arguments.get("email", "MISSING EMAIL")
-        full_name = arguments.get("full_name", "MISSING NAME")
+        course_code = arguments.get("course_code", MISSING)
+        email = arguments.get("email", MISSING)
+        full_name = arguments.get("full_name", MISSING)
 
         # Call the actual function
         success = stackademy_app.register_course(course_code=course_code, email=email, full_name=full_name)
@@ -123,7 +125,6 @@ def process_tool_calls(message: ChatCompletionMessage) -> list[str]:
     return functions_called
 
 
-# pylint: disable=too-many-locals
 def completion(prompt: str) -> tuple[ChatCompletion, list[str]]:
     """LLM text completion"""
 

app/settings.py

@@ -12,10 +12,10 @@
 load_dotenv()
 
 # OpenAI API settings
-OPENAI_API_KEY = os.getenv("OPENAI_API_KEY", None)
-OPENAI_API_MODEL = "gpt-4o-mini"
-OPENAI_API_TEMPERATURE = 0.0
-OPENAI_API_MAX_TOKENS = 4096
+OPENAI_API_KEY = os.getenv("OPENAI_API_KEY", "SET-ME-PLEASE")
+OPENAI_API_MODEL = os.getenv("OPENAI_API_MODEL", "gpt-4o-mini")
+OPENAI_API_TEMPERATURE = float(os.getenv("OPENAI_API_TEMPERATURE", "0.0"))
+OPENAI_API_MAX_TOKENS = int(os.getenv("OPENAI_API_MAX_TOKENS", "4096"))
 
 
 # MySQL database settings

app/stackademy.py

@@ -7,6 +7,7 @@
 from openai.types.chat import ChatCompletionFunctionToolParam
 from pydantic import BaseModel, Field
 
+from app.const import MISSING
 from app.database import db
 from app.exceptions import ConfigurationException
 from app.logging_config import get_logger, setup_logging
@@ -182,6 +183,13 @@ def register_course(self, course_code: str, email: str, full_name: str) -> bool:
         Returns:
             bool: True if registration is successful, False otherwise
         """
+        if MISSING in (course_code, email, full_name):
+            raise ConfigurationException("Missing required registration parameters.")
+
+        full_name = full_name.title().strip()
+        email = email.lower().strip()
+        course_code = course_code.upper().strip()
+
         logger.info("Registering %s (%s) for course %s...", full_name, email, course_code)
         if not self.verify_course(course_code):
             logger.error("Course code %s does not exist.", course_code)