Add generator expr support

Author: Zehen-249

libs/astx-transpilers/src/astx_transpilers/python_string.py

@@ -699,3 +699,15 @@ def visit(self, node: astx.LiteralDict) -> str:
             for key, value in node.elements.items()
         )
         return f"{{{items_code}}}"
+
+    @dispatch  # type: ignore[no-redef]
+    def visit(self, node: astx.GeneratorExpr) -> str:
+        """Handle GeneratorExpr nodes."""
+        ret_str = (
+            f"{self.visit(node.element)} for {self.visit(node.target)}"
+            f" in {self.visit(node.iterable)}"
+        )
+        if node.conditions:
+            for condition in node.conditions:
+                ret_str += f" if {self.visit(condition)}"
+        return f"({ret_str})"

libs/astx-transpilers/tests/test_python.py

@@ -1424,3 +1424,44 @@ def test_transpiler_literal_dict() -> None:
         1: 10,
         2: 20,
     }, f"Expected '{expected_code}', but got '{generated_code}'"
+
+
+def test_transpiler_generator_expr() -> None:
+    """Test astx.GeneratorExpr."""
+    gen_expr = astx.GeneratorExpr(
+        element=astx.Variable("x"),
+        target=astx.BinaryOp(
+            op_code="+", lhs=astx.Variable("x"), rhs=astx.Variable("x")
+        ),
+        iterable=astx.Identifier("range(10)"),
+        conditions=[
+            astx.BinaryOp(
+                op_code=">", lhs=astx.Variable("x"), rhs=astx.LiteralInt32(3)
+            ),
+            astx.BinaryOp(
+                op_code="<", lhs=astx.Variable("x"), rhs=astx.LiteralInt32(7)
+            ),
+        ],
+    )
+    generated_code = transpiler.visit(gen_expr)
+    expected_code = "(x for (x + x) in range(10) if (x > 3) if (x < 7))"
+    assert generated_code == expected_code, (
+        f"Expected '{expected_code}', but got '{generated_code}'"
+    )
+
+
+def test_transpiler_generator_expr_no_conditions() -> None:
+    """Test astx.GeneratorExpr with no conditions."""
+    gen_expr = astx.GeneratorExpr(
+        element=astx.Variable("x"),
+        target=astx.BinaryOp(
+            op_code="+", lhs=astx.Variable("x"), rhs=astx.Variable("x")
+        ),
+        iterable=astx.Identifier("range(10)"),
+    )
+
+    generated_code = transpiler.visit(gen_expr)
+    expected_code = "(x for (x + x) in range(10))"
+    assert generated_code == expected_code, (
+        f"Expected '{expected_code}', but got '{generated_code}'"
+    )

libs/astx/src/astx/__init__.py

@@ -67,6 +67,7 @@
     ForCountLoopStmt,
     ForRangeLoopExpr,
     ForRangeLoopStmt,
+    GeneratorExpr,
     GotoStmt,
     IfExpr,
     IfStmt,
@@ -249,6 +250,7 @@ def get_version() -> str:
     "FunctionDef",
     "FunctionPrototype",
     "FunctionReturn",
+    "GeneratorExpr",
     "GotoStmt",
     "Identifier",
     "IfExpr",

libs/astx/src/astx/base.py

@@ -134,6 +134,7 @@ class ASTKind(Enum):
     WithStmtKind = -512
     AsyncRangeLoopStmtKind = -513
     AsyncRangeLoopExprKind = -514
+    GeneratorExprKind = -516
 
     # data types
     NullDTKind = -600

libs/astx/src/astx/flows.py

@@ -691,3 +691,61 @@ def get_struct(self, simplified: bool = False) -> ReprStruct:
         key = f"GOTO-STMT[{self.label.value}]"
         value: DictDataTypesStruct = {}
         return self._prepare_struct(key, value, simplified)
+
+
+@public
+@typechecked
+class GeneratorExpr(Expr):
+    """AST class for generator expressions."""
+
+    element: Expr
+    target: Expr
+    iterable: Expr
+    conditions: list[Expr]
+
+    def __init__(
+        self,
+        element: Expr,
+        target: Expr,
+        iterable: Expr,
+        conditions: Optional[list[Expr]] = None,
+        loc: SourceLocation = NO_SOURCE_LOCATION,
+        parent: Optional[ASTNodes] = None,
+    ) -> None:
+        """Initialize the GeneratorExpr instance."""
+        super().__init__(loc=loc, parent=parent)
+        self.element = element
+        self.target = target
+        self.iterable = iterable
+        self.conditions = conditions if conditions is not None else []
+        self.kind = ASTKind.GeneratorExprKind
+
+    def __str__(self) -> str:
+        """Return a string representation of the object."""
+        ret_str = (
+            f"GeneratorExpr[element={self.element}, target={self.target},"
+            f" iterable={self.iterable},"
+        )
+        if self.conditions is not None:
+            cons_list = []
+            for cond in self.conditions:
+                cons_list.append(str(cond))
+            ret_str += f" conditions={(cons_list)}]"
+        return ret_str
+
+    def get_struct(self, simplified: bool = False) -> ReprStruct:
+        """Return the AST structure of the object."""
+        key = f"GENERATOR-EXPR#{id(self)}" if simplified else "GENERATOR-EXPR"
+        value: ReprStruct = {
+            "element": self.element.get_struct(simplified),
+            "target": self.target.get_struct(simplified),
+            "iterable": self.iterable.get_struct(simplified),
+            "conditions": cast(
+                ReprStruct,
+                {
+                    str(cond): cond.get_struct(simplified)
+                    for cond in self.conditions
+                },
+            ),
+        }
+        return self._prepare_struct(key, value, simplified)

libs/astx/tests/test_flows.py

@@ -342,3 +342,26 @@ def test_comprehension() -> None:
     assert str(comp) == expected_str
     assert comp.get_struct(simplified=True)
     assert comp.get_struct(simplified=False)
+
+
+def test_generator_expr() -> None:
+    """Test `GeneratorExpr` class."""
+    gen_expr = astx.GeneratorExpr(
+        element=astx.Variable("x"),
+        target=astx.BinaryOp(
+            op_code="+", lhs=astx.Variable("x"), rhs=astx.Variable("x")
+        ),
+        iterable=astx.Identifier("range(10)"),
+        conditions=[
+            astx.BinaryOp(
+                op_code=">", lhs=astx.Variable("x"), rhs=astx.LiteralInt32(3)
+            ),
+            astx.BinaryOp(
+                op_code="<", lhs=astx.Variable("x"), rhs=astx.LiteralInt32(7)
+            ),
+        ],
+    )
+    assert str(gen_expr)
+    assert gen_expr.get_struct()
+    assert gen_expr.get_struct(simplified=True)
+    visualize(gen_expr.get_struct())