wake.ir.expressions.tuple_expression module

TupleExpression class

Bases: ExpressionAbc

Represents multiple expressions enclosed in parentheses.

Example

(uint256, uint256) in:

abi.decode(data, (uint256, uint256))

Source code in wake/ir/expressions/tuple_expression.py

class TupleExpression(ExpressionAbc):
    """
    Represents multiple expressions enclosed in parentheses.

    !!! example
        `:::solidity (uint256, uint256)` in:

        ```solidity
        abi.decode(data, (uint256, uint256))
        ```
    """

    _ast_node: SolcTupleExpression
    _parent: weakref.ReferenceType[SolidityAbc]  # TODO: make this more specific

    _components: List[Optional[ExpressionAbc]]
    _is_inline_array: bool

    def __init__(
        self,
        init: IrInitTuple,
        tuple_expression: SolcTupleExpression,
        parent: SolidityAbc,
    ):
        super().__init__(init, tuple_expression, parent)
        self._is_inline_array = tuple_expression.is_inline_array

        self._components = []
        for component in tuple_expression.components:
            if component is None:
                self._components.append(None)
            else:
                self._components.append(ExpressionAbc.from_ast(init, component, self))

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        for component in self._components:
            if component is not None:
                yield from component

    @property
    def parent(self) -> SolidityAbc:
        return super().parent

    @property
    def children(self) -> Iterator[ExpressionAbc]:
        """
        Yields:
            Direct children of this node.
        """
        for component in self._components:
            if component is not None:
                yield component

    @property
    def is_inline_array(self) -> bool:
        """
        !!! example
            Returns `True` for `:::solidity [2, 3, 5, 7, 11, 13]` in the following example:

            ```solidity
            uint8[6] memory primes = [2, 3, 5, 7, 11, 13];
            ```

        Returns:
            `True` if the tuple expression is an inline array, `False` otherwise.
        """
        return self._is_inline_array

    @property
    def components(self) -> Tuple[Optional[ExpressionAbc], ...]:
        """
        !!! example
            A component may be `None` if it is omitted, for example `:::solidity (success, )` in the following code snippet:

            ```solidity
            bool success;
            (success, ) = target.call{gas: 1000}(data);
            ```

        Returns:
            Tuple of expressions enclosed in parentheses in the order they appear in the source code.
        """
        return tuple(self._components)

    @property
    @weak_self_lru_cache(maxsize=2048)
    def is_ref_to_state_variable(self) -> bool:
        return any(
            component.is_ref_to_state_variable
            for component in self._components
            if component is not None
        )

children: Iterator[ExpressionAbc] property

Yields:

Type	Description
ExpressionAbc	Direct children of this node.

components: Tuple[Optional[ExpressionAbc], ...] property

Example

A component may be None if it is omitted, for example (success, ) in the following code snippet:

bool success;
(success, ) = target.call{gas: 1000}(data);

Returns:

Type	Description
Tuple[Optional[ExpressionAbc], ...]	Tuple of expressions enclosed in parentheses in the order they appear in the source code.

is_inline_array: bool property

Example

Returns True for [2, 3, 5, 7, 11, 13] in the following example:

uint8[6] memory primes = [2, 3, 5, 7, 11, 13];

Returns:

Type	Description
bool	True if the tuple expression is an inline array, False otherwise.