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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6674dc945013fdc255c43a70a13caf6743cdacea579ff08c3e6c0fde2034f85f |
|
MD5 | f312dc081e300ce5a1f85b3167fd0984 |
|
BLAKE2b-256 | 40a45e919d7649a930e6ba0b01c53dc9a31427a96d9bdc59e331032011486b64 |
Close
Hashes for tree_sitter_type_provider-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b91de6d48045c5e0666ff739487522fb1b9e92cc8fb336dbb3ca6723787054f |
|
MD5 | 07614b1e6604274b80025649fcb333f1 |
|
BLAKE2b-256 | 180161a155075a95640d395aa6ccc9503e5145362cd3c4e0394cc8d7857c93ee |