Refactor prompt templates to use a dedicated class and improve readability

Author: coolbeevip

camel_database_agent/database/manager.py

@@ -28,9 +28,8 @@ def session_scope(session_maker: sessionmaker) -> Iterator[Session]:
     try:
         yield session
         session.commit()
-    except Exception as e:
+    except Exception:
         session.rollback()
-        logger.error(f"Database error: {e}")
         raise
     finally:
         session.close()

camel_database_agent/database/prompts.py

@@ -1,5 +1,9 @@
+import textwrap
+
+
 class PromptTemplates:
-    POLISH_SCHEMA_OUTPUT_EXAMPLE = """Please add detailed {{language}} comments to the following DDL script, explaining the business meaning and design intent of each table and field.
+    POLISH_SCHEMA_OUTPUT_EXAMPLE = textwrap.dedent("""
+    Please add detailed {{language}} comments to the following DDL script, explaining the business meaning and design intent of each table and field.
     
     Requirements:
     - Keep the original DDL script completely unchanged
@@ -32,4 +36,4 @@ class PromptTemplates:
     - Provide specific guidance for adding comments
     - Specify the expected format and content of comments
     - Emphasize professionalism and conciseness
-    """
+    """)

camel_database_agent/database_agent.py

@@ -35,10 +35,7 @@
     strip_sql_code_block,
     timing,
 )
-from camel_database_agent.database_prompt import (
-    DATABASE_SUMMARY_OUTPUT_EXAMPLE,
-    QUESTION_CONVERT_SQL,
-)
+from camel_database_agent.database_prompt import PromptTemplates
 from camel_database_agent.datagen.pipeline import (
     DataQueryInferencePipeline,
 )
@@ -314,7 +311,7 @@ def _generate_database_summary(self, query_samples_size: int) -> TokenUsage:
             self.database_knowledge_backend.get_query_collection_sample(query_samples_size)
         )
 
-        prompt = DATABASE_SUMMARY_OUTPUT_EXAMPLE
+        prompt = PromptTemplates.DATABASE_SUMMARY_OUTPUT_EXAMPLE
         prompt = prompt.replace("{{ddl_sql}}", self.ddl_sql)
         prompt = prompt.replace("{{language}}", self.language)
 
@@ -430,7 +427,7 @@ def train_knowledge(
     @timing
     def question_to_sql(self, question: str, dialect_name: str) -> QuestionMeta:
         """Question to SQL"""
-        prompt = QUESTION_CONVERT_SQL.replace("{{dialect_name}}", dialect_name)
+        prompt = PromptTemplates.QUESTION_CONVERT_SQL.replace("{{dialect_name}}", dialect_name)
 
         ddl_records: List[DDLRecord] = self.database_knowledge_backend.query_ddl(question)
         prompt = prompt.replace(

camel_database_agent/database_prompt.py

@@ -1,46 +1,52 @@
-DATABASE_SUMMARY_OUTPUT_EXAMPLE = """You are a business database expert. Please generate a {{language}} database summary based on the following table structure, with the aim of helping people understand what information this database can provide from a business perspective.
-
-## Table Schema
-{{ddl_sql}}
-
-## Output Example
-
-This database is the core data model of a typical e-commerce system,  
-including modules for user management, product management, order transactions,  
-payment processes, and address management.  
-
-It achieves a complete business loop through multi-table associations  
-(such as user-order-product-payment), supporting users throughout  
-the entire process from registration, browsing products,  
-placing orders and making payments to receiving goods.  
-
-Each table ensures data consistency through foreign key constraints  
-(such as the strong association between orders and users or addresses)  
-and includes timestamp fields (`created_at`/`updated_at`) for tracking data changes.
-
-Now, You only need to output a descriptive text in {{language}}.
-"""
-
-QUESTION_CONVERT_SQL = """The following is the table structure in the database and some common query SQL statements. Please convert the user's question into an SQL query statement. Note to comply with sqlite syntax. Do not explain, just provide the SQL directly.
-
-Database System: {{dialect_name}}
-
-## Table Schema
-```sql
-{{table_schema}}
-```
-
-## Data Example
-```sql
-{{sample_data}}
-```
-## Few-Shot Example
-{{qa_pairs}}
-
-## User Question
-{{question}}
-
-## Instructions
-1. Follow {{dialect_name}} syntax
-2. Do not provide explanations, just give the SQL statement directly
-"""
+import textwrap
+
+
+class PromptTemplates:
+    DATABASE_SUMMARY_OUTPUT_EXAMPLE = textwrap.dedent("""
+    You are a business database expert. Please generate a {{language}} database summary based on the following table structure, with the aim of helping people understand what information this database can provide from a business perspective.
+    
+    ## Table Schema
+    {{ddl_sql}}
+    
+    ## Output Example
+    
+    This database is the core data model of a typical e-commerce system,  
+    including modules for user management, product management, order transactions,  
+    payment processes, and address management.  
+    
+    It achieves a complete business loop through multi-table associations  
+    (such as user-order-product-payment), supporting users throughout  
+    the entire process from registration, browsing products,  
+    placing orders and making payments to receiving goods.  
+    
+    Each table ensures data consistency through foreign key constraints  
+    (such as the strong association between orders and users or addresses)  
+    and includes timestamp fields (`created_at`/`updated_at`) for tracking data changes.
+    
+    Now, You only need to output a descriptive text in {{language}}.
+    """)
+
+    QUESTION_CONVERT_SQL = textwrap.dedent("""
+    The following is the table structure in the database and some common query SQL statements. Please convert the user's question into an SQL query statement. Note to comply with sqlite syntax. Do not explain, just provide the SQL directly.
+    
+    Database System: {{dialect_name}}
+    
+    ## Table Schema
+    ```sql
+    {{table_schema}}
+    ```
+    
+    ## Data Example
+    ```sql
+    {{sample_data}}
+    ```
+    ## Few-Shot Example
+    {{qa_pairs}}
+    
+    ## User Question
+    {{question}}
+    
+    ## Instructions
+    1. Follow {{dialect_name}} syntax
+    2. Do not provide explanations, just give the SQL statement directly
+    """)

camel_database_agent/datagen/prompts.py

@@ -1,5 +1,9 @@
+import textwrap
+
+
 class PromptTemplates:
-    QUESTION_INFERENCE_PIPELINE = """Please carefully analyze the following database information and conduct an in-depth analysis from a business perspective. What business query questions might users raise? Please fully consider some complex query scenarios, including but not limited to multi-table associations, grouping statistics, etc.
+    QUESTION_INFERENCE_PIPELINE = textwrap.dedent("""
+    Please carefully analyze the following database information and conduct an in-depth analysis from a business perspective. What business query questions might users raise? Please fully consider some complex query scenarios, including but not limited to multi-table associations, grouping statistics, etc.
 
     Database Schema:
     ```
@@ -11,4 +15,4 @@ class PromptTemplates:
     {{data_sql}}
     ```
 
-    Now, Please generate {{query_samples_size}} real user query questions along with the corresponding SQL query statements without using placeholders. Please output in JSON format."""
+    Now, Please generate {{query_samples_size}} real user query questions along with the corresponding SQL query statements without using placeholders. Please output in JSON format.""")