add a new result class

Author: FeiYang73

README.md

@@ -82,7 +82,7 @@ WHERE users.Gender='M' AND users.userID<3000
 
 ### 3. VALIDATE WITH Statement
 
-The `VALIDATE WITH` statement specifies validation data with the same syntax as `TRAIN WITH`. This statement defines the validation set used for model selection. If omitted, `validate_result` will be `None`.
+The `VALIDATE WITH` statement specifies validation data with the same syntax as `TRAIN WITH`. This statement defines the validation set used for model selection. If omitted, `result.validate_result` will be `None`.
 
 #### Syntax
 
@@ -130,14 +130,13 @@ This will install TLSQL in development mode, allowing you to make changes to the
 ```python
 import tlsql
 
-# Workflow mode: PREDICT only (auto-generates TRAIN)
+
 result = tlsql.convert(
     predict_query="PREDICT VALUE(users.Age, CLF) FROM users WHERE users.Gender='F'"
 )
 print(result.predict.statement_type)  # 'PREDICT'
 print(result.predict.target_column)   # 'users.Age'
 print(result.predict.task_type)       # 'CLF'
-print(result.train.sql)                # Auto-generated TRAIN SQL
 ```
 
 ### Examples

__init__.py

@@ -15,7 +15,7 @@
 """
 
 from typing import Optional
-from tlsql.tlsql.sql_generator import SQLGenerator, ConversionResult
+from tlsql.tlsql.sql_generator import SQLGenerator, ConversionResult, StatementResult
 __version__ = "0.1.0"
 __author__ = "TLSQL Team"
 
@@ -37,7 +37,9 @@ def convert(
         validate_query: VALIDATE TLSQL statement (optional).
 
     Returns:
-        ConversionResult: Contains predict_result, train_result, and validate_result.
+        ConversionResult: Contains predict_result (StatementResult), train_result (StatementResult), 
+        and validate_result (Optional[StatementResult]). Use shortcut properties result.predict, 
+        result.train, and result.validate to access individual statement results.
 
     """
 
@@ -79,6 +81,7 @@ def convert(
 from tlsql.tlsql.sql_generator import (
     GeneratedSQL,
     ConversionResult,
+    StatementResult,
 )
 
 # AST nodes (all AST components)
@@ -124,6 +127,7 @@ def convert(
     "SQLGenerator",
     "GeneratedSQL",
     "ConversionResult",
+    "StatementResult",
     # AST nodes
     "ASTNode",
     "Statement",

docs/source/conversion.rst

@@ -85,9 +85,9 @@ The conversion process consists of four main steps:
 
 4. **Result Assembly**
 
-   **Used Class:** :class:`ConversionResult`
+   **Used Classes:** :class:`ConversionResult` and :class:`StatementResult`
 
-   The final standard SQL statement is constructed and wrapped in a ``ConversionResult`` object, which contains all extracted metadata.
+   The final standard SQL statement is constructed and wrapped in a ``StatementResult`` object, which contains all extracted metadata for a single statement. For workflow conversions, multiple ``StatementResult`` objects are wrapped in a ``ConversionResult`` object.
 
 **Standard SQL:**
 
@@ -99,9 +99,19 @@ The conversion process consists of four main steps:
 
 The conversion returns a ``ConversionResult`` object containing:
 
-- ``statement_type``: ``'PREDICT'``
-- ``target_column``: ``'users.Age'``
-- ``task_type``: ``'CLF'``
-- ``target_table``: ``'users'``
-- ``where_condition``: ``"Gender = 'F'"``
+- ``predict_result``: A ``StatementResult`` object with:
+  - ``statement_type``: ``'PREDICT'``
+  - ``target_column``: ``'users.Age'``
+  - ``task_type``: ``'CLF'``
+  - ``target_table``: ``'users'``
+  - ``where_condition``: ``"Gender = 'F'"``
+  - ``sql_list``: List of ``GeneratedSQL`` objects
+- ``train_result``: A ``StatementResult`` object for TRAIN statement
+- ``validate_result``: An optional ``StatementResult`` object for VALIDATE statement (None if not provided)
+
+You can access these results using the shortcut properties:
+
+- ``result.predict.sql`` - Get PREDICT SQL string
+- ``result.train.sql`` - Get TRAIN SQL string  
+- ``result.validate.sql`` - Get VALIDATE SQL string (returns None if not provided)
 

docs/source/index.rst

@@ -2,6 +2,7 @@ TLSQL Documentation
 ===================
 
 TLSQL is a system designed to simplify machine learning workflows on structured tabular data. It translates SQL-like statements into standard SQL queries and structured learning task descriptions, enabling data scientists and engineers to focus on model development instead of writing complex SQL or manually managing datasets.
+
 TLSQL works seamlessly with **RDBs, data warehouses, and data lakes**, enabling end-to-end table-based ML workflows.
 
 
@@ -29,15 +30,13 @@ Quick Start
 
     import tlsql
     
-    # Workflow mode: PREDICT only (auto-generates TRAIN)
     result = tlsql.convert(
         predict_query="PREDICT VALUE(users.Age, CLF) FROM users WHERE users.Gender='F'"
     )
     print(result.predict.statement_type)  # 'PREDICT'
     print(result.predict.target_column)   # 'users.Age'
     print(result.predict.task_type)       # 'CLF'
-    print(result.train.sql)                # Auto-generated TRAIN SQL
-
+    
 Components
 ----------
 

docs/source/modules/core/sql_generator.rst

@@ -35,15 +35,22 @@ SQL Generator Class
 The :class:`SQLGenerator` class provides the core SQL generation functionality:
 
 .. autoclass:: tlsql.tlsql.sql_generator.SQLGenerator
-   :no-members:
+   :members: convert_query
+   :exclude-members: __init__, generate, build, generate_train_sql, generate_validate_sql, generate_predict_sql, auto_generate_train, _build_select_sql, _expr_to_sql, _group_columns_by_table, _split_where_by_table, _extract_and_conditions, _extract_table_from_expr
    :no-inherited-members:
    :show-inheritance:
 
 Result Classes
 ~~~~~~~~~~~~~~
 
 .. autoclass:: tlsql.tlsql.sql_generator.ConversionResult
-   :no-members:
+   :members: predict, train, validate
+   :no-inherited-members:
+   :show-inheritance:
+   :noindex:
+
+.. autoclass:: tlsql.tlsql.sql_generator.StatementResult
+   :members: sql, get_sql, format_sql_list, is_predict, is_train, is_validate
    :no-inherited-members:
    :show-inheritance:
    :noindex:

tlsql/__init__.py

@@ -34,7 +34,7 @@
     Statement,
 )
 from .exceptions import TLSQLError, LexerError, ParseError, GenerationError
-from .sql_generator import SQLGenerator, GeneratedSQL, ConversionResult
+from .sql_generator import SQLGenerator, GeneratedSQL, ConversionResult, StatementResult
 from typing import Optional
 
 
@@ -47,7 +47,9 @@ def convert(predict_query: str, train_query: Optional[str] = None, validate_quer
         validate_query: VALIDATE TLSQL statement (optional).
 
     Returns:
-        ConversionResult: Contains predict_result, train_result, and validate_result.
+        ConversionResult: Contains predict_result (StatementResult), train_result (StatementResult), 
+        and validate_result (Optional[StatementResult]). Use shortcut properties result.predict, 
+        result.train, and result.validate to access individual statement results.
     """
     import sys
     parent_module = sys.modules.get('tlsql')
@@ -97,6 +99,7 @@ def convert(predict_query: str, train_query: Optional[str] = None, validate_quer
     # SQL generator results
     "GeneratedSQL",
     "ConversionResult",
+    "StatementResult",
     # Top-level API
     "convert",
 ]