Add Dict Comprehension support

Author: Zehen-249

docs/tutorials/dict_comprehension.ipynb

@@ -699,3 +699,16 @@ 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.DictComprehension) -> str:
+        """Handle DictComprehension nodes."""
+        ret_str = (
+            f"{{{self.visit(node.key)}: {self.visit(node.value)} "
+            f" for {self.visit(node.iterable)}"
+        )
+        if node.conditions is not None:
+            for cond in node.conditions:
+                ret_str += f" if {self.visit(cond)}"
+        ret_str += "}"
+        return ret_str

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

@@ -1424,3 +1424,21 @@ def test_transpiler_literal_dict() -> None:
         1: 10,
         2: 20,
     }, f"Expected '{expected_code}', but got '{generated_code}'"
+
+
+def test_transpiler_dict_comprehension() -> None:
+    """Test astx.DictComprehension."""
+    dict_comp = astx.DictComprehension(
+        key=astx.LiteralString("x"),
+        value=astx.LiteralString("x*x"),
+        iterable=astx.LiteralString("range(10)"),
+        conditions=[
+            astx.LiteralString("x > 5"),
+            astx.LiteralString("x < 7"),
+        ],
+    )
+    generated_code = transpiler.visit(dict_comp)
+    expected_code = "{x: x*x for x in range(10) if x > 5 and x < 7}"
+    assert generated_code == expected_code, (
+        f"Expected '{expected_code}', but got '{generated_code}'"
+    )

libs/astx-transpilers/tests/test_python.py

@@ -63,6 +63,7 @@
     AsyncForRangeLoopExpr,
     AsyncForRangeLoopStmt,
     CaseStmt,
+    DictComprehension,
     ForCountLoopExpr,
     ForCountLoopStmt,
     ForRangeLoopExpr,
@@ -230,6 +231,7 @@ def get_version() -> str:
     "Date",
     "DateTime",
     "DeleteStmt",
+    "DictComprehension",
     "DictType",
     "EnumDeclStmt",
     "ExceptionHandlerStmt",

libs/astx/src/astx/__init__.py

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

libs/astx/src/astx/base.py

@@ -18,6 +18,9 @@
     StatementType,
 )
 from astx.blocks import Block
+from astx.callables import (
+    Comprehension,
+)
 from astx.tools.typing import typechecked
 from astx.variables import InlineVariableDeclaration
 
@@ -691,3 +694,60 @@ 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 DictComprehension(Comprehension):
+    """AST node for dictionary comprehensions."""
+
+    key: Expr
+    value: Expr
+
+    def __init__(
+        self,
+        key: Expr,
+        value: Expr,
+        iterable: Expr,
+        conditions: Optional[list[Expr]] = None,
+        is_async: bool = False,
+        loc: SourceLocation = NO_SOURCE_LOCATION,
+        parent: Optional[ASTNodes] = None,
+    ) -> None:
+        super().__init__(
+            target=key,
+            iterable=iterable,
+            conditions=conditions,
+            is_async=is_async,
+            loc=loc,
+            parent=parent,
+        )
+        self.key = key
+        self.value = value
+        self.kind = ASTKind.DictComprehensionKind
+
+    def __str__(self) -> str:
+        """Return a string representation of the object."""
+        ret_str = (
+            f"{{{self.key}: {self.value} for {self.key} in {self.iterable}"
+        )
+        if self.conditions is not None:
+            for cond in self.conditions:
+                ret_str += f" if {cond}"
+        ret_str += "}"
+        return ret_str
+
+    def get_struct(self, simplified: bool = False) -> ReprStruct:
+        """Return the AST structure of the object."""
+        value: ReprStruct = {
+            "key": self.key.get_struct(simplified),
+            "value": self.value.get_struct(simplified),
+            "iterable": self.iterable.get_struct(simplified),
+            "conditions": cast(
+                ReprStruct,
+                [cond.get_struct(simplified) for cond in self.conditions],
+            ),
+        }
+
+        key = "DICT-COMPREHENSION"
+        return self._prepare_struct(key, value, simplified)

libs/astx/src/astx/flows.py

@@ -9,6 +9,7 @@
     AsyncForRangeLoopExpr,
     AsyncForRangeLoopStmt,
     CaseStmt,
+    DictComprehension,
     ForCountLoopExpr,
     ForCountLoopStmt,
     ForRangeLoopExpr,
@@ -342,3 +343,21 @@ def test_comprehension() -> None:
     assert str(comp) == expected_str
     assert comp.get_struct(simplified=True)
     assert comp.get_struct(simplified=False)
+
+
+def test_dict_comprehension() -> None:
+    """Test `DictComprehension` class."""
+    dict_comprehension = DictComprehension(
+        key=LiteralString("x"),
+        value=LiteralString("x*x"),
+        iterable=LiteralString("range(10)"),
+        conditions=[
+            LiteralString("x > 5"),
+            LiteralString("x < 7"),
+        ],
+    )
+
+    assert str(dict_comprehension)
+    assert dict_comprehension.get_struct()
+    assert dict_comprehension.get_struct(simplified=True)
+    visualize(dict_comprehension.get_struct())