Python库 | antlr4-vba-parser-0.0.1.tar.gz

# antlr4-vba-parser Navigate antlr VBA Parse Trees in python. <!--lint disable no-inline-padding--> [](https://github.com/Liam-Deacon/antlr4-vba-parser/actions?query=workflow%3A"Python+CI") [](https://pypi.org/pypi/antlr4-vba-parser/) [](https://pypi.org/pypi/antlr4-vba-parser/) [](https://pypi.org/pypi/antlr4-vba-parser/) [](https://pypi.org/pypi/antlr4-vba-parser/) [](https://coveralls.io/github/Liam-Deacon/antlr4-vba-parser?branch=master) [](https://codecov.io/gh/Liam-Deacon/antlr4-vba-parser) [](https://www.codacy.com/gh/Liam-Deacon/antlr4-vba-parser?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Liam-Deacon/antlr4-vba-parser&amp;utm_campaign=Badge_Grade) [](https://www.codefactor.io/repository/github/Liam-Deacon/antlr4-vba-parser)  [](https://ko-fi.com/lightbytes)  [](https://colab.research.google.com/github/Liam-Deacon/antlr4-vba-parser) [](https://mybinder.org/v2/gh/Liam-Deacon/antlr4-vba-parser/master?urlpath=lab) <!--lint enable no-inline-padding--> This python package provides an interface to the the antlr4 tooling and allows parsing and lexing of VBA grammar. ```python >>> from antlr4_vba_parser.vba_parser import Antlr4VbaParser >>> parsed = Antlr4VbaParser(""" ... SUB square(x) ... DIM y: REM Some comment ... y = x * x ' same as x**2 ... END SUB ... """) # also accepts a filepath >>> from pprint import pprint >>> pprint(parsed) ('(startRule (module (endOfLine \\n) (moduleBody (moduleBodyElement (subStmt ' 'SUB (ambiguousIdentifier square) (argList ( (arg (ambiguousIdentifier x)) ' ')) (endOfStatement (endOfLine \\n )) (block (blockStmt (variableStmt DIM ' '(variableListStmt (variableSubStmt (ambiguousIdentifier y))))) ' '(endOfStatement : (endOfLine (remComment REM Some comment)) (endOfLine ' '\\n )) (blockStmt (letStmt (implicitCallStmt_InStmt ' '(iCS_S_VariableOrProcedureCall (ambiguousIdentifier y))) = (valueStmt ' '(valueStmt (implicitCallStmt_InStmt (iCS_S_VariableOrProcedureCall ' '(ambiguousIdentifier x)))) * (valueStmt (implicitCallStmt_InStmt ' '(iCS_S_VariableOrProcedureCall (ambiguousIdentifier x))))))) (endOfStatement ' "(endOfLine (comment ' same as x**2)) (endOfLine \\n))) END SUB)) " '(endOfLine \\n))) <EOF>)') ``` ## Installation `antlr4_vba_parser` itself is a pure python package, but depends on a `java` runtime in order to run. The ANTLR4 jar needed to perform the parsing/lexing is included in the package distribution and is bundled from third-party sources at the time of packaging with `setup.py build`. To install, simply try: ```bash pip install antlr4_vba_parser ``` ## Development To set up a development environment, first create either a new virtual or conda environment before activating it and then run the following: ```bash git clone https://github.com/Liam-Deacon/antlr4-vba-parser cd antlr4-vba-parser pip install -r requirements-dev.txt requirements-test.txt -r requirements.txt pip install -e . ``` This will install the package in development mode. Note that is you have forked the repo then change the URL as appropriate. ## Documentation Documentation can be found within the `docs/` directory. This project uses sphinx to autogenerate API documentation by scraping python docstrings. To generate the HTML documentation, simply do the following: ```bash cd docs make html ``` ## Contribution Guidelines <!--lint disable list-item-bullet-indent --> Contributions are extremely welcome and highly encouraged. To help with consistency please can the following areas be considered before submitting a PR for review: - Use `autopep8 -a -a -i -r .` to run over any modified files to ensure basic pep8 conformance, allowing the code to be read in a style expected for most python projects. - New or changed functionality should be tested, running `pytest` should - Try to document any new or changed functionality. Note: this project uses [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) for it's docstring documentation style. <!--lint enable list-item-bullet-indent --> ## License Released under the BSD license. ## TODO This package is mostly a proof of concept and as such there are a number of areas to add to, fix and improve. - Create listener(s) capable of capturing contextual information and creating a JSON-friendly dictionary output. - Produce simple script turns the above into a command line tool. - Contribute to [`oletools.vba`](https://