A lexer and tokenizer for grammar files as defined by TextMate and used in VSCode, implemented in Python.
Project description
textmate-grammar-python
A lexer and tokenizer for grammar files as defined by TextMate and used in VSCode, implemented in Python.
Textmate grammars are made for vscode-texmate, allowing for syntax highlighting in VSCode after tokenization. This presents textmate-grammar-python with a large list of potentially supported languages.
Usage
Install the module with:
pip install textmate-grammar-python
Before tokenization is possible, a LanguageParser
needs to be initialized using a loaded grammar.
from textmate_grammar.parsers.matlab import MatlabParser
parser = MatlabParser()
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 in 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']]]
Information
- For further information, please checkout the documentation.
- To setup an environment for development, see CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
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.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3f28830d7d556bead94b575167f4a34892b6c5f6b39138efa2760130a3a4033 |
|
MD5 | 459e742ae8d6ce2e2a14017747420c66 |
|
BLAKE2b-256 | 67af5f61f0c940a736f2fc0327efe128bbb39502adff396ec71bc20b7d4b37b4 |
Hashes for textmate_grammar_python-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff33d9171e9439b42d9fce02d6dc1fd0fc02a89adb2f17e566794a2ac06b3416 |
|
MD5 | 5fba5934dddaf03037916849b50cd785 |
|
BLAKE2b-256 | afc5cabd8ca2a367648a3f8503261e26e5eec711639a486d82e72914424a5d6f |