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
:
from pathlib import Path
import tree_sitter_type_provider as tstp
node_types_json = 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, as_class_name=as_class_name
)
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 generic visitor and transformer classes:
Result = TypeVar("Result")
class NodeTransformer:
transform(self, node: tstp.Node) -> Result
transform_ERROR(self, *, text: str, type_name: str, start_position: tstp.Point, end_position: tstp.Point, **kwargs: dict[str, Any]) -> Result
transform_JsArray(self, *, text: str, type_name: str, start_position: tstp.Point, end_position: tstp.Point, **kwargs: dict[str, Any]) -> Result
# NOTE: no transform_JsDeclaration: it's not a concrete node type, but a superclass for several node types
transform_JsWhileStatement(self, *, text: str, type_name: str, start_position: tstp.Point, end_position: tstp.Point, **kwargs: dict[str, Any]) -> Result
...
class NodeVisitor:
generic_visit(self, node: tstp.Node) -> None
visit(self, node: tstp.Node) -> None
visit_ERROR(self, node: tstp.Node) -> None
visit_JsArray(self, node: tstp.Node) -> None
# NOTE: no visit_JsDeclaration: it's not a concrete node type, but a superclass for several node types
visit_JsWhileStatement(self, node: tstp.Node) -> None
...
And a function to convert to the AST:
def from_tree_sitter(self, tsnode: ts.Node, 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-1.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17fe078ebf2162ce94548c7daf007791a658a3abefefed47fbba38cd5607e04e |
|
MD5 | 4e17814c6088bcb5379989cda8014806 |
|
BLAKE2b-256 | 7288c7a9498275f690df97f077ac35256458ef2569eca556342af20c51a26395 |
Close
Hashes for tree_sitter_type_provider-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b81552de5cce631bbf5705a2aa1025d4a74c7dcecf68f791dcb3bf02a52ade9 |
|
MD5 | 3dc8f7b4b649fc55b5e86759b728c754 |
|
BLAKE2b-256 | e72c82a25c5588f01e1d6ebd2e66022b01217f96a3cb2f628be9fd382af22a3d |