Type providers for tree-sitter in Python.
Project description
Type Providers for Tree Sitter
Create a type AST from any node-types.json
file, as well as a generic visitor class and a transformer class, and a function to convert to the AST from the tree_sitter.Node
type.
For example, the following code defines a module named tree_sitter_javascript
from tree-sitter-javascript/src/nodes.json
:
import pathlib
import tree_sitter_type_provider as tstp
node_types_json = pathlib.Path("tree-sitter-javascript/src/node-types.json")
node_types = tstp.NodeType.schema().loads(node_types_json.read_text(), many=True)
def as_class_name(node_type_name: str) -> str:
class_name_parts: typing.List[str] = ["Js"]
for part in node_type_name.split("_"):
class_name_parts.append(part.capitalize())
return "".join(class_name_parts)
sys.modules[__name__] = tstp.TreeSitterTypeProvider(
"tree_sitter_javascript",
node_types,
error_as_node=True, # Include ERROR as a node in the AST
as_class_name=as_class_name, # How to convert node types to Python class names
extra=["comment"], # Nodes which are marked as 'extra' in the grammar
)
The module contains a number of dataclasses which represent the AST nodes:
import tree_sitter as ts
import tree_sitter_type_provider as tstp
import typing
@dataclass
class JsArray(tstp.Node):
text: str
type_name: str
start_position: tstp.Point
end_position: tstp.Point
children: typing.List[typing.Union[JsExpression, JsSpreadElement]]
@dataclass
class JsDeclaration(tstp.Node):
text: str
type_name: str
start_position: tstp.Point
end_position: tstp.Point
@dataclass
class JsWhileStatement(tstp.Node):
text: str
type_name: str
start_position: tstp.Point
end_position: tstp.Point
body: JsStatement
condition: JsParenthesizedExpression
...
As well as a function to convert to the AST:
def from_tree_sitter(self, tsvalue: typing.Union[ts.Tree, ts.Node, ts.TreeCursor], *, encoding: str = 'utf-8') -> tstp.Node
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
Close
Hashes for tree_sitter_type_provider-2.1.23.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 340cf2eb8065c95d9d38f88a35395ff1b61969cf9e0549157457509b8966b6fc |
|
MD5 | db286d4fd9e9a1efabd37ad2a0b1aa37 |
|
BLAKE2b-256 | 10054d7a607e994bc339e300e14700f1bc674313fe753ae229fb36e981cb31ba |
Close
Hashes for tree_sitter_type_provider-2.1.23-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 027b3f4a8e3804bedd099965b5db5e3b6b2571b2e7dd560283965506a5b4db23 |
|
MD5 | fcc636a733fb41635ec9cd083e86a18e |
|
BLAKE2b-256 | dfe619eeb7e0e85c0406e484425cdd956c5a6d04fcf1f9070ab4b3e19fb53fe9 |