logger and exception added

Author: sitamgithub-MSIT

.streamlit/config.toml

@@ -1,2 +1,5 @@
+[client]
+showErrorDetails = false
+
 [theme]
 base="dark"

app.py

@@ -2,11 +2,13 @@
 import os
 from PIL import Image
 
+# Streamlit imports
 import streamlit as st
 from streamlit_image_select import image_select
 
+# Local imports
 from src.utils import input_image_details
-from src.llm_response import (
+from src.model.llm_response import (
     generate_image_response,
     generate_text_response,
     generate_example_image_response,
@@ -63,7 +65,7 @@
         start_button = st.button("Build", key="button_image_start", disabled=False)
 
     # If image is uploaded or example image is selected
-    if any([upload_img, example_img]) == True:
+    if any([upload_img, example_img]):
         if "img" in locals() or "img" in globals():
             if start_button:
 
@@ -121,12 +123,12 @@
 
                 # Raise error if any error occurs during response generation
                 except Exception as e:
-                    st.error(f"An error occurred: {e}")
+                    st.error("Error on image prompt generation response")
+                    print(e)
 
-        else:
-            if not image_upload and start_button:
-                # Warn user to upload image
-                st.warning("Please upload your preview image.")
+        elif not image_upload and start_button:
+            # Warn user to upload image
+            st.warning("Please upload your preview image.")
 
 
 # Tell how the app should be built
@@ -160,7 +162,8 @@
 
             # Raise error if any error occurs during response generation
             except Exception as e:
-                st.error(f"An error occurred: {e}")
+                st.error("Error on text prompt generation response")
+                print(e)
 
     # If text prompt is not provided and start button is clicked
     elif not text_prompt and start_button:

requirements.txt

@@ -2,4 +2,5 @@ streamlit==1.36.0
 Pillow==10.3.0
 streamlit-image-select==0.6.0
 google-generativeai==0.7.1
-python-dotenv==1.0.1
+python-dotenv==1.0.1
+weave

src/exception.py

@@ -0,0 +1,53 @@
+"""
+This module defines a custom exception handling class and a function to get error message with details of the error.
+"""
+
+# Standard Library
+import sys
+
+# Local imports
+from src.logger import logging
+
+
+# Function Definition to get error message with details of the error (file name and line number) when an error occurs in the program
+def get_error_message(error, error_detail: sys):
+    """
+    Get error message with details of the error.
+
+    Parameters:
+    error (Exception): The error that occurred.
+    error_detail (sys): The details of the error.
+
+    Returns:
+    str: A string containing the error message along with the file name and line number where the error occurred.
+    """
+
+    _, _, exc_tb = error_detail.exc_info()
+
+    # Get error details
+    file_name = exc_tb.tb_frame.f_code.co_filename
+    return "Error occured in python script name [{0}] line number [{1}] error message[{2}]".format(
+        file_name, exc_tb.tb_lineno, str(error)
+    )
+
+
+# Custom Exception Handling Class Definition
+class CustomExceptionHandling(Exception):
+    """
+    Custom Exception Handling
+
+    This class defines a custom exception that can be raised when an error occurs in the program.
+    It takes an error message and an error detail as input and returns a formatted error message
+    when the exception is raised.
+    """
+
+    # Constructor
+    def __init__(self, error_message, error_detail: sys):
+        """Initialize the exception"""
+        super().__init__(error_message)
+
+        self.error_message = get_error_message(error_message, error_detail=error_detail)
+
+    def __str__(self):
+        """String representation of the exception"""
+        return self.error_message

src/logger.py

@@ -0,0 +1,21 @@
+# Importing the required modules
+import logging
+import os
+from datetime import datetime
+
+# Creating a log file with the current date and time as the name of the file
+LOG_FILE = f"{datetime.now().strftime('%m_%d_%Y_%H_%M_%S')}.log"
+
+# Creating a logs folder if it does not exist
+logs_path = os.path.join(os.getcwd(), "logs", LOG_FILE)
+os.makedirs(logs_path, exist_ok=True)
+
+# Setting the log file path and the log level
+LOG_FILE_PATH = os.path.join(logs_path, LOG_FILE)
+
+# Configuring the logger
+logging.basicConfig(
+    filename=LOG_FILE_PATH,
+    format="[ %(asctime)s ] %(lineno)d %(name)s - %(levelname)s - %(message)s",
+    level=logging.INFO,
+)

src/config.py src/model/config.py

@@ -1,11 +1,15 @@
 # Necessary imports
 import os
+import sys
 from dotenv import load_dotenv
 
 import google.generativeai as genai
 
-from src.config import generation_config, safety_settings, model_name
-from src.prompt import system_prompt
+# Local imports
+from src.model.config import generation_config, safety_settings, model_name
+from src.model.prompt import system_prompt
+from src.logger import logging
+from src.exception import CustomExceptionHandling
 
 
 # Load the Environment Variables from .env file
@@ -27,7 +31,7 @@
 instruction = "Generate the complete Streamlit app code based on the provided preview image or example. Ensure the code includes layout, functionality, and any specified features visible in the image. Incorporate common Streamlit components such as sliders, buttons, and charts where applicable, handle any specific UI elements shown in the image, and ensure proper data handling and user interactions are implemented."
 
 
-def generate_text_response(text_prompt):
+def generate_text_response(text_prompt: str) -> str:
     """
     Generate Streamlit app code based on the provided text prompt.
 
@@ -44,16 +48,19 @@ def generate_text_response(text_prompt):
         # Response generation for text using Gemini API
         response = model.generate_content(text_prompt)
 
-        # Extract the actual content part from the response
-        content = response.text
-        return content
+        # Log the successful response generation
+        logging.info("Response generated successfully for text prompt")
+
+        # Return the extracted content from the response
+        return response.text
 
     # Raise error if any error occurs during response generation
     except Exception as e:
-        raise RuntimeError(f"An error occurred during text response generation: {e}")
+        # Custom exception handling
+        raise CustomExceptionHandling(e, sys) from e
 
 
-def generate_example_image_response(img):
+def generate_example_image_response(img: str) -> str:
     """
     Generate Streamlit app code based on the provided example image.
 
@@ -70,16 +77,18 @@ def generate_example_image_response(img):
         # Response generation for example image using Gemini API
         response = model.generate_content([instruction, img])
 
-        # Extract the actual content part from the response
-        content = response.text
-        return content
+        # Log the successful response generation
+        logging.info("Response generated successfully for example image")
+
+        # Return the extracted content from the response
+        return response.text
 
-    # Raise error if any error occurs during response generation
     except Exception as e:
-        raise RuntimeError(f"An error occurred during image response generation: {e}")
+        # Custom exception handling
+        raise CustomExceptionHandling(e, sys) from e
 
 
-def generate_image_response(image_data):
+def generate_image_response(image_data: list) -> str:
     """
     Generate a response for an uploaded image using the Gemini API.
 
@@ -96,10 +105,13 @@ def generate_image_response(image_data):
         # Response generation for uploaded image using Gemini API
         response = model.generate_content([instruction, image_data[0]])
 
-        # Extract the actual content part from the response
-        content = response.text
-        return content
+        # Log the successful response generation
+        logging.info("Response generated successfully for uploaded image")
+
+        # Return the extracted content from the response
+        return response.text
 
     # Raise error if any error occurs during response generation
     except Exception as e:
-        raise RuntimeError(f"An error occurred during image response generation: {e}")
+        # Custom exception handling
+        raise CustomExceptionHandling(e, sys) from e

src/llm_response.py src/model/llm_response.py

@@ -11,21 +11,17 @@ def input_image_details(uploaded_file):
     Raises:
         FileNotFoundError: If no file is uploaded.
     """
-    if uploaded_file is not None:
-        # Read the file into bytes
-        bytes_data = uploaded_file.getvalue()
-
-        # Create a list of image parts with the mime type and data
-        image_parts = [
-            {
-                "mime_type": uploaded_file.type,  # Get the mime type of the uploaded file
-                "data": bytes_data,
-            }
-        ]
+    if uploaded_file is None:
+        # If no file is uploaded, raise an error
+        raise FileNotFoundError("No file uploaded")
 
-        # Return the list of image parts
-        return image_parts
+    # Read the file into bytes
+    bytes_data = uploaded_file.getvalue()
 
-    # If no file is uploaded, raise an error
-    else:
-        raise FileNotFoundError("No file uploaded")
+    # Return a list containing a dictionary with the mime type and data of the uploaded file
+    return [
+        {
+            "mime_type": uploaded_file.type,  # Get the mime type of the uploaded file
+            "data": bytes_data,
+        }
+    ]