Type providers for tree-sitter in Python
Reason this release was yanked:
Breaking changes from tree-sitter.
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: 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
@dataclass
class JsArray(tstp.Node):
text: str
type_name: str
start_position: tstp.Point
end_position: tstp.Point
children: list[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: 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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b0d2141dd2a44fe0b10b83321a81314a6d34e14a0624d72e4e83ba05ed764e6 |
|
MD5 | 5e702004c76de7c4854b2846e101256a |
|
BLAKE2b-256 | 251b8168ff813e9ee2bebd2797a54ab80d52b7c39b48b5d560d43e3d36ca704e |
Close
Hashes for tree_sitter_type_provider-2.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb5d6962135a61e991d67317ff17e16c3e5033c35cd832f163b28279f844b59e |
|
MD5 | 191ab3f7e98d0360c8f7a78719fd101c |
|
BLAKE2b-256 | 9def237bd3aec50856faa7b2d43bd8a1507c684fbcebb7b2e24fa0d170e313f0 |