Update app.py

app.py

@@ -11,7 +11,15 @@ initialize_database()
 
 # Function to execute SQL script from uploaded file
 def execute_sql_script(file_path):
-    """Executes an uploaded SQL file to initialize the database."""
+    """
+    Executes an uploaded SQL file to initialize the database.
+
+    Args:
+        file_path (str): Path to the SQL file.
+
+    Returns:
+        str: Success message or error description.
+    """
     try:
         with engine.connect() as con:
             with open(file_path, "r") as f:
@@ -23,20 +31,41 @@ def execute_sql_script(file_path):
 
 # Function to fetch table names dynamically
 def get_table_names():
-    """Returns a list of all tables in the database."""
+    """
+    Returns a list of all tables in the database.
+
+    Returns:
+        list: List of table names.
+    """
     inspector = inspect(engine)
     return inspector.get_table_names()
 
 # Function to fetch table schema dynamically
 def get_table_schema(table_name):
-    """Returns a list of column names for a given table."""
+    """
+    Returns a list of column names for a given table.
+
+    Args:
+        table_name (str): Name of the table.
+
+    Returns:
+        list: List of column names.
+    """
     inspector = inspect(engine)
     columns = inspector.get_columns(table_name)
     return [col["name"] for col in columns]
 
 # Function to fetch table data dynamically
 def get_table_data(table_name):
-    """Retrieves all rows from the specified table as a Pandas DataFrame."""
+    """
+    Retrieves all rows from the specified table as a Pandas DataFrame.
+
+    Args:
+        table_name (str): Name of the table.
+
+    Returns:
+        pd.DataFrame: Table data or an error message.
+    """
     try:
         with engine.connect() as con:
             result = con.execute(text(f"SELECT * FROM {table_name}"))
@@ -54,7 +83,15 @@ def get_table_data(table_name):
 # SQL Execution Tool
 @tool
 def sql_engine(query: str) -> str:
-    """Executes an SQL SELECT query and returns formatted results."""
+    """
+    Executes an SQL SELECT query and returns the results.
+
+    Args:
+        query (str): The SQL query to execute.
+
+    Returns:
+        str: The query results as a formatted string, or an error message.
+    """
     try:
         with engine.connect() as con:
             rows = con.execute(text(query)).fetchall()
@@ -66,7 +103,15 @@ def sql_engine(query: str) -> str:
 
 # Function to generate and execute SQL queries dynamically
 def query_sql(user_query: str) -> str:
-    """Processes a user’s natural language query and generates an SQL query dynamically."""
+    """
+    Processes a user’s natural language query and generates an SQL query dynamically.
+
+    Args:
+        user_query (str): The question asked by the user.
+
+    Returns:
+        str: SQL query results or an error message.
+    """
     tables = get_table_names()
     if not tables:
         return "Error: No tables found. Please upload an SQL file first."
@@ -88,12 +133,28 @@ def query_sql(user_query: str) -> str:
 
 # Function to handle query input
 def handle_query(user_input: str) -> str:
-    """Handles user input and returns the SQL query result."""
+    """
+    Handles user input and returns the SQL query result.
+
+    Args:
+        user_input (str): User's natural language query.
+
+    Returns:
+        str: The query result or error message.
+    """
     return query_sql(user_input)
 
 # Function to handle SQL file uploads
 def handle_file_upload(file):
-    """Handles file upload, executes SQL, and updates database schema dynamically."""
+    """
+    Handles file upload, executes SQL, and updates database schema dynamically.
+
+    Args:
+        file (File): Uploaded SQL file.
+
+    Returns:
+        tuple: Execution result message and updated table data.
+    """
     temp_file_path = tempfile.mkstemp(suffix=".sql")[1]
     with open(temp_file_path, "wb") as temp_file:
         temp_file.write(file.read())