Skip to content

Inheritance specifier

woke.ast.ir.meta.inheritance_specifier module #

InheritanceSpecifier class #

Bases: SolidityAbc

Example

A(0x1234567890123456789012345678901234567890) in the following code: 

contract A {
    address immutable owner;

    constructor(address _owner) {
        owner = _owner;
    }
}

contract B is A(0x1234567890123456789012345678901234567890) {}

Source code in woke/ast/ir/meta/inheritance_specifier.py 
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
class InheritanceSpecifier(SolidityAbc):
    """
    !!! example
        `:::solidity A(0x1234567890123456789012345678901234567890)` in the following code:
        ```solidity
        contract A {
            address immutable owner;

            constructor(address _owner) {
                owner = _owner;
            }
        }

        contract B is A(0x1234567890123456789012345678901234567890) {}
        ```
    """

    _ast_node: SolcInheritanceSpecifier
    _parent: ContractDefinition

    _base_name: Union[IdentifierPath, UserDefinedTypeName]
    _arguments: Optional[List[ExpressionAbc]]

    def __init__(
        self,
        init: IrInitTuple,
        inheritance_specifier: SolcInheritanceSpecifier,
        parent: ContractDefinition,
    ):
        super().__init__(init, inheritance_specifier, parent)

        if isinstance(inheritance_specifier.base_name, SolcIdentifierPath):
            self._base_name = IdentifierPath(
                init, inheritance_specifier.base_name, self
            )
        elif isinstance(inheritance_specifier.base_name, SolcUserDefinedTypeName):
            self._base_name = UserDefinedTypeName(
                init, inheritance_specifier.base_name, self
            )

        if inheritance_specifier.arguments is None:
            self._arguments = None
        else:
            self._arguments = []
            for argument in inheritance_specifier.arguments:
                self._arguments.append(ExpressionAbc.from_ast(init, argument, self))

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

    @property
    def parent(self) -> ContractDefinition:
        """
        Returns:
            Parent IR node.
        """
        return self._parent

    @property
    def base_name(self) -> Union[IdentifierPath, UserDefinedTypeName]:
        """
        The returned IR node holds a reference to the base contract definition ([ContractDefinition][woke.ast.ir.declaration.contract_definition.ContractDefinition]).
        !!! example
            `A` in the following code:
            ```solidity
            contract B is A(0x1234567890123456789012345678901234567890) {}
            ```
        Returns:
            IR node representing the base contract name.
        """
        return self._base_name

    @property
    def arguments(self) -> Optional[List[ExpressionAbc]]:
        """
        !!! warning
            Is `None` when there are no curly braces after the inheritance specifier name.
            ```solidity
            contract B is A {}
            ```

            Is an empty list when there are curly braces but no arguments.
            ```solidity
            contract B is A() {}
            ```
        !!! example
            `:::solidity 0x1234567890123456789012345678901234567890` in the following code:
            ```solidity
            contract B is A(0x1234567890123456789012345678901234567890) {}
            ```
        Returns:
            Arguments of the base constructor call, if provided.
        """
        return self._arguments

arguments: Optional[List[ExpressionAbc]] property #

Warning

Is None when there are no curly braces after the inheritance specifier name. 

contract B is A {}

Is an empty list when there are curly braces but no arguments. 

contract B is A() {}

Example

0x1234567890123456789012345678901234567890 in the following code: 

contract B is A(0x1234567890123456789012345678901234567890) {}

Returns:

Type Description
Optional[List[ExpressionAbc]]

Arguments of the base constructor call, if provided.

base_name: Union[IdentifierPath, UserDefinedTypeName] property #

The returned IR node holds a reference to the base contract definition (ContractDefinition).

Example

A in the following code: 

contract B is A(0x1234567890123456789012345678901234567890) {}

Returns:

Type Description
Union[IdentifierPath, UserDefinedTypeName]

IR node representing the base contract name.

parent: ContractDefinition property #

Returns:

Type Description
ContractDefinition

Parent IR node.