Skip to content

wake.compiler.build_data_model module #

CompilationUnitBuildInfo class #

Bases: BuildInfoModel

Holds all compilation errors and warnings that occurred during compilation of a single compilation unit. Some errors and warnings may not be associated with any specific source code location. Because of incremental compilation, it is important to keep track of all errors and warnings that occurred during compilation of a compilation unit with a given hash.

Attributes:

Name Type Description
errors List[SolcOutputError]

List of compilation warnings and errors that occurred during compilation of the compilation unit.
Source code in wake/compiler/build_data_model.py 
24
25
26
27
28
29
30
31
32
33
34
class CompilationUnitBuildInfo(BuildInfoModel):
    """
    Holds all compilation errors and warnings that occurred during compilation of a single compilation unit.
    Some errors and warnings may not be associated with any specific source code location.
    Because of incremental compilation, it is important to keep track of all errors and warnings that occurred during compilation of a compilation unit with a given hash.

    Attributes:
        errors: List of compilation warnings and errors that occurred during compilation of the compilation unit.
    """

    errors: List[SolcOutputError]

HexBytes class #

Bases: bytes

Workaround for pydantic bytes JSON encode bug

Source code in wake/compiler/build_data_model.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class HexBytes(bytes):
    """
    Workaround for pydantic bytes [JSON encode bug](https://github.com/pydantic/pydantic/issues/3756)
    """

    @classmethod
    def __get_validators__(cls):
        yield cls.validate

    @classmethod
    def validate(cls, v):
        if isinstance(v, bytes):
            return v
        elif isinstance(v, bytearray):
            return bytes(v)
        elif isinstance(v, str):
            return bytes.fromhex(v)
        raise pydantic.errors.BytesError()

ProjectBuild class #

Class holding a single project build.

Source code in wake/compiler/build_data_model.py 
 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class ProjectBuild:
    """
    Class holding a single project build.
    """

    _interval_trees: Dict[Path, IntervalTree]
    _reference_resolver: ReferenceResolver
    _source_units: Dict[Path, SourceUnit]

    def __init__(
        self,
        interval_trees: Dict[Path, IntervalTree],
        reference_resolver: ReferenceResolver,
        source_units: Dict[Path, SourceUnit],
    ):
        self._interval_trees = interval_trees
        self._reference_resolver = reference_resolver
        self._source_units = source_units

    @property
    def interval_trees(self) -> Dict[Path, IntervalTree]:
        """
        Returns:
            Mapping of source file paths to [interval trees](https://github.com/chaimleib/intervaltree) that can be used to query IR nodes by byte offsets in the source code.
        """
        return MappingProxyType(
            self._interval_trees
        )  # pyright: ignore reportGeneralTypeIssues

    @property
    def reference_resolver(self) -> ReferenceResolver:
        """
        Returns:
            Reference resolver responsible for resolving AST node IDs to IR nodes. Useful especially for resolving references across different compilation units.
        """
        return self._reference_resolver

    @property
    def source_units(self) -> Dict[Path, SourceUnit]:
        """
        Returns:
            Mapping of source file paths to top-level [SourceUnit][wake.ir.meta.source_unit.SourceUnit] IR nodes.
        """
        return MappingProxyType(
            self._source_units
        )  # pyright: ignore reportGeneralTypeIssues

interval_trees: Dict[Path, IntervalTree] property #

Returns:

Type Description
Dict[Path, IntervalTree]

Mapping of source file paths to interval trees that can be used to query IR nodes by byte offsets in the source code.

reference_resolver: ReferenceResolver property #

Returns:

Type Description
ReferenceResolver

Reference resolver responsible for resolving AST node IDs to IR nodes. Useful especially for resolving references across different compilation units.

source_units: Dict[Path, SourceUnit] property #

Returns:

Type Description
Dict[Path, SourceUnit]

Mapping of source file paths to top-level SourceUnit IR nodes.

ProjectBuildInfo class #

Bases: BuildInfoModel

Attributes:

Name Type Description
compilation_units Dict[str, CompilationUnitBuildInfo]

Mapping of compilation unit hex-encoded hashes to compilation unit build info.
source_units_info Dict[str, SourceUnitInfo]

Mapping of source unit names to source unit info.
allow_paths FrozenSet[Path]

Compilation allow_paths used during compilation.
exclude_paths FrozenSet[Path]

Compilation exclude_paths used during compilation.
include_paths FrozenSet[Path]

Compilation include_paths used during compilation.
settings SolcInputSettings

solc input settings used during compilation.
target_solidity_version Optional[SolidityVersion]

Solidity target_version used during compilation, if any.
wake_version str

eth-wake version used during compilation.
incremental bool

Whether the compilation was performed in incremental mode.
Source code in wake/compiler/build_data_model.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class ProjectBuildInfo(BuildInfoModel):
    """
    Attributes:
        compilation_units: Mapping of compilation unit hex-encoded hashes to compilation unit build info.
        source_units_info: Mapping of source unit names to source unit info.
        allow_paths: Compilation [allow_paths][wake.config.data_model.SolcConfig.allow_paths] used during compilation.
        exclude_paths: Compilation [exclude_paths][wake.config.data_model.SolcConfig.exclude_paths] used during compilation.
        include_paths: Compilation [include_paths][wake.config.data_model.SolcConfig.include_paths] used during compilation.
        settings: solc input settings used during compilation.
        target_solidity_version: Solidity [target_version][wake.config.data_model.SolcConfig.target_version] used during compilation, if any.
        wake_version: `eth-wake` version used during compilation.
        incremental: Whether the compilation was performed in incremental mode.
    """

    compilation_units: Dict[str, CompilationUnitBuildInfo]
    source_units_info: Dict[str, SourceUnitInfo]
    allow_paths: FrozenSet[Path]
    exclude_paths: FrozenSet[Path]
    include_paths: FrozenSet[Path]
    settings: SolcInputSettings
    target_solidity_version: Optional[SolidityVersion]
    wake_version: str
    incremental: bool

SourceUnitInfo class #

Bases: NamedTuple

Attributes:

Name Type Description
fs_path Path

Path to the source unit.
blake2b_hash HexBytes

256-bit blake2b hash of the source unit contents.
Source code in wake/compiler/build_data_model.py 
57
58
59
60
61
62
63
64
65
class SourceUnitInfo(NamedTuple):
    """
    Attributes:
        fs_path: Path to the source unit.
        blake2b_hash: 256-bit blake2b hash of the source unit contents.
    """

    fs_path: Path
    blake2b_hash: HexBytes