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.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fdcd430219d2a28971399fdf636f896ff32e9df81a7cbecda3b7f0a5a458df5 |
|
MD5 | e048737c8635566cc4781cc1c0586bd9 |
|
BLAKE2b-256 | 24b2fcf0e6ddb68632d9583d6a47c742df0bb3c824ddf588fac931b897a9ad1a |
Close
Hashes for tree_sitter_type_provider-2.1.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36d4037851748b59d603a6b6099272469c70f04e312116b315ee7c86d583b5d5 |
|
MD5 | 82c4ca5e56ac4b8cd2d6445e2dbdeb2f |
|
BLAKE2b-256 | 70e92bc82a0e829896a516d9b7d1ec91eab72ea4b8889296567ded4105f6a8f8 |