ast-grep-py 0.39.7__cp314-cp314-macosx_10_12_x86_64.whl

ast_grep_py/__init__.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+from typing import List, TypedDict,  Literal, Dict, Union, Mapping, Optional
+from .ast_grep_py import SgNode, SgRoot, Pos, Range, Edit, register_dynamic_language
+
+Strictness = Union[Literal["cst"], Literal["smart"], Literal["ast"], Literal["relaxed"], Literal["signature"]]
+
+class Pattern(TypedDict):
+    selector: Optional[str]
+    strictness: Optional[Strictness]
+    context: str
+
+class NthChild(TypedDict):
+    position: int | str
+    ofRule: Rule
+    nth: int
+
+class PosRule(TypedDict):
+    line: int
+    column: int
+
+class RangeRule(TypedDict):
+    start: PosRule
+    end: PosRule
+
+class RuleWithoutNot(TypedDict, total=False):
+    # atomic rule
+    pattern: str | Pattern
+    kind: str
+    regex: str
+    nthChild: int | str | NthChild
+    range: RangeRule
+
+    # relational rule
+    inside: "Relation" # pyright report error if forward reference here?
+    has: Relation
+    precedes: Relation
+    follows: Relation
+
+    # composite rule
+    all: List[Rule]
+    any: List[Rule]
+    # cannot add here due to reserved keyword
+    # not: Rule
+    matches: str
+
+# workaround
+# Python's keyword requires `not` be a special case
+class Rule(RuleWithoutNot, TypedDict("Not", {"not": "Rule"}, total=False)):
+    pass
+
+# Relational Rule Related
+StopBy = Union[Literal["neighbor"], Literal["end"], Rule]
+
+# Relation do NOT inherit from Rule due to pyright bug
+# see tests/test_rule.py
+class Relation(RuleWithoutNot, TypedDict("Not", {"not": "Rule"}, total=False), total=False):
+    stopBy: StopBy
+    field: str
+
+class Config(TypedDict, total=False):
+    rule: Rule
+    constraints: Dict[str, Mapping]
+    utils: Dict[str, Rule]
+    transform: Dict[str, Mapping]
+
+class CustomLang(TypedDict, total=False):
+  library_path: str
+  language_symbol: Optional[str]
+  meta_var_char: Optional[str]
+  expando_char: Optional[str]
+
+__all__ = [
+    "Rule",
+    "Config",
+    "Relation",
+    "Pattern",
+    "NthChild",
+    "SgNode",
+    "SgRoot",
+    "Pos",
+    "Range",
+    "Edit",
+    "register_dynamic_language",
+]

ast_grep_py/ast_grep_py.pyi

@@ -0,0 +1,71 @@
+from typing import List, Optional, overload, Unpack, Dict
+
+from . import Rule, Config, CustomLang
+
+class Pos:
+    line: int
+    column: int
+    index: int
+
+class Range:
+    start: Pos
+    end: Pos
+
+class Edit:
+    start_pos: int
+    end_pos: int
+    inserted_text: str
+
+class SgRoot:
+    def __init__(self, src: str, language: str) -> None: ...
+    def root(self) -> SgNode: ...
+    def filename(self) -> str: ...
+
+class SgNode:
+    # Node Inspection
+    def range(self) -> Range: ...
+    def is_leaf(self) -> bool: ...
+    def is_named(self) -> bool: ...
+    def is_named_leaf(self) -> bool: ...
+    def kind(self) -> str: ...
+    def text(self) -> str: ...
+
+    # Refinement
+    def matches(self, **rule: Unpack[Rule]) -> bool: ...
+    def inside(self, **rule: Unpack[Rule]) -> bool: ...
+    def has(self, **rule: Unpack[Rule]) -> bool: ...
+    def precedes(self, **rule: Unpack[Rule]) -> bool: ...
+    def follows(self, **rule: Unpack[Rule]) -> bool: ...
+    def get_match(self, meta_var: str) -> Optional[SgNode]: ...
+    def get_multiple_matches(self, meta_var: str) -> List[SgNode]: ...
+    def get_transformed(self, meta_var: str) -> Optional[str]: ...
+    def __getitem__(self, meta_var: str) -> SgNode: ...
+
+    # Search
+    @overload
+    def find(self, config: Config) -> Optional[SgNode]: ...
+    @overload
+    def find(self, **kwargs: Unpack[Rule]) -> Optional[SgNode]: ...
+    @overload
+    def find_all(self, config: Config) -> List[SgNode]: ...
+    @overload
+    def find_all(self, **kwargs: Unpack[Rule]) -> List[SgNode]: ...
+
+    # Tree Traversal
+    def get_root(self) -> SgRoot: ...
+    def field(self, name: str) -> Optional[SgNode]: ...
+    def field_children(self, name: str) -> List[SgNode]: ...
+    def parent(self) -> Optional[SgNode]: ...
+    def child(self, nth: int) -> Optional[SgNode]: ...
+    def children(self) -> List[SgNode]: ...
+    def ancestors(self) -> List[SgNode]: ...
+    def next(self) -> Optional[SgNode]: ...
+    def next_all(self) -> List[SgNode]: ...
+    def prev(self) -> Optional[SgNode]: ...
+    def prev_all(self) -> List[SgNode]: ...
+
+    # Edit
+    def replace(self, new_text: str) -> Edit: ...
+    def commit_edits(self, edits: List[Edit]) -> str: ...
+
+def register_dynamic_language(langs: Dict[str, CustomLang]): ...

ast_grep_py-0.39.7.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: ast-grep-py
+Version: 0.39.7
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development
+Classifier: Topic :: Text Processing
+Requires-Dist: pytest>=7 ; extra == 'test'
+Provides-Extra: test
+Summary: Structural Search and Rewrite code at large scale using precise AST pattern.
+Keywords: ast,pattern,codemod,structural search,rewrite
+Author-email: Herrington Darkholme <2883231+HerringtonDarkholme@users.noreply.github.com>
+Maintainer-email: Herrington Darkholme <2883231+HerringtonDarkholme@users.noreply.github.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/ast-grep/ast-grep
+Project-URL: Documentation, https://ast-grep.github.io/
+Project-URL: Changelog, https://github.com/ast-grep/ast-grep/blob/main/CHANGELOG.md
+
+# ast-grep python binding
+
+[![PyPI](https://img.shields.io/pypi/v/ast-grep-py.svg?logo=PyPI)](https://pypi.org/project/ast-grep-py/)
+[![Website](https://img.shields.io/badge/ast--grep-Ast--Grep_Website-red?logoColor=red)](https://ast-grep.github.io/)
+
+<p align=center>
+  <img src="https://ast-grep.github.io/logo.svg" alt="ast-grep"/>
+</p>
+
+## ast-grep
+
+`ast-grep` is a tool for code structural search, lint, and rewriting. 
+
+This crate intends to build a native python binding of ast-grep and provide a python API for programmatic usage.
+
+## Installation
+
+```bash
+pip install ast-grep-py
+```
+
+## Usage
+
+You can take our tests as examples. For example, [test_simple.py](./tests/test_simple.py) shows how to use ast-grep to search for a pattern in a file.
+
+Please see the [API usage guide](https://ast-grep.github.io/guide/api-usage.html) and [API reference](https://ast-grep.github.io/reference/api.html) for more details.
+
+Other resources include [ast-grep's official site](https://ast-grep.github.io/) and [repository](https://github.com/ast-grep/ast-grep).
+
+## Development
+
+### Setup virtualenv
+
+```shell
+python -m venv venv
+```
+
+### Activate venv
+
+```shell
+source venv/bin/activate
+```
+
+### Install `maturin`
+
+```shell
+pip install maturin[patchelf]
+```
+
+### MacOS: Install `patchelf` and `maturin`
+
+```shell
+brew install patchelf
+pip install maturin
+```
+
+### Build bindings
+
+```shell
+maturin develop
+```
+
+### Run tests
+
+```shell
+pytest
+```
+
+All tests files are under [tests](./tests) directory.
+
+## License
+
+This project is licensed under the MIT license.
+

ast_grep_py-0.39.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+ast_grep_py-0.39.7.dist-info/METADATA,sha256=KH5c9wwF_kNFqfvilHtTw015G6csPSZ69twO77NpMs4,2748
+ast_grep_py-0.39.7.dist-info/WHEEL,sha256=gpfQ5JUQ90YG2XAp7g18WTpt5WvK-s1KNrfnZL-c6XQ,106
+ast_grep_py/__init__.py,sha256=3X6B430_LMQp8gaddVN77rNfnBdGPvswWC49Zh-gw9w,2036
+ast_grep_py/ast_grep_py.cpython-314-darwin.so,sha256=svhX3O0vp4akCTwOiaMb-1e11pqeczNvo9XkamvldPw,40589008
+ast_grep_py/ast_grep_py.pyi,sha256=esTZ37k9WxdLM7tszJMYI8fAFkycWKzbeHJh7gguIuY,2270
+ast_grep_py/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ast_grep_py-0.39.7.dist-info/RECORD,,

ast_grep_py-0.39.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.6)
+Root-Is-Purelib: false
+Tag: cp314-cp314-macosx_10_12_x86_64