https://github.com/consensys/python-solidity-parser

An experimental Solidity parser for Python built on top of a robust ANTLR4 grammar 📚
https://github.com/consensys/python-solidity-parser

antlr parser python python3 solidity

Last synced: 3 days ago
JSON representation

An experimental Solidity parser for Python built on top of a robust ANTLR4 grammar 📚

• Host: GitHub
• URL: https://github.com/consensys/python-solidity-parser
• Owner: Consensys
• Created: 2019-03-05T20:39:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T13:23:30.000Z (3 months ago)
• Last Synced: 2024-09-21T12:52:33.964Z (12 days ago)
• Topics: antlr, parser, python, python3, solidity
• Language: Python
• Homepage: https://pypi.org/project/solidity-parser/
• Size: 229 KB
• Stars: 141
• Watchers: 18
• Forks: 37
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# python-solidity-parser

An experimental Solidity parser for Python built on top of a robust ANTLR4 grammar.

**ⓘ** This is a **python3** port of the [javascript antlr parser](https://github.com/federicobond/solidity-parser-antlr) maintained by [@federicobond](https://github.com/federicobond/). Interfaces are intentionally following the javascript implementation and are therefore not pep8 compliant.

## Install

```

#> pip3 install solidity_parser

#> python3 -m solidity_parser     # print parse tree or sourceUnit outline

```

## HowTo

```python

import sys

import pprint

from solidity_parser import parser

sourceUnit = parser.parse_file(sys.argv[1], loc=False) # loc=True -> add location information to ast nodes

pprint.pprint(sourceUnit)  

# see output below

```

output:

````

{'type': 'SourceUnit',

 'children': [{'type': 'PragmaDirective',

               'name': 'solidity',

               'value': '^0.4.22'},

              {'type': 'ContractDefinition'},

               'baseContracts': [],

               'kind': 'contract',

               'name': 'SimpleAuction',

               'subNodes': [{'initialValue': None,

                             'type': 'StateVariableDeclaration',

                             'variables': [{'expression': None,

                                            'isDeclaredConst': False,

                                            'isIndexed': False,

                                            'isStateVar': True,

                                            'name': 'beneficiary',

                                            'type': 'VariableDeclaration',

                                            'typeName': {'name': 'address',

                                                         'type': 'ElementaryTypeName'},

                                            'visibility': 'public'}]},

...

````

### Nodes

Parse-tree nodes can be accessed both like dictionaries or via object attributes. Nodes always carry a `type` field to hint the type of AST node. The start node is always of type `sourceUnit`.

## Accessing AST items in an Object Oriented fashion

```python

# ... continuing from previous snippet

# subparse into objects for nicer interfaces:

# create a nested object structure from AST

sourceUnitObject = parser.objectify(sourceUnit)

# access imports, contracts, functions, ...  (see outline example in __main__.py)

sourceUnitObject.imports  # []

sourceUnitObject.pragmas  # []

sourceUnitObject.contracts.keys()  # get all contract names

sourceUnitObject.contracts["contractName"].functions.keys()  # get all functions in contract: "contractName"

sourceUnitObject.contracts["contractName"].functions["myFunction"].visibility  # get "myFunction"s visibility (or stateMutability)

```

## Generate the parser

Update the grammar in `./solidity-antlr4/Solidity.g4` and run the antlr generator script to create the parser classes in `solidity_parser/solidity_antlr4`.

```

#> bash script/antlr4.sh

```