An interpreter for grammar files as defined by TextMate and used in VSCode, implemented in Python. TextMate grammars use the oniguruma dialect (https://github.com/kkos/oniguruma). Supports loading grammar files from JSON, PLIST, or YAML format.
Project description
textmate-grammar-python
An interpreter for grammar files as defined by TextMate and used in VSCode, implemented in Python. TextMate grammars use the oniguruma dialect (https://github.com/kkos/oniguruma). Supports loading grammar files from JSON, PLIST, or YAML format.
Usage
Install the module using pip install textmate-grammar-python
.
Before tokenization is possible, a LanguageParser
needs to be initialized using a loaded grammar.
from textmate_grammar.language import LanguageParser
from textmate_grammar.grammars import matlab
parser = LanguageParser(matlab.GRAMMAR)
After this, one can either choose to call parser.parsing_string
to parse a input string directly, or call parser.parse_file
with the path to the appropiate source file as the first argument, such as the the example example.py
.
The parsed element
object can be displayed directly by calling the print
method. By default the element is printed as an element tree in a dictionary format.
>>> element = parser.parse_string("value = num2str(10);")
>>> element.print()
{'token': 'source.matlab',
'children': [{'token': 'meta.assignment.variable.single.matlab',
'children': [{'token': 'variable.other.readwrite.matlab', 'content': 'value'}]},
{'token': 'keyword.operator.assignment.matlab', 'content': '='},
{'token': 'meta.function-call.parens.matlab',
'begin': [{'token': 'entity.name.function.matlab', 'content': 'num2str'},
{'token': 'punctuation.section.parens.begin.matlab', 'content': '('}],
'end': [{'token': 'punctuation.section.parens.end.matlab', 'content': ')'}],
'children': [{'token': 'constant.numeric.decimal.matlab', 'content': '10'}]},
{'token': 'punctuation.terminator.semicolon.matlab', 'content': ';'}]}
Alternatively, with the keyword argument flatten
the element is displayed as a list per unique token. Here the first item in the list is the starting position (line, column) of the unique tokenized element.
>>> element.print(flatten=True)
[[(0, 0), 'value', ['source.matlab', 'meta.assignment.variable.single.matlab', 'variable.other.readwrite.matlab']],
[(0, 5), ' ', ['source.matlab']],
[(0, 6), '=', ['source.matlab', 'keyword.operator.assignment.matlab']],
[(0, 7), ' ', ['source.matlab']],
[(0, 8), 'num2str', ['source.matlab', 'meta.function-call.parens.matlab', 'entity.name.function.matlab']],
[(0, 15), '(', ['source.matlab', 'meta.function-call.parens.matlab', 'punctuation.section.parens.begin.matlab']],
[(0, 16), '10', ['source.matlab', 'meta.function-call.parens.matlab', 'constant.numeric.decimal.matlab']],
[(0, 18), ')', ['source.matlab', 'meta.function-call.parens.matlab', 'punctuation.section.parens.end.matlab']],
[(0, 19), ';', ['source.matlab', 'punctuation.terminator.semicolon.matlab']]]
Supported Languages
TODO
- Implement Begin/While pattern, required for other grammars.
Sources
Development
Install the repository after cloning with poetry
> pip install poetry
> cd textmate-grammar-python
> poetry install
Run unit tests
> tox run
Run regression testing against vscode-textmate (will install npm and required packages)
> tox run -e regression
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for textmate_grammar_python-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 990bbb9fe4e66f4ecc003857dbc0470dd708318abf8c7810e894934634410d4e |
|
MD5 | cbf5b73adfbef0f56f94e799bb0af0b4 |
|
BLAKE2b-256 | cc5f3df33edb0cba17df38876d1d528d73374bbef6fe4a254eb4a2029c20a3c1 |
Hashes for textmate_grammar_python-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3212232b8d82128343942d6032373021dab717efa0ffb4425b5a603a244236c9 |
|
MD5 | b37c14954f75fb5349a8b27327568991 |
|
BLAKE2b-256 | 7d84929fa9a3adbdd36a334d0f745dc1cb679121f8dfc4b6394b2f92abe68714 |